Skip to content

CreateNotifyConfigurationResult

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/create_notify_configuration_result.py
class CreateNotifyConfigurationResult(TypedDict, closed=True):
    notify_configuration_arn: "capo_pinpoint_sms_voice_v2.types.notify_configuration_arn.NotifyConfigurationArn"
    """<p>The Amazon Resource Name (ARN) for the notify configuration.</p>"""
    notify_configuration_id: (
        "capo_pinpoint_sms_voice_v2.types.notify_configuration_id.NotifyConfigurationId"
    )
    """<p>The unique identifier for the notify configuration.</p>"""
    display_name: "capo_pinpoint_sms_voice_v2.types.notify_configuration_display_name.NotifyConfigurationDisplayName"
    """<p>The display name associated 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 associated with the notify configuration.</p>"""
    pool_id: NotRequired["str"]
    """<p>The identifier of the pool associated 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 enabled for the notify configuration. Supported values include <code>SMS</code> and <code>VOICE</code>.</p>"""
    tier: "capo_pinpoint_sms_voice_v2.types.notify_configuration_tier.NotifyConfigurationTier"
    """<p>The tier of the notify configuration.</p>"""
    tier_upgrade_status: (
        "capo_pinpoint_sms_voice_v2.types.tier_upgrade_status.TierUpgradeStatus"
    )
    """<p>The tier upgrade status of the notify configuration.</p>"""
    status: "capo_pinpoint_sms_voice_v2.types.notify_configuration_status.NotifyConfigurationStatus"
    """<p>The current status of the notify configuration.</p>"""
    rejection_reason: NotRequired["str"]
    """<p>The reason the notify configuration was rejected, if applicable.</p>"""
    deletion_protection_enabled: "bool"
    """<p>When set to true deletion protection is enabled. By default this is set to false. </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>"""
    created_timestamp: "datetime.datetime"
    """<p>The time when the notify configuration was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>"""

created_timestamp instance-attribute

created_timestamp: datetime

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

default_template_id instance-attribute

default_template_id: NotRequired[NotifyTemplateId]

The default template identifier associated with the notify configuration.

deletion_protection_enabled instance-attribute

deletion_protection_enabled: bool

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

display_name instance-attribute

The display name associated with the notify configuration.

enabled_channels instance-attribute

enabled_channels: NotifyEnabledChannelsList

An array of channels enabled 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_arn instance-attribute

notify_configuration_arn: NotifyConfigurationArn

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

notify_configuration_id instance-attribute

notify_configuration_id: NotifyConfigurationId

The unique identifier for the notify configuration.

pool_id instance-attribute

pool_id: NotRequired[str]

The identifier of the pool associated with the notify configuration.

rejection_reason instance-attribute

rejection_reason: NotRequired[str]

The reason the notify configuration was rejected, if applicable.

status instance-attribute

The current status of the notify configuration.

tags instance-attribute

tags: NotRequired[TagList]

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

tier instance-attribute

The tier of the notify configuration.

tier_upgrade_status instance-attribute

tier_upgrade_status: TierUpgradeStatus

The tier upgrade status of the notify configuration.

use_case instance-attribute

The use case for the notify configuration.