Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeEngagement

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Request Syntax


{
   "EngagementId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EngagementId

The Amazon Resource Name (ARN) of the engagement you want the details of.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

Required: Yes

Response Syntax


{
   "ContactArn": "string",
   "Content": "string",
   "EngagementArn": "string",
   "IncidentId": "string",
   "PublicContent": "string",
   "PublicSubject": "string",
   "Sender": "string",
   "StartTime": number,
   "StopTime": number,
   "Subject": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ContactArn

The ARN of the escalation plan or contacts involved in the engagement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

Content

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: ^[.\s\S]*$

EngagementArn

The ARN of the engagement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*

IncidentId

The ARN of the incident in which the engagement occurred.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$

PublicContent

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: ^[.\s\S]*$

PublicSubject

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[.\s\S]*$

Sender

The user that started the engagement.

Type: String

Length Constraints: Maximum length of 255.

Pattern: ^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$

StartTime

The time that the engagement started.

Type: Timestamp

StopTime

The time that the engagement ended.

Type: Timestamp

Subject

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[.\s\S]*$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this operation.

HTTP Status Code: 400

DataEncryptionException

The operation failed to due an encryption key error.

HTTP Status Code: 400

InternalServerException

Unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource that doesn't exist.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeEngagement.

Sample Request


POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.DescribeEngagement
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-contacts.describe-engagement
X-Amz-Date: 20220816T192348Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 132

{
	"EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE"
}

Sample Response


{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test_escalation_plan",
    "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
    "Sender": "cli",
    "Subject": "cli-test",
    "Content": "Testing engagements via CLI",
    "PublicSubject": "cli-test",
    "PublicContent": "Testing engagements via CLI",
    "StartTime": "2022-08-16T18:48:50.153000+00:00"
}