ListEngagements - AWS Systems Manager Incident Manager

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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: