[ aws . ssm-incidents ]

update-timeline-event

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-timeline-event
[--client-token <value>]
[--event-data <value>]
--event-id <value>
[--event-time <value>]
[--event-type <value>]
--incident-record-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

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

--event-data (string)

A short description of the event.

--event-id (string)

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

--event-time (timestamp)

The time that the event occurred.

--event-type (string)

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

--incident-record-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To update a timeline event

The following update-timeline-event example updates the time that the event occurred.

aws ssm-incidents update-timeline-event \
    --event-id 20bcc812-8a94-4cd7-520c-0ff742111424 \
    --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \
    --event-time "2021-05-21T18:10:57+00:00"

This command produces no output.

For more information, see Incident details in the Incident Manager User Guide.

Output

None