Skip to content

SenderIdInformation

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/sender_id_information.py
class SenderIdInformation(TypedDict, closed=True):
    sender_id_arn: "str"
    """<p>The Amazon Resource Name (ARN) associated with the SenderId.</p>"""
    sender_id: "capo_pinpoint_sms_voice_v2.types.sender_id.SenderId"
    """<p>The alphanumeric sender ID in a specific country that you'd like to describe.</p>"""
    iso_country_code: "capo_pinpoint_sms_voice_v2.types.iso_country_code.IsoCountryCode"
    """<p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. </p>"""
    message_types: "capo_pinpoint_sms_voice_v2.types.message_type_list.MessageTypeList"
    """<p>The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.</p>"""
    monthly_leasing_price: "str"
    """<p>The monthly leasing price, in US dollars.</p>"""
    deletion_protection_enabled: "bool"
    """<p>By default this is set to false. When set to true the sender ID can't be deleted.</p>"""
    registered: "bool"
    """<p>True if the sender ID is registered.</p>"""
    registration_id: NotRequired["str"]
    """<p>The unique identifier for the registration.</p>"""
    messaging_limits: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.messaging_limits.MessagingLimits"
    ]
    """<p>The messaging limits that apply to the sender ID, including the per-capability send rates.</p>"""
    pricing_tier: NotRequired["str"]
    """<p>The pricing model.</p>"""

deletion_protection_enabled instance-attribute

deletion_protection_enabled: bool

By default this is set to false. When set to true the sender ID can't be deleted.

iso_country_code instance-attribute

iso_country_code: IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

message_types instance-attribute

message_types: MessageTypeList

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

messaging_limits instance-attribute

messaging_limits: NotRequired[MessagingLimits]

The messaging limits that apply to the sender ID, including the per-capability send rates.

monthly_leasing_price instance-attribute

monthly_leasing_price: str

The monthly leasing price, in US dollars.

pricing_tier instance-attribute

pricing_tier: NotRequired[str]

The pricing model.

registered instance-attribute

registered: bool

True if the sender ID is registered.

registration_id instance-attribute

registration_id: NotRequired[str]

The unique identifier for the registration.

sender_id instance-attribute

sender_id: SenderId

The alphanumeric sender ID in a specific country that you'd like to describe.

sender_id_arn instance-attribute

sender_id_arn: str

The Amazon Resource Name (ARN) associated with the SenderId.