list_sinks

list_sinks(**kwargs)

Use this operation in a monitoring account to return the list of sinks created in that account.

See also: AWS API Documentation

Request Syntax

response = client.list_sinks(
    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',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Items (list) --

    An array of structures that contain the information about the returned sinks.

    • (dict) --

      A structure that contains information about one of this monitoring account's sinks.

      • Arn (string) --

        The ARN of the sink.

      • Id (string) --

        The random ID string that Amazon Web Services generated as part of the sink ARN.

      • Name (string) --

        The name of the sink.

  • NextToken (string) --

    The token to use when requesting the next set of sinks.

Exceptions

• CloudWatchObservabilityAccessManager.Client.exceptions.InternalServiceFault
• CloudWatchObservabilityAccessManager.Client.exceptions.InvalidParameterException
• CloudWatchObservabilityAccessManager.Client.exceptions.ResourceNotFoundException