Amazon Incident Manager · JSON Structure

Incident Manager Create Timeline Event Input Structure

CreateTimelineEventInput schema

Type: object Properties: 6 Required: 4
AutomationDevOpsIncident ManagementOperations

CreateTimelineEventInput is a JSON Structure definition published by Amazon Incident Manager, describing 6 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

clientToken eventData eventReferences eventTime eventType incidentRecordArn

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-incident-manager/refs/heads/main/json-structure/incident-manager-create-timeline-event-input-structure.json",
  "name": "CreateTimelineEventInput",
  "description": "CreateTimelineEventInput schema",
  "type": "object",
  "properties": {
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "A token that ensures that a client calls the action only once with the specified details."
        }
      ]
    },
    "eventData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventData"
        },
        {
          "description": "A short description of the event."
        }
      ]
    },
    "eventReferences": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventReferenceList"
        },
        {
          "description": "Adds one or more references to the <code>TimelineEvent</code>. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item."
        }
      ]
    },
    "eventTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time that the event occurred."
        }
      ]
    },
    "eventType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimelineEventType"
        },
        {
          "description": "The type of event. You can create timeline events of type <code>Custom Event</code>."
        }
      ]
    },
    "incidentRecordArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the incident record that the action adds the incident to."
        }
      ]
    }
  },
  "required": [
    "eventData",
    "eventTime",
    "eventType",
    "incidentRecordArn"
  ]
}