ListOriginationNumbers

class SNS.Paginator.ListOriginationNumbers

paginator = client.get_paginator('list_origination_numbers')

paginate(**kwargs)

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

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

{
    'PhoneNumbers': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'PhoneNumber': 'string',
            'Status': 'string',
            'Iso2CountryCode': 'string',
            'RouteType': 'Transactional'|'Promotional'|'Premium',
            'NumberCapabilities': [
                'SMS'|'MMS'|'VOICE',
            ]
        },
    ]
}

Response Structure

• (dict) --
  • PhoneNumbers (list) --

    A list of the calling account's verified and pending origination numbers.

    • (dict) --

      A list of phone numbers and their metadata.

      • CreatedAt (datetime) --

        The date and time when the phone number was created.

      • PhoneNumber (string) --

        The phone number.

      • Status (string) --

        The status of the phone number.

      • Iso2CountryCode (string) --

        The two-character code for the country or region, in ISO 3166-1 alpha-2 format.

      • RouteType (string) --

        The list of supported routes.

      • NumberCapabilities (list) --

        The capabilities of each phone number.

        • (string) -- Enum listing out all supported number capabilities.