UpdateTimelineEventInput

UpdateTimelineEventInput schema

AutomationDevOpsIncident ManagementOperations

Properties

Name Type Description
clientToken object
eventData object
eventId object
eventReferences object
eventTime object
eventType object
incidentRecordArn object
View JSON Schema on GitHub

JSON Schema

incident-manager-update-timeline-event-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-update-timeline-event-input-schema.json",
  "title": "UpdateTimelineEventInput",
  "description": "UpdateTimelineEventInput schema",
  "type": "object",
  "properties": {
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "A token that ensures that a client calls the operation only once with the specified details."
        }
      ]
    },
    "eventData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventData"
        },
        {
          "description": "A short description of the event."
        }
      ]
    },
    "eventId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UUID"
        },
        {
          "description": "The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an event's ID."
        }
      ]
    },
    "eventReferences": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventReferenceList"
        },
        {
          "description": "<p>Updates all existing references in a <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 that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.</p> <important> <p>This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.</p> </important>"
        }
      ]
    },
    "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 update events of type <code>Custom Event</code>."
        }
      ]
    },
    "incidentRecordArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the incident that includes the timeline event."
        }
      ]
    }
  },
  "required": [
    "eventId",
    "incidentRecordArn"
  ]
}