Skip to content

CreateNotifyConfigurationRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/create_notify_configuration_request.py
class CreateNotifyConfigurationRequest(TypedDict, closed=True):
    display_name: "capo_pinpoint_sms_voice_v2.types.notify_configuration_display_name.NotifyConfigurationDisplayName"
    """<p>The display name to associate with the notify configuration.</p>"""
    use_case: "capo_pinpoint_sms_voice_v2.types.notify_configuration_use_case.NotifyConfigurationUseCase"
    """<p>The use case for the notify configuration.</p>"""
    default_template_id: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.notify_template_id.NotifyTemplateId"
    ]
    """<p>The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.</p>"""
    pool_id: NotRequired["capo_pinpoint_sms_voice_v2.types.pool_id_or_arn.PoolIdOrArn"]
    """<p>The identifier of the pool to associate with the notify configuration.</p>"""
    enabled_countries: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.iso_country_code_list.IsoCountryCodeList"
    ]
    """<p>An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.</p>"""
    enabled_channels: "capo_pinpoint_sms_voice_v2.types.notify_enabled_channels_list.NotifyEnabledChannelsList"
    """<p>An array of channels to enable for the notify configuration. Supported values include <code>SMS</code> and <code>VOICE</code>.</p>"""
    deletion_protection_enabled: NotRequired["bool"]
    """<p>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 <a>UpdateNotifyConfiguration</a> action.</p>"""
    client_token: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.client_token.ClientToken"
    ]
    """<p>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.</p>"""
    tags: NotRequired["capo_pinpoint_sms_voice_v2.types.tag_list.TagList"]
    """<p>An array of tags (key and value pairs) associated with the notify configuration.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

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.

default_template_id instance-attribute

default_template_id: NotRequired[NotifyTemplateId]

The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

deletion_protection_enabled instance-attribute

deletion_protection_enabled: NotRequired[bool]

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.

display_name instance-attribute

The display name to associate with the notify configuration.

enabled_channels instance-attribute

enabled_channels: NotifyEnabledChannelsList

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

enabled_countries instance-attribute

enabled_countries: NotRequired[IsoCountryCodeList]

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

pool_id instance-attribute

pool_id: NotRequired[PoolIdOrArn]

The identifier of the pool to associate with the notify configuration.

tags instance-attribute

tags: NotRequired[TagList]

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

use_case instance-attribute

The use case for the notify configuration.