Amazon Inspector · JSON Structure

Inspector Create Sbom Export Request Structure

CreateSbomExportRequest schema

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

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

Properties

reportFormat resourceFilterCriteria s3Destination

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-create-sbom-export-request-structure.json",
  "name": "CreateSbomExportRequest",
  "description": "CreateSbomExportRequest schema",
  "type": "object",
  "properties": {
    "reportFormat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SbomReportFormat"
        },
        {
          "description": "The output format for the software bill of materials (SBOM) report."
        }
      ]
    },
    "resourceFilterCriteria": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceFilterCriteria"
        },
        {
          "description": "The resource filter criteria for the software bill of materials (SBOM) report."
        }
      ]
    },
    "s3Destination": {
      "type": "object",
      "required": [
        "bucketName",
        "kmsKeyArn"
      ],
      "properties": {
        "bucketName": {
          "allOf": [
            {
              "$ref": "#/components/schemas/String"
            },
            {
              "description": "The name of the Amazon S3 bucket to export findings to."
            }
          ]
        },
        "keyPrefix": {
          "allOf": [
            {
              "$ref": "#/components/schemas/String"
            },
            {
              "description": "The prefix that the findings will be written under."
            }
          ]
        },
        "kmsKeyArn": {
          "allOf": [
            {
              "$ref": "#/components/schemas/String"
            },
            {
              "description": "The ARN of the KMS key used to encrypt data when exporting findings."
            }
          ]
        }
      },
      "description": "Contains details of the Amazon S3 bucket and KMS key used to export findings."
    }
  },
  "required": [
    "reportFormat",
    "s3Destination"
  ]
}