Skip to content

ContactChannel

Source code in docs_src/capo_ssm_contacts/types/contact_channel.py
class ContactChannel(TypedDict, closed=True):
    contact_channel_arn: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The Amazon Resource Name (ARN) of the contact channel.</p>"""
    contact_arn: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The ARN of the contact that contains the contact channel.</p>"""
    name: "capo_ssm_contacts.types.channel_name.ChannelName"
    """<p>The name of the contact channel.</p>"""
    type: NotRequired["capo_ssm_contacts.types.channel_type.ChannelType"]
    """<p>The type of the contact channel. Incident Manager supports three contact methods:</p> <ul> <li> <p>SMS</p> </li> <li> <p>VOICE</p> </li> <li> <p>EMAIL</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.</p>"""
    activation_status: "capo_ssm_contacts.types.activation_status.ActivationStatus"
    """<p>A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.</p>"""

activation_status instance-attribute

activation_status: ActivationStatus

A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

contact_arn instance-attribute

contact_arn: SsmContactsArn

The ARN of the contact that contains the contact channel.

contact_channel_arn instance-attribute

contact_channel_arn: SsmContactsArn

The Amazon Resource Name (ARN) of the contact channel.

delivery_address instance-attribute

delivery_address: ContactChannelAddress

The details that Incident Manager uses when trying to engage the contact channel.

name instance-attribute

The name of the contact channel.

type instance-attribute

type: NotRequired[ChannelType]

The type of the contact channel. Incident Manager supports three contact methods:

  • SMS

  • VOICE

  • EMAIL