v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439179139.2 KB

Lists details of the engagement to a contact channel.

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

Headers

X-Amz-Target'SSMContacts.DescribePage' required

Request body

PageIdstring required

The ID of the engagement to a contact channel.

Response

Success

PageArnstring required

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

EngagementArnstring required

The ARN of the engagement that engaged the contact channel.

ContactArnstring required

The ARN of the contact that was 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> and <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> and <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 engaged the contact channel.

SentTimestring date-time

The time the engagement was sent to the contact channel.

ReadTimestring date-time

The time that the contact channel acknowledged the engagement.

DeliveryTimestring date-time

The time that the contact channel received the engagement.