Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

ListSubscriptions

class SNS.Paginator.ListSubscriptions
paginator = client.get_paginator('list_subscriptions')
paginate(**kwargs)

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

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
{
    'Subscriptions': [
        {
            'SubscriptionArn': 'string',
            'Owner': 'string',
            'Protocol': 'string',
            'Endpoint': 'string',
            'TopicArn': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    Response for ListSubscriptions action

    • Subscriptions (list) --

      A list of subscriptions.

      • (dict) --

        A wrapper type for the attributes of an Amazon SNS subscription.

        • SubscriptionArn (string) --

          The subscription's ARN.

        • Owner (string) --

          The subscription's owner.

        • Protocol (string) --

          The subscription's protocol.

        • Endpoint (string) --

          The subscription's endpoint (format depends on the protocol).

        • TopicArn (string) --

          The ARN of the subscription's topic.