Skip to content

StartEngagementRequest

Source code in docs_src/capo_ssm_contacts/types/start_engagement_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class StartEngagementRequest(TypedDict, closed=True):
    contact_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn"
    """<p>The Amazon Resource Name (ARN) of the contact being engaged.</p>"""
    sender: "capo_ssm_contacts.types.sender.Sender"
    """<p>The user that started the engagement.</p>"""
    subject: "capo_ssm_contacts.types.subject.Subject"
    """<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>"""
    content: "capo_ssm_contacts.types.content.Content"
    """<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>"""
    public_subject: NotRequired["capo_ssm_contacts.types.public_subject.PublicSubject"]
    """<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>"""
    public_content: NotRequired["capo_ssm_contacts.types.public_content.PublicContent"]
    """<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>"""
    incident_id: NotRequired["capo_ssm_contacts.types.incident_id.IncidentId"]
    """<p>The ARN of the incident that the engagement is part of.</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 being engaged.

content instance-attribute 

content: Content

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

idempotency_token instance-attribute 

idempotency_token: NotRequired[IdempotencyToken]

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

incident_id instance-attribute 

incident_id: NotRequired[IncidentId]

The ARN of the incident that the engagement is part of.

public_content instance-attribute 

public_content: NotRequired[PublicContent]

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

public_subject instance-attribute 

public_subject: NotRequired[PublicSubject]

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

sender instance-attribute 

sender: Sender

The user that started the engagement.

subject instance-attribute 

subject: Subject

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.