CloudWatchObservabilityAccessManager / Paginator / ListSinks

ListSinks

class CloudWatchObservabilityAccessManager.Paginator.ListSinks

paginator = client.get_paginator('list_sinks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchObservabilityAccessManager.Client.list_sinks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': '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.