ListTimelineEvents - AWS Systems Manager Incident Manager

ListTimelineEvents

Lists timeline events of the specified incident record.

Request Syntax

POST /listTimelineEvents HTTP/1.1 Content-type: application/json { "filters": [ { "condition": { "after": number, "before": number, "equals": { "integerValues": [ number ], "stringValues": [ "string" ] } }, "key": "string" } ], "incidentRecordArn": "string", "maxResults": number, "nextToken": "string", "sortBy": "string", "sortOrder": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:

  • eventTime

  • eventType

Type: Array of Filter objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

incidentRecordArn

The Amazon Resource Name (ARN) of the incident that the event is part of.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$

Required: Yes

maxResults

The maximum number of results per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token to continue to the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

sortBy

Sort by the specified key value pair.

Type: String

Valid Values: EVENT_TIME

Required: No

sortOrder

Sorts the order of timeline events by the value specified in the sortBy field.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "eventSummaries": [ { "eventId": "string", "eventTime": number, "eventType": "string", "eventUpdatedTime": number, "incidentRecordArn": "string" } ], "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.

eventSummaries

Details about each event that occurred during the incident.

Type: Array of EventSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

nextToken

The pagination token to continue to the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

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: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

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: