SNS / Paginator / ListPhoneNumbersOptedOut


class SNS.Paginator.ListPhoneNumbersOptedOut#
paginator = client.get_paginator('list_phone_numbers_opted_out')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'StartingToken': 'string'

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:



Response Syntax

    'phoneNumbers': [
    'NextToken': 'string'

Response Structure

  • (dict) –

    The response from the ListPhoneNumbersOptedOut action.

    • phoneNumbers (list) –

      A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

      • (string) –

    • NextToken (string) –

      A token to resume pagination.