SNS / Paginator / ListSMSSandboxPhoneNumbers

ListSMSSandboxPhoneNumbers

class SNS.Paginator.ListSMSSandboxPhoneNumbers

paginator = client.get_paginator('list_sms_sandbox_phone_numbers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SNS.Client.list_sms_sandbox_phone_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': [
        {
            'PhoneNumber': 'string',
            'Status': 'Pending'|'Verified'
        },
    ],

}

Response Structure

• (dict) –

  • PhoneNumbers (list) –

    A list of the calling account’s pending and verified phone numbers.

    • (dict) –

      A verified or pending destination phone number in the SMS sandbox.

      When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

      • PhoneNumber (string) –

        The destination phone number.

      • Status (string) –

        The destination phone number’s verification status.