PinpointSMSVoiceV2 / Paginator / DescribeNotifyConfigurations

DescribeNotifyConfigurations

class PinpointSMSVoiceV2.Paginator.DescribeNotifyConfigurations

paginator = client.get_paginator('describe_notify_configurations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    NotifyConfigurationIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'display-name'|'enabled-countries'|'enabled-channels'|'default-template'|'default-pool'|'use-case'|'status'|'deletion-protection-enabled'|'tier-upgrade-status',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• NotifyConfigurationIds (list) –

  An array of notify configuration IDs to describe.

  • (string) –

• Filters (list) –

  An array of NotifyConfigurationFilter objects to filter the results on.

  • (dict) –

    The information for notify configurations 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

{
    'NotifyConfigurations': [
        {
            'NotifyConfigurationArn': 'string',
            'NotifyConfigurationId': 'string',
            'DisplayName': 'string',
            'UseCase': 'CODE_VERIFICATION',
            'DefaultTemplateId': 'string',
            'PoolId': 'string',
            'EnabledCountries': [
                'string',
            ],
            'EnabledChannels': [
                'SMS'|'VOICE'|'MMS'|'RCS',
            ],
            'Tier': 'BASIC'|'ADVANCED',
            'TierUpgradeStatus': 'BASIC'|'PENDING_UPGRADE'|'ADVANCED'|'REJECTED',
            'Status': 'PENDING'|'ACTIVE'|'REJECTED'|'REQUIRES_VERIFICATION',
            'RejectionReason': 'string',
            'DeletionProtectionEnabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • NotifyConfigurations (list) –

    An array of NotifyConfigurationInformation objects that contain the results.

    • (dict) –

      The information for a notify configuration in an Amazon Web Services account.

      • NotifyConfigurationArn (string) –

        The Amazon Resource Name (ARN) for the notify configuration.

      • NotifyConfigurationId (string) –

        The unique identifier for the notify configuration.

      • DisplayName (string) –

        The display name associated with the notify configuration.

      • UseCase (string) –

        The use case for the notify configuration.

      • DefaultTemplateId (string) –

        The default template identifier associated with the notify configuration.

      • PoolId (string) –

        The identifier of the pool associated with the notify configuration.

      • EnabledCountries (list) –

        An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

        • (string) –

      • EnabledChannels (list) –

        An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.

        • (string) –

      • Tier (string) –

        The tier of the notify configuration.

      • TierUpgradeStatus (string) –

        The tier upgrade status of the notify configuration.

      • Status (string) –

        The current status of the notify configuration.

      • RejectionReason (string) –

        The reason the notify configuration was rejected, if applicable.

      • DeletionProtectionEnabled (boolean) –

        When set to true deletion protection is enabled. By default this is set to false.

      • CreatedTimestamp (datetime) –

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