PinpointSMSVoiceV2 / Paginator / DescribeNotifyTemplates

DescribeNotifyTemplates

class PinpointSMSVoiceV2.Paginator.DescribeNotifyTemplates

paginator = client.get_paginator('describe_notify_templates')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TemplateIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'template-type'|'channels'|'tier-access'|'supported-countries'|'language-code'|'supported-voice-ids',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• TemplateIds (list) –

  An array of template IDs to describe.

  • (string) –

    Template identifier for notify templates. In UpdateNotifyConfiguration, pass UNSET_DEFAULT_TEMPLATE to clear the default template. The UNSET_DEFAULT_TEMPLATE value is only accepted by UpdateNotifyConfiguration.

• Filters (list) –

  An array of NotifyTemplateFilter objects to filter the results on.

  • (dict) –

    The information for notify templates that meet a specified criteria.

    • Name (string) – [REQUIRED]

      The name of the attribute to filter on.

    • Values (list) – [REQUIRED]

      An array 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

{
    'NotifyTemplates': [
        {
            'TemplateId': 'string',
            'Version': 123,
            'TemplateType': 'OTP_VERIFICATION',
            'Channels': [
                'SMS'|'VOICE'|'MMS'|'RCS',
            ],
            'TierAccess': [
                'BASIC'|'ADVANCED',
            ],
            'Status': 'ACTIVE'|'INACTIVE',
            'SupportedCountries': [
                'string',
            ],
            'LanguageCode': 'string',
            'Content': 'string',
            'Variables': {
                'string': {
                    'Type': 'STRING'|'INTEGER'|'BOOLEAN',
                    'Required': True|False,
                    'Description': 'string',
                    'MaxLength': 123,
                    'MinValue': 123,
                    'MaxValue': 123,
                    'DefaultValue': 'string',
                    'Pattern': 'string',
                    'Sample': 'string',
                    'Source': 'CUSTOMER'|'SYSTEM'
                }
            },
            'SupportedVoiceIds': [
                'AMY'|'ASTRID'|'BIANCA'|'BRIAN'|'CAMILA'|'CARLA'|'CARMEN'|'CELINE'|'CHANTAL'|'CONCHITA'|'CRISTIANO'|'DORA'|'EMMA'|'ENRIQUE'|'EWA'|'FILIZ'|'GERAINT'|'GIORGIO'|'GWYNETH'|'HANS'|'INES'|'IVY'|'JACEK'|'JAN'|'JOANNA'|'JOEY'|'JUSTIN'|'KARL'|'KENDRA'|'KIMBERLY'|'LEA'|'LIV'|'LOTTE'|'LUCIA'|'LUPE'|'MADS'|'MAJA'|'MARLENE'|'MATHIEU'|'MATTHEW'|'MAXIM'|'MIA'|'MIGUEL'|'MIZUKI'|'NAJA'|'NICOLE'|'PENELOPE'|'RAVEENA'|'RICARDO'|'RUBEN'|'RUSSELL'|'SALLI'|'SEOYEON'|'TAKUMI'|'TATYANA'|'VICKI'|'VITORIA'|'ZEINA'|'ZHIYU',
            ],
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • NotifyTemplates (list) –

    An array of NotifyTemplateInformation objects that contain the results.

    • (dict) –

      The information for a system-managed notify template in an Amazon Web Services account.

      • TemplateId (string) –

        The unique identifier for the template.

      • Version (integer) –

        The version of the template.

      • TemplateType (string) –

        The type of the template.

      • Channels (list) –

        The channels for the template. Supported values are SMS and VOICE.

        • (string) –

      • TierAccess (list) –

        The tier access level for the template.

        • (string) –

          The tier of a notify configuration.

          • BASIC - Basic tier.

          • ADVANCED - Advanced tier.

      • Status (string) –

        The current status of the template.

      • SupportedCountries (list) –

        An array of supported country codes for the template.

        • (string) –

      • LanguageCode (string) –

        The language code for the template.

      • Content (string) –

        The content of the template.

      • Variables (dict) –

        An array of template variable metadata for the template.

        • (string) –

          • (dict) –

            Contains metadata about a template variable.

            • Type (string) –

              The type of the variable.

            • Required (boolean) –

              Whether the variable is required.

            • Description (string) –

              A description of the variable.

            • MaxLength (integer) –

              The maximum length for string variables.

            • MinValue (integer) –

              The minimum value for numeric variables.

            • MaxValue (integer) –

              The maximum value for numeric variables.

            • DefaultValue (string) –

              The default value for the variable.

            • Pattern (string) –

              The regex pattern the variable value must match.

            • Sample (string) –

              A sample value for the variable.

            • Source (string) –

              The source of the variable, either CUSTOMER or SYSTEM.

      • SupportedVoiceIds (list) –

        An array of supported voice IDs for voice templates.

        • (string) –

      • CreatedTimestamp (datetime) –

        The time when the notify template was created, in UNIX epoch time format.