PinpointSMSVoiceV2 / Client / create_notify_configuration

create_notify_configuration

PinpointSMSVoiceV2.Client.create_notify_configuration(**kwargs)

Creates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display name, use case, enabled channels, and enabled countries.

See also: AWS API Documentation

Request Syntax

response = client.create_notify_configuration(
    DisplayName='string',
    UseCase='CODE_VERIFICATION',
    DefaultTemplateId='string',
    PoolId='string',
    EnabledCountries=[
        'string',
    ],
    EnabledChannels=[
        'SMS'|'VOICE'|'MMS'|'RCS',
    ],
    DeletionProtectionEnabled=True|False,
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • DisplayName (string) –

    [REQUIRED]

    The display name to associate with the notify configuration.

  • UseCase (string) –

    [REQUIRED]

    The use case for the notify configuration.

  • DefaultTemplateId (string) – The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

  • PoolId (string) – The identifier of the pool to associate 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) –

    [REQUIRED]

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

    • (string) –

  • DeletionProtectionEnabled (boolean) – By default this is set to false. When set to true the notify configuration can’t be deleted. You can change this value using the UpdateNotifyConfiguration action.

  • ClientToken (string) –

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, a randomly generated token is used for the request to ensure idempotency.

    This field is autopopulated if not provided.

  • Tags (list) –

    An array of tags (key and value pairs) associated with the notify configuration.

    • (dict) –

      The list of tags to be added to the specified topic.

      • Key (string) – [REQUIRED]

        The key identifier, or name, of the tag.

      • Value (string) – [REQUIRED]

        The string value associated with the key of the tag.

Return type:

dict

Returns:

Response Syntax

{
    '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,
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • 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.

    • Tags (list) –

      An array of tags (key and value pairs) associated with the notify configuration.

      • (dict) –

        The list of tags to be added to the specified topic.

        • Key (string) –

          The key identifier, or name, of the tag.

        • Value (string) –

          The string value associated with the key of the tag.

    • CreatedTimestamp (datetime) –

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

Exceptions