Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm-incidents ]

get-timeline-event

Description

Retrieves a timeline event based on its ID and incident record.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-timeline-event
--event-id <value>
--incident-record-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--event-id (string)

The ID of the event. You can get an event's ID when you create it, or by using ListTimelineEvents .

--incident-record-arn (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 get details of a timeline event

The following get-timeline-event example returns details of the specified timeline event.

aws ssm-incidents get-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"

Output:

{
    "event": {
        "eventData": "\"Incident Started\"",
        "eventId": "20bcc812-8a94-4cd7-520c-0ff742111424",
        "eventTime": "2021-05-21T18:16:57+00:00",
        "eventType": "Custom Event",
        "eventUpdatedTime": "2021-05-21T18:16:59.944000+00:00",
        "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"
    }
}

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

Output

event -> (structure)

Details about the timeline event.

eventData -> (string)

A short description of the event.

eventId -> (string)

The ID of the timeline event.

eventTime -> (timestamp)

The time that the event occurred.

eventType -> (string)

The type of event that occurred. Currently Incident Manager supports only the Custom Event type.

eventUpdatedTime -> (timestamp)

The time that the timeline event was last updated.

incidentRecordArn -> (string)

The Amazon Resource Name (ARN) of the incident that the event occurred during.