RelatedItemList

RelatedItemList schema

AutomationDevOpsIncident ManagementOperations
View JSON Schema on GitHub

JSON Schema

incident-manager-related-item-list-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-related-item-list-schema.json",
  "title": "RelatedItemList",
  "description": "RelatedItemList schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "identifier"
    ],
    "properties": {
      "generatedId": {
        "allOf": [
          {
            "$ref": "#/components/schemas/GeneratedId"
          },
          {
            "description": "<p>A unique ID for a <code>RelatedItem</code>.</p> <important> <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the <a>UpdateRelatedItems</a> API action.</p> </important>"
          }
        ]
      },
      "identifier": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ItemIdentifier"
          },
          {
            "description": "Details about the related item."
          }
        ]
      },
      "title": {
        "allOf": [
          {
            "$ref": "#/components/schemas/RelatedItemTitleString"
          },
          {
            "description": "The title of the related item."
          }
        ]
      }
    },
    "description": "Resources that responders use to triage and mitigate the incident."
  }
}