{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-resilience-hub/json-schema/amazon-resilience-hub-list-alarm-recommendations-response-schema.json",
  "title": "ListAlarmRecommendationsResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-resilience-hub-recommendations-api-openapi.yml#/components/schemas/ListAlarmRecommendationsResponse",
  "type": "object",
  "properties": {
    "alarmRecommendations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AlarmRecommendation"
      },
      "description": "The alarm recommendations for an Resilience Hub application, returned as an object. This object includes Application Component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more."
    },
    "nextToken": {
      "type": "string",
      "description": "Token for the next set of results, or null if there are no more results."
    }
  },
  "required": [
    "alarmRecommendations"
  ],
  "$defs": {
    "Alarm": {
      "type": "object",
      "properties": {
        "alarmArn": {
          "type": "string",
          "description": "Amazon Resource Name (ARN) of the Amazon CloudWatch alarm."
        },
        "source": {
          "type": "string",
          "description": "Indicates the source of the Amazon CloudWatch alarm. That is, it indicates if the alarm was created using Resilience Hub recommendation (AwsResilienceHub), or if you had created the alarm in Amazon CloudWatch (Customer)."
        }
      }
    },
    "AlarmRecommendation": {
      "type": "object",
      "properties": {
        "recommendationId": {
          "type": "string",
          "description": "Identifier of the alarm recommendation."
        },
        "referenceId": {
          "type": "string",
          "description": "Reference identifier of the alarm recommendation."
        },
        "name": {
          "type": "string",
          "description": "Name of the alarm recommendation."
        },
        "description": {
          "type": "string",
          "description": "Description of the alarm recommendation."
        },
        "type": {
          "type": "string",
          "enum": [
            "Metric",
            "Composite",
            "Canary",
            "Logs",
            "Event"
          ],
          "description": "Type of alarm recommendation."
        },
        "appComponentName": {
          "type": "string",
          "description": "Application Component name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list."
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RecommendationItem"
          },
          "description": "List of CloudWatch alarm recommendations."
        },
        "prerequisite": {
          "type": "string",
          "description": "The prerequisite for the alarm recommendation."
        },
        "appComponentNames": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of Application Component names for the CloudWatch alarm recommendation."
        },
        "recommendationStatus": {
          "type": "string",
          "enum": [
            "Implemented",
            "Inactive",
            "NotImplemented",
            "Excluded"
          ],
          "description": "Status of the recommended Amazon CloudWatch alarm."
        }
      },
      "required": [
        "recommendationId",
        "referenceId",
        "name",
        "type"
      ]
    },
    "Experiment": {
      "type": "object",
      "properties": {
        "experimentArn": {
          "type": "string",
          "description": "Amazon Resource Name (ARN) of the FIS experiment."
        },
        "experimentTemplateId": {
          "type": "string",
          "description": "Identifier of the FIS experiment template."
        }
      }
    },
    "RecommendationItem": {
      "type": "object",
      "properties": {
        "resourceId": {
          "type": "string",
          "description": "Identifier of the resource."
        },
        "targetAccountId": {
          "type": "string",
          "description": "Identifier of the target account."
        },
        "targetRegion": {
          "type": "string",
          "description": "The target region."
        },
        "alreadyImplemented": {
          "type": "boolean",
          "description": "Specifies if the recommendation has already been implemented."
        },
        "excluded": {
          "type": "boolean",
          "description": "Indicates if an operational recommendation item is excluded."
        },
        "excludeReason": {
          "type": "string",
          "enum": [
            "AlreadyImplemented",
            "NotRelevant",
            "ComplexityOfImplementation"
          ],
          "description": "Indicates the reason for excluding an operational recommendation."
        },
        "latestDiscoveredExperiment": {
          "$ref": "#/$defs/Experiment"
        },
        "discoveredAlarm": {
          "$ref": "#/$defs/Alarm"
        }
      }
    }
  }
}