CreateTimelineEvent - AWS Systems Manager Incident Manager

CreateTimelineEvent

Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.

Request Syntax

POST /createTimelineEvent HTTP/1.1 Content-type: application/json { "clientToken": "string", "eventData": "string", "eventTime": number, "eventType": "string", "incidentRecordArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A token ensuring that the action is called only once with the specified details.

Type: String

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

Required: No

eventData

A valid JSON string. There is no other schema imposed. A short description of the event.

Type: String

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

Required: Yes

eventTime

The time that the event occurred.

Type: Timestamp

Required: Yes

eventType

The type of the event. You can create timeline events of type Custom Event.

Type: String

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

Required: Yes

incidentRecordArn

The Amazon Resource Name (ARN) of the incident record you are adding the event to.

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

Response Syntax

HTTP/1.1 201 Content-type: application/json { "eventId": "string", "incidentRecordArn": "string" }

Response Elements

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

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

eventId

The ID of the event for easy reference later.

Type: String

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

incidentRecordArn

The ARN of the incident record that you added the event to.

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})?:.+$

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

ConflictException

Updating or deleting a resource causes an inconsistent state.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

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: