Lists timeline events for the specified incident record¶

Description¶

Lists timeline events for the specified incident record.

Usage¶

ssmincidents_list_timeline_events(filters, incidentRecordArn,
  maxResults, nextToken, sortBy, sortOrder)

Arguments¶

• filters

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

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

• incidentRecordArn

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

• maxResults

  The maximum number of results per page.

• nextToken

  The pagination token for the next set of items to return. (You received this token from a previous call.)

• sortBy

  Sort timeline events by the specified key value pair.

• sortOrder

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

Value¶

A list with the following syntax:

list(
  eventSummaries = list(
    list(
      eventId = "string",
      eventReferences = list(
        list(
          relatedItemId = "string",
          resource = "string"
        )
      ),
      eventTime = as.POSIXct(
        "2015-01-01"
      ),
      eventType = "string",
      eventUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      incidentRecordArn = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_timeline_events(
  filters = list(
    list(
      condition = list(
        after = as.POSIXct(
          "2015-01-01"
        ),
        before = as.POSIXct(
          "2015-01-01"
        ),
        equals = list(
          integerValues = list(
            123
          ),
          stringValues = list(
            "string"
          )
        )
      ),
      key = "string"
    )
  ),
  incidentRecordArn = "string",
  maxResults = 123,
  nextToken = "string",
  sortBy = "EVENT_TIME",
  sortOrder = "ASCENDING"|"DESCENDING"
)