PinpointSMSVoiceV2 / Paginator / DescribeSenderIds

DescribeSenderIds#

class PinpointSMSVoiceV2.Paginator.DescribeSenderIds#
paginator = client.get_paginator('describe_sender_ids')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SenderIds=[
        {
            'SenderId': 'string',
            'IsoCountryCode': 'string'
        },
    ],
    Filters=[
        {
            'Name': 'sender-id'|'iso-country-code'|'message-type'|'deletion-protection-enabled'|'registered',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • SenderIds (list) –

    An array of SenderIdAndCountry objects to search for.

    • (dict) –

      The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs for SMS messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.

      • SenderId (string) – [REQUIRED]

        The unique identifier of the sender.

      • IsoCountryCode (string) – [REQUIRED]

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

  • Filters (list) –

    An array of SenderIdFilter objects to filter the results.

    • (dict) –

      The information for a sender ID 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 for.

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

{
    'SenderIds': [
        {
            'SenderIdArn': 'string',
            'SenderId': 'string',
            'IsoCountryCode': 'string',
            'MessageTypes': [
                'TRANSACTIONAL'|'PROMOTIONAL',
            ],
            'MonthlyLeasingPrice': 'string',
            'DeletionProtectionEnabled': True|False,
            'Registered': True|False,
            'RegistrationId': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • SenderIds (list) –

      An array of SernderIdInformation objects that contain the details for the requested SenderIds.

      • (dict) –

        The information for all SenderIds in an Amazon Web Services account.

        • SenderIdArn (string) –

          The Amazon Resource Name (ARN) associated with the SenderId.

        • SenderId (string) –

          The alphanumeric sender ID in a specific country that you’d like to describe.

        • IsoCountryCode (string) –

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

        • MessageTypes (list) –

          The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren’t critical or time-sensitive.

          • (string) –

        • MonthlyLeasingPrice (string) –

          The monthly leasing price, in US dollars.

        • DeletionProtectionEnabled (boolean) –

          By default this is set to false. When set to true the sender ID can’t be deleted.

        • Registered (boolean) –

          True if the sender ID is registered.

        • RegistrationId (string) –

          The unique identifier for the registration.