UpdateTimelineEvent - AWS Systems Manager Incident Manager

UpdateTimelineEvent

Updates a timeline event. You can update events of type Custom Event.

Request Syntax

POST /updateTimelineEvent HTTP/1.1 Content-type: application/json { "clientToken": "string", "eventData": "string", "eventId": "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 operation is called only once with the specified details.

Type: String

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

Required: No

eventData

A short description of the event.

Type: String

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

Required: No

eventId

The ID of the event you are updating. You can find this by using ListTimelineEvents.

Type: String

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

Required: Yes

eventTime

The time that the event occurred.

Type: Timestamp

Required: No

eventType

The type of the event. You can update events of type Custom Event.

Type: String

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

Required: No

incidentRecordArn

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

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 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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: 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 doesn't 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

Examples

Example

This example illustrates one usage of UpdateTimelineEvent.

Sample Request

POST /updateTimelineEvent HTTP/1.1 Host: ssm-incidents.us-east-1.amazonaws.com Accept-Encoding: identity 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-incidents.update-timeline-event X-Amz-Date: 20210811T203312Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210811/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 261 { "eventId": "a4bd9b45-1fcf-64c3-9d53-121d0f53a7ec", "eventTime": 1621620657, "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/example-response/64bd9b45-1d0e-2622-840d-03a87a1451fa", "clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE" }

Sample Response

{}

See Also

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