Skip to content

CreateContactRequest

Source code in docs_src/capo_ssm_contacts/types/create_contact_request.py
class CreateContactRequest(TypedDict, closed=True):
    alias: "capo_ssm_contacts.types.contact_alias.ContactAlias"
    """<p>The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.</p>"""
    display_name: NotRequired["capo_ssm_contacts.types.contact_name.ContactName"]
    """<p>The full name of the contact or escalation plan.</p>"""
    type: "capo_ssm_contacts.types.contact_type.ContactType"
    """<p>The type of contact to create.</p> <ul> <li> <p> <code>PERSONAL</code>: A single, individual contact.</p> </li> <li> <p> <code>ESCALATION</code>: An escalation plan.</p> </li> <li> <p> <code>ONCALL_SCHEDULE</code>: An on-call schedule.</p> </li> </ul>"""
    plan: "capo_ssm_contacts.types.plan.Plan"
    """<p>A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.</p>"""
    tags: NotRequired["capo_ssm_contacts.types.tags_list.TagsList"]
    """<p>Adds a tag to the target. You can only tag resources created in the first Region of your replication set.</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>"""

alias instance-attribute

alias: ContactAlias

The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

display_name instance-attribute

display_name: NotRequired[ContactName]

The full name of the contact or escalation plan.

idempotency_token instance-attribute

idempotency_token: NotRequired[IdempotencyToken]

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

plan instance-attribute

plan: Plan

A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

tags instance-attribute

tags: NotRequired[TagsList]

Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

type instance-attribute

The type of contact to create.

  • PERSONAL: A single, individual contact.

  • ESCALATION: An escalation plan.

  • ONCALL_SCHEDULE: An on-call schedule.