PinpointSMSVoiceV2 / Paginator / DescribeVerifiedDestinationNumbers

DescribeVerifiedDestinationNumbers

class PinpointSMSVoiceV2.Paginator.DescribeVerifiedDestinationNumbers

paginator = client.get_paginator('describe_verified_destination_numbers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_verified_destination_numbers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    VerifiedDestinationNumberIds=[
        'string',
    ],
    DestinationPhoneNumbers=[
        'string',
    ],
    Filters=[
        {
            'Name': 'status',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• VerifiedDestinationNumberIds (list) –

  An array of VerifiedDestinationNumberid to retreive.

  • (string) –

• DestinationPhoneNumbers (list) –

  An array of verified destination phone number, in E.164 format.

  • (string) –

• Filters (list) –

  An array of VerifiedDestinationNumberFilter objects to filter the results.

  • (dict) –

    The filter definition for filtering verified destination phone numbers that meets a specified criteria.

    • Name (string) – [REQUIRED]

      The name of the attribute to filter on.

    • Values (list) – [REQUIRED]

      An array of values to filter on.

      • (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.

  • 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

{
    'VerifiedDestinationNumbers': [
        {
            'VerifiedDestinationNumberArn': 'string',
            'VerifiedDestinationNumberId': 'string',
            'DestinationPhoneNumber': 'string',
            'Status': 'PENDING'|'VERIFIED',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • VerifiedDestinationNumbers (list) –

    An array of VerifiedDestinationNumberInformation objects

    • (dict) –

      Provides information about the requested verified destintion phone number.

      • VerifiedDestinationNumberArn (string) –

        The Amazon Resource Name (ARN) for the verified destination phone number.

      • VerifiedDestinationNumberId (string) –

        The unique identifier for the verified destination phone number.

      • DestinationPhoneNumber (string) –

        The verified destination phone number, in E.164 format.

      • Status (string) –

        The status of the verified destination phone number.

        • PENDING: The phone number hasn’t been verified yet.

        • VERIFIED: The phone number is verified and can receive messages.

      • CreatedTimestamp (datetime) –

        The time when the destination phone number was created, in UNIX epoch time format.