UserNotifications / Paginator / ListChannels

ListChannels

class UserNotifications.Paginator.ListChannels

paginator = client.get_paginator('list_channels')

paginate(**kwargs)

Creates an iterator that will paginate through responses from UserNotifications.Client.list_channels().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• notificationConfigurationArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the NotificationConfiguration.

• 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

{
    'channels': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • channels (list) –

    A list of Channels.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.