ListEngagements
Lists all engagements that have happened in an incident.
Request Syntax
{
"IncidentId": "string",
"MaxResults": number,
"NextToken": "string",
"TimeRangeValue": {
"EndTime": number,
"StartTime": number
}
}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.
- IncidentId
-
The Amazon Resource Name (ARN) of the incident you're listing engagements for.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^[\\a-zA-Z0-9_@#%*+=:?.\/!\s-]*$Required: No
- MaxResults
-
The maximum number of engagements per page of results.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1024.
Required: No
- NextToken
-
The pagination token to continue to the next page of results.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[\\\/a-zA-Z0-9_+=\-]*$Required: No
- TimeRangeValue
-
The time range to lists engagements for an incident.
Type: TimeRange object
Required: No
Response Syntax
{
"Engagements": [
{
"ContactArn": "string",
"EngagementArn": "string",
"IncidentId": "string",
"Sender": "string",
"StartTime": number,
"StopTime": number
}
],
"NextToken": "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.
- Engagements
-
A list of each engagement that occurred during the specified time range of an incident.
Type: Array of Engagement objects
- NextToken
-
The pagination token to continue to the next page of results.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[\\\/a-zA-Z0-9_+=\-]*$
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
- InternalServerException
-
Unexpected error occurred while processing the request.
HTTP Status Code: 500
- 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 ListEngagements.
Sample Request
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.ListEngagements
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.list-engagements
X-Amz-Date: 20220816T191844Z
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: 2
{}Sample Response
{
"Engagements": [
{
"EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/test_escalation_plan/27bd86cf-6d50-49d2-a9ab-da39bEXAMPLE",
"ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/test_escalation_plan",
"Sender": "cli",
"StartTime": "2022-08-16T18:48:50.153000+00:00"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
