Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSbomExport

Creates a software bill of materials (SBOM) report.

Request Syntax


POST /sbomexport/create HTTP/1.1
Content-type: application/json

{
   "reportFormat": "string",
   "resourceFilterCriteria": { 
      "accountId": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "ec2InstanceTags": [ 
         { 
            "comparison": "string",
            "key": "string",
            "value": "string"
         }
      ],
      "ecrImageTags": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "ecrRepositoryName": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "lambdaFunctionName": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "lambdaFunctionTags": [ 
         { 
            "comparison": "string",
            "key": "string",
            "value": "string"
         }
      ],
      "resourceId": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "resourceType": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ]
   },
   "s3Destination": { 
      "bucketName": "string",
      "keyPrefix": "string",
      "kmsKeyArn": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

reportFormat

The output format for the software bill of materials (SBOM) report.

Type: String

Valid Values: CYCLONEDX_1_4 | SPDX_2_3

Required: Yes

resourceFilterCriteria

The resource filter criteria for the software bill of materials (SBOM) report.

Type: ResourceFilterCriteria object

Required: No

s3Destination

Contains details of the Amazon S3 bucket and AWS KMS key used to export findings.

Type: Destination object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "reportId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

reportId

The report ID for the software bill of materials (SBOM) report.

Type: String

Pattern: .*\b[a-f0-9]{8}\b-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-\b[a-f0-9]{12}\b.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported AWS Region.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

fields: The fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400