Gets details of a software bill of materials (SBOM) report.
Request Syntax
POST /sbomexport/get HTTP/1.1
Content-type: application/json
{
"reportId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- reportId
-
The report ID of the SBOM export to get details for.
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}\bRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"errorCode": "string",
"errorMessage": "string",
"filterCriteria": {
"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"
}
]
},
"format": "string",
"reportId": "string",
"s3Destination": {
"bucketName": "string",
"keyPrefix": "string",
"kmsKeyArn": "string"
},
"status": "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.
- errorCode
-
An error code.
Type: String
Valid Values:
INTERNAL_ERROR | INVALID_PERMISSIONS | NO_FINDINGS_FOUND | BUCKET_NOT_FOUND | INCOMPATIBLE_BUCKET_REGION | MALFORMED_KMS_KEY - errorMessage
-
An error message.
Type: String
Length Constraints: Minimum length of 1.
- filterCriteria
-
Contains details about the resource filter criteria used for the software bill of materials (SBOM) report.
Type: ResourceFilterCriteria object
- format
-
The format of the software bill of materials (SBOM) report.
Type: String
Valid Values:
CYCLONEDX_1_4 | SPDX_2_3 - reportId
-
The report ID of 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 - s3Destination
-
Contains details of the Amazon S3 bucket and AWS KMS key used to export findings
Type: Destination object
- status
-
The status of the software bill of materials (SBOM) report.
Type: String
Valid Values:
SUCCEEDED | IN_PROGRESS | CANCELLED | FAILED
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.
HTTP Status Code: 403
- InternalServerException
-
The request has failed due to an internal failure of the Amazon Inspector service.
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.
HTTP Status Code: 429
- ValidationException
-
The request has failed validation due to missing required fields or having invalid inputs.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
