SNS / Paginator / ListTopics

ListTopics

class SNS.Paginator.ListTopics

paginator = client.get_paginator('list_topics')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SNS.Client.list_topics().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 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.

• StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Topics': [
        {
            'TopicArn': 'string'
        },
    ],

}

Response Structure

• (dict) –

  Response for ListTopics action.

  • Topics (list) –

    A list of topic ARNs.

    • (dict) –

      A wrapper type for the topic’s Amazon Resource Name (ARN). To retrieve a topic’s attributes, use GetTopicAttributes .

      • TopicArn (string) –

        The topic’s ARN.