PinpointSMSVoiceV2 / Paginator / ListNotifyCountries

ListNotifyCountries

class PinpointSMSVoiceV2.Paginator.ListNotifyCountries

paginator = client.get_paginator('list_notify_countries')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Channels=[
        'SMS'|'VOICE'|'MMS'|'RCS',
    ],
    UseCases=[
        'CODE_VERIFICATION',
    ],
    Tier='BASIC'|'ADVANCED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Channels (list) –

  An array of channels to filter the results by.

  • (string) –

• UseCases (list) –

  An array of use cases to filter the results by.

  • (string) –

    The use case for a notify configuration.

    • CODE_VERIFICATION - Code verification use case.

• Tier (string) – The tier to filter the results by.

• 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

{
    'NotifyCountries': [
        {
            'IsoCountryCode': 'string',
            'CountryName': 'string',
            'SupportedChannels': [
                'SMS'|'VOICE'|'MMS'|'RCS',
            ],
            'SupportedUseCases': [
                'CODE_VERIFICATION',
            ],
            'SupportedTiers': [
                'BASIC'|'ADVANCED',
            ],
            'CustomerOwnedIdentityRequired': True|False
        },
    ],

}

Response Structure

• (dict) –

  • NotifyCountries (list) –

    An array of NotifyCountryInformation objects that contain the results.

    • (dict) –

      The information for a country that supports notify messaging.

      • IsoCountryCode (string) –

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

      • CountryName (string) –

        The name of the country.

      • SupportedChannels (list) –

        An array of supported channels for the country. Supported values include SMS and VOICE.

        • (string) –

      • SupportedUseCases (list) –

        An array of supported use cases for the country.

        • (string) –

          The use case for a notify configuration.

          • CODE_VERIFICATION - Code verification use case.

      • SupportedTiers (list) –

        An array of supported tiers for the country.

        • (string) –

          The tier of a notify configuration.

          • BASIC - Basic tier.

          • ADVANCED - Advanced tier.

      • CustomerOwnedIdentityRequired (boolean) –

        Whether a customer-owned identity is required to send notify messages to this country.