Skip to content

CreateContactChannelRequest

Source code in docs_src/capo_ssm_contacts/types/create_contact_channel_request.py
class CreateContactChannelRequest(TypedDict, closed=True):
    contact_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.</p>"""
    name: "capo_ssm_contacts.types.channel_name.ChannelName"
    """<p>The name of the contact channel.</p>"""
    type: "capo_ssm_contacts.types.channel_type.ChannelType"
    """<p>Incident Manager supports three types of contact channels:</p> <ul> <li> <p> <code>SMS</code> </p> </li> <li> <p> <code>VOICE</code> </p> </li> <li> <p> <code>EMAIL</code> </p> </li> </ul>"""
    delivery_address: (
        "capo_ssm_contacts.types.contact_channel_address.ContactChannelAddress"
    )
    """<p>The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:</p> <ul> <li> <p>SMS - '+' followed by the country code and phone number</p> </li> <li> <p>VOICE - '+' followed by the country code and phone number</p> </li> <li> <p>EMAIL - any standard email format</p> </li> </ul>"""
    defer_activation: NotRequired[
        "capo_ssm_contacts.types.defer_activation.DeferActivation"
    ]
    """<p>If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.</p>"""
    idempotency_token: NotRequired[
        "capo_ssm_contacts.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A token ensuring that the operation is called only once with the specified details.</p>"""

contact_id instance-attribute

contact_id: SsmContactsArn

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

defer_activation instance-attribute

defer_activation: NotRequired[DeferActivation]

If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

delivery_address instance-attribute

delivery_address: ContactChannelAddress

The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

  • SMS - '+' followed by the country code and phone number

  • VOICE - '+' followed by the country code and phone number

  • EMAIL - any standard email format

idempotency_token instance-attribute

idempotency_token: NotRequired[IdempotencyToken]

A token ensuring that the operation is called only once with the specified details.

name instance-attribute

The name of the contact channel.

type instance-attribute

Incident Manager supports three types of contact channels:

  • SMS

  • VOICE

  • EMAIL