CloudWatchObservabilityAccessManager / Client / list_links

list_links#

CloudWatchObservabilityAccessManager.Client.list_links(**kwargs)#

Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.

Request Syntax

response = client.list_links(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – Limits the number of returned links to the specified number.
NextToken (string) – The token for the next set of items to return. You received this token from a previous call.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Label': 'string',
            'ResourceTypes': [
                'string',
            ],
            'SinkArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Items (list) –
  
  An array of structures that contain the information about the returned links.
  - (dict) –
    
    A structure that contains information about one of this source account’s links to a monitoring account.
    - Arn (string) –
      
      The ARN of the link.
    - Id (string) –
      
      The random ID string that Amazon Web Services generated as part of the link ARN.
    - Label (string) –
      
      The label that was assigned to this link at creation, with the variables resolved to their actual values.
    - ResourceTypes (list) –
      
      The resource types supported by this link.
      - (string) –
    - SinkArn (string) –
      
      The ARN of the sink that this link is attached to.
- NextToken (string) –
  
  The token to use when requesting the next set of links.

list_links#

Request Syntax

Response Syntax

Response Structure

Exceptions