---
title: "POST /listTimelineEvents"
method: POST
path: "/listTimelineEvents"
---

# POST /listTimelineEvents

`POST /listTimelineEvents`

Lists timeline events for the specified incident record.

## Query parameters

- `maxResults` string
- `nextToken` string

## Request body

- object
  - `filters` Filter[] — <p>Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:</p> <ul> <li> <p> <code>eventTime</code> </p> </li> <li> <p> <code>eventType</code> </p> </li> </ul> <p>Note the following when deciding how to use Filters:</p> <ul> <li> <p>If you don't specify a Filter, the response includes all timeline events.</p> </li> <li> <p>If you specify more than one filter in a single request, the response returns timeline events that match all filters.</p> </li> <li> <p>If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.</p> </li> </ul>
    - `condition` object, required — The condition accepts before or after a specified time, equal to a string, or equal to an integer.
      - `after` string, date-time — After the specified timestamp.
      - `before` string, date-time — Before the specified timestamp
      - `equals` object — The value is equal to the provided string or integer.
        - `integerValues` Integer[] — The list of integer values that the filter matches.
        - `stringValues` StringListMemberString[] — The list of string values that the filter matches.
    - `key` string, required — The key that you're filtering on.
  - `incidentRecordArn` string, required — The Amazon Resource Name (ARN) of the incident that includes the timeline event.
  - `maxResults` integer — The maximum number of results per page.
  - `nextToken` string — The pagination token to continue to the next page of results.
  - `sortBy` 'EVENT_TIME' — Sort timeline events by the specified key value pair.
  - `sortOrder` 'ASCENDING' | 'DESCENDING' — Sorts the order of timeline events by the value specified in the <code>sortBy</code> field.

## Response `200`

Success

- ListTimelineEventsOutput
  - `eventSummaries` EventSummary[], required — Details about each event that occurred during the incident.
    - `eventId` string, required — The timeline event ID.
    - `eventReferences` EventReference[] — A list of references in a <code>TimelineEvent</code>.
      - `relatedItemId` string — The ID of a <code>RelatedItem</code> referenced in a <code>TimelineEvent</code>.
      - `resource` string — The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a <code>TimelineEvent</code>.
    - `eventTime` string, date-time, required — The time that the event occurred.
    - `eventType` string, required — The type of event. The timeline event must be <code>Custom Event</code>.
    - `eventUpdatedTime` string, date-time, required — The time that the timeline event was last updated.
    - `incidentRecordArn` string, required — 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.

## Other responses

- `480` — ThrottlingException
- `481` — AccessDeniedException
- `482` — ValidationException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/ssm-incidents.md) · [All operations](https://skmtc.net/aws/apis/ssm-incidents/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/ssm-incidents/versions/18d598f1fa32/schema)