Amazon Inspector · JSON Structure

Inspector Code Snippet Error Structure

Contains information about any errors encountered while trying to retrieve a code snippet.

Type: object Properties: 3 Required: 3
ComplianceContainer SecurityEC2LambdaSecurityVulnerability Scanning

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

Properties

errorCode errorMessage findingArn

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-inspector/refs/heads/main/json-structure/inspector-code-snippet-error-structure.json",
  "name": "CodeSnippetError",
  "description": "Contains information about any errors encountered while trying to retrieve a code snippet.",
  "type": "object",
  "properties": {
    "errorCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CodeSnippetErrorCode"
        },
        {
          "description": "The error code for the error that prevented a code snippet from being retrieved."
        }
      ]
    },
    "errorMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The error message received when Amazon Inspector failed to retrieve a code snippet."
        }
      ]
    },
    "findingArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FindingArn"
        },
        {
          "description": "The ARN of the finding that a code snippet couldn't be retrieved for."
        }
      ]
    }
  },
  "required": [
    "errorCode",
    "errorMessage",
    "findingArn"
  ]
}