list-timeline-events¶

Description¶

Lists timeline events for the specified incident record.

Synopsis¶

  list-timeline-events
[--filters <value>]
--incident-record-arn <value>
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--filters (list)

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

eventTime

eventType

Note the following when deciding how to use Filters:

If you don’t specify a Filter, the response includes all timeline events.

If you specify more than one filter in a single request, the response returns timeline events that match all filters.

If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

(structure)

Filter the selection by using a condition.

condition -> (structure)

The condition accepts before or after a specified time, equal to a string, or equal to an integer.

after -> (timestamp)

After the specified timestamp.

before -> (timestamp)

Before the specified timestamp

equals -> (structure)

The value is equal to the provided string or integer.

integerValues -> (list)

The list of integer values that the filter matches.

(integer)

stringValues -> (list)

The list of string values that the filter matches.

(string)

key -> (string)

The key that you’re filtering on.

JSON Syntax:

[
  {
    "condition": {
      "after": timestamp,
      "before": timestamp,
      "equals": {
        "integerValues": [integer, ...],
        "stringValues": ["string", ...]
      }
    },
    "key": "string"
  }
  ...
]

--incident-record-arn (string)

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

--sort-by (string)

Sort by the specified key value pair.

Possible values:

EVENT_TIME

--sort-order (string)

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

Possible values:

ASCENDING

DESCENDING

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 list timeline events of an incident

The following command-name example lists the timeline events of the specified incident.

aws ssm-incidents list-timeline-events \
    --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"

Output:

{
    "eventSummaries": [
        {
            "eventId": "8cbcc889-35e1-a42d-2429-d6f100799915",
            "eventTime": "2021-05-21T22:36:13.766000+00:00",
            "eventType": "SSM Incident Record Update",
            "eventUpdatedTime": "2021-05-21T22:36:13.766000+00:00",
            "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"
        },
        {
            "eventId": "a2bcc825-aab5-1787-c605-f9bb2640d85b",
            "eventTime": "2021-05-21T18:58:46.443000+00:00",
            "eventType": "SSM Incident Record Update",
            "eventUpdatedTime": "2021-05-21T18:58:46.443000+00:00",
            "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"
        },
        {
            "eventId": "5abcc812-89c0-b0a8-9437-1c74223d4685",
            "eventTime": "2021-05-21T18:16:59.149000+00:00",
            "eventType": "SSM Incident Record Update",
            "eventUpdatedTime": "2021-05-21T18:16:59.149000+00:00",
            "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"
        },
        {
            "eventId": "06bcc812-8820-405e-4065-8d2b14d29b92",
            "eventTime": "2021-05-21T18:16:58+00:00",
            "eventType": "SSM Automation Execution Start Failure for Incident",
            "eventUpdatedTime": "2021-05-21T18:16:58.689000+00:00",
            "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"
        },
        {
            "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"
        },
        {
            "eventId": "c0bcc885-a41d-eb01-b4ab-9d2de193643c",
            "eventTime": "2020-10-01T20:30:00+00:00",
            "eventType": "Custom Event",
            "eventUpdatedTime": "2021-05-21T22:28:26.299000+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¶

eventSummaries -> (list)

Details about each event that occurred during the incident.

(structure)

Details about a timeline event during an incident.

eventId -> (string)

The timeline event ID.

eventTime -> (timestamp)

The time that the event occurred.

eventType -> (string)

The type of event. The timeline event must be Custom Event .

eventUpdatedTime -> (timestamp)

The time that the timeline event was last updated.

incidentRecordArn -> (string)

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

nextToken -> (string)

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

Table of Contents

Feedback

User Guide