Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439179139.2 KB

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

post/#X-Amz-Target=SSMContacts.StartEngagement

Headers

X-Amz-Target'SSMContacts.StartEngagement' required

Request body

ContactIdstring required

The Amazon Resource Name (ARN) of the contact being engaged.

Senderstring required

The user that started the engagement.

Subjectstring required

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>.

Contentstring required

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>.

PublicSubjectstring

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

PublicContentstring

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

IncidentIdstring

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

IdempotencyTokenstring

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

Response

Success

EngagementArnstring required

The ARN of the engagement.