Skip to content

UpdateNotifyConfigurationRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/update_notify_configuration_request.py
class UpdateNotifyConfigurationRequest(TypedDict, closed=True):
    notify_configuration_id: "capo_pinpoint_sms_voice_v2.types.notify_configuration_id_or_arn.NotifyConfigurationIdOrArn"
    """<p>The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the <a>DescribeNotifyConfigurations</a> operation.</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. Pass the special value <code>UNSET_DEFAULT_TEMPLATE</code> to clear the current default template from the notify configuration.</p>"""
    pool_id: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.notify_pool_id_or_unset.NotifyPoolIdOrUnset"
    ]
    """<p>The pool identifier or Amazon Resource Name (ARN) to associate with the notify configuration. Pass the special value <code>UNSET_DEFAULT_POOL_FOR_NOTIFY</code> to clear the current default pool from 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: NotRequired[
        "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>When set to true the notify configuration can't be deleted.</p>"""

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. Pass the special value UNSET_DEFAULT_TEMPLATE to clear the current default template from the notify configuration.

deletion_protection_enabled instance-attribute

deletion_protection_enabled: NotRequired[bool]

When set to true the notify configuration can't be deleted.

enabled_channels instance-attribute

enabled_channels: NotRequired[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.

notify_configuration_id instance-attribute

notify_configuration_id: NotifyConfigurationIdOrArn

The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation.

pool_id instance-attribute

pool_id: NotRequired[NotifyPoolIdOrUnset]

The pool identifier or Amazon Resource Name (ARN) to associate with the notify configuration. Pass the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool from the notify configuration.