Amazon Well-Architected Tool · JSON Structure

Well Architected Tool Check Detail Structure

Account details for a Well-Architected best practice in relation to Trusted Advisor checks.

Type: object Properties: 13

ArchitectureBest PracticesCloud GovernanceWell-ArchitectedWorkloads

CheckDetail is a JSON Structure definition published by Amazon Well-Architected Tool, describing 13 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Id Name Description Provider LensArn PillarId QuestionId ChoiceId Status AccountId FlaggedResources Reason UpdatedAt

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

JSON Structure

{
  "type": "object",
  "properties": {
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CheckId"
        },
        {
          "description": "Trusted Advisor check ID."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CheckName"
        },
        {
          "description": "Trusted Advisor check name."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CheckDescription"
        },
        {
          "description": "Trusted Advisor check description."
        }
      ]
    },
    "Provider": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CheckProvider"
        },
        {
          "description": "Provider of the check related to the best practice."
        }
      ]
    },
    "LensArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LensArn"
        },
        {
          "description": "Well-Architected Lens ARN associated to the check."
        }
      ]
    },
    "PillarId": {
      "$ref": "#/components/schemas/PillarId"
    },
    "QuestionId": {
      "$ref": "#/components/schemas/QuestionId"
    },
    "ChoiceId": {
      "$ref": "#/components/schemas/ChoiceId"
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CheckStatus"
        },
        {
          "description": "Status associated to the check."
        }
      ]
    },
    "AccountId": {
      "$ref": "#/components/schemas/AwsAccountId"
    },
    "FlaggedResources": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FlaggedResources"
        },
        {
          "description": "Count of flagged resources associated to the check."
        }
      ]
    },
    "Reason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CheckFailureReason"
        },
        {
          "description": "Reason associated to the check."
        }
      ]
    },
    "UpdatedAt": {
      "$ref": "#/components/schemas/Timestamp"
    }
  },
  "description": "Account details for a Well-Architected best practice in relation to Trusted Advisor checks.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "CheckDetail",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-well-architected-tool/refs/heads/main/json-structure/well-architected-tool-check-detail-structure.json"
}