CreateScanResponse

CreateScanResponse schema from Amazon CodeGuru Security

AmazonSecuritySASTCode AnalysisDevSecOpsDeveloper Tools

Properties

Name Type Description
resourceId object
runId object
scanName object
scanNameArn object
scanState object
View JSON Schema on GitHub

JSON Schema

amazon-codeguru-security-create-scan-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeguru-security/refs/heads/main/json-schema/amazon-codeguru-security-create-scan-response-schema.json",
  "title": "CreateScanResponse",
  "description": "CreateScanResponse schema from Amazon CodeGuru Security",
  "type": "object",
  "properties": {
    "resourceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceId"
        },
        {
          "description": "The identifier for the resource object that contains resources that were scanned."
        }
      ]
    },
    "runId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Uuid"
        },
        {
          "description": "UUID that identifies the individual scan run."
        }
      ]
    },
    "scanName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScanName"
        },
        {
          "description": "The name of the scan."
        }
      ]
    },
    "scanNameArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScanNameArn"
        },
        {
          "description": "The ARN for the scan name."
        }
      ]
    },
    "scanState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScanState"
        },
        {
          "description": "The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>."
        }
      ]
    }
  },
  "required": [
    "resourceId",
    "runId",
    "scanName",
    "scanState"
  ]
}