PinpointSMSVoiceV2 / Client / describe_notify_configurations

describe_notify_configurations

PinpointSMSVoiceV2.Client.describe_notify_configurations(**kwargs)

Describes the specified notify configurations or all notify configurations in your account.

If you specify notify configuration IDs, the output includes information for only the specified notify configurations. If you specify filters, the output includes information for only those notify configurations that meet the filter criteria. If you don’t specify notify configuration IDs or filters, the output includes information for all notify configurations.

If you specify a notify configuration ID that isn’t valid, an error is returned.

See also: AWS API Documentation

Request Syntax

response = client.describe_notify_configurations(
    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',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
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) –

  • 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

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

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.

    • 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