PinpointSMSVoiceV2 / Client / list_notify_countries

list_notify_countries

PinpointSMSVoiceV2.Client.list_notify_countries(**kwargs)

Lists countries that support notify messaging. You can optionally filter by channel, use case, or tier.

See also: AWS API Documentation

Request Syntax

response = client.list_notify_countries(
    Channels=[
        'SMS'|'VOICE'|'MMS'|'RCS',
    ],
    UseCases=[
        'CODE_VERIFICATION',
    ],
    Tier='BASIC'|'ADVANCED',
    NextToken='string',
    MaxResults=123
)
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.

  • NextToken (string) – The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

  • MaxResults (integer) – The maximum number of results to return per each request.

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
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions