Amazon Incident Manager · JSON Structure

Incident Manager Related Item Structure

Resources that responders use to triage and mitigate the incident.

Type: object Properties: 3 Required: 1
AutomationDevOpsIncident ManagementOperations

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

Properties

generatedId identifier title

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-related-item-structure.json",
  "name": "RelatedItem",
  "description": "Resources that responders use to triage and mitigate the incident.",
  "type": "object",
  "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."
        }
      ]
    }
  },
  "required": [
    "identifier"
  ]
}