ListTimelineEventsInput

ListTimelineEventsInput schema

AutomationDevOpsIncident ManagementOperations

Properties

Name Type Description
filters object
incidentRecordArn object
maxResults object
nextToken object
sortBy object
sortOrder object
View JSON Schema on GitHub

JSON Schema

incident-manager-list-timeline-events-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-incident-manager/refs/heads/main/json-schema/incident-manager-list-timeline-events-input-schema.json",
  "title": "ListTimelineEventsInput",
  "description": "ListTimelineEventsInput schema",
  "type": "object",
  "properties": {
    "filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterList"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "incidentRecordArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the incident that includes the timeline event."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResults"
        },
        {
          "description": "The maximum number of results per page."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The pagination token to continue to the next page of results."
        }
      ]
    },
    "sortBy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimelineEventSort"
        },
        {
          "description": "Sort timeline events by the specified key value pair."
        }
      ]
    },
    "sortOrder": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SortOrder"
        },
        {
          "description": "Sorts the order of timeline events by the value specified in the <code>sortBy</code> field."
        }
      ]
    }
  },
  "required": [
    "incidentRecordArn"
  ]
}