Creates a software bill of materials (SBOM) report.
Parameters:
-
resource_filter_criteria
(Optional[ResourceFilterCriteria], default:
None
)
–
The resource filter criteria for the software bill of materials (SBOM) report.
-
report_format
(SbomReportFormat)
–
The output format for the software bill of materials (SBOM) report.
-
s3_destination
(Destination)
–
Contains details of the Amazon S3 bucket and KMS key used to export findings.
Raises:
-
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 Amazon Web Services Region.
-
InternalServerException
–
The request has failed due to an internal failure of the Amazon Inspector service.
-
ResourceNotFoundException
–
The operation tried to access an invalid resource. Make sure the resource is specified correctly.
-
ThrottlingException
–
The limit on the number of requests per second was exceeded.
-
ValidationException
–
The request has failed validation due to missing required fields or having invalid inputs.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_inspector2/_services/inspector2.py
| def create_sbom_export(
self,
report_format: "capo_inspector2.types.sbom_report_format.SbomReportFormat",
s3_destination: "capo_inspector2.types.destination.Destination",
*,
config_overrides: Optional[Inspector2ClientConfig] = None,
resource_filter_criteria: Optional[
"capo_inspector2.types.resource_filter_criteria.ResourceFilterCriteria"
] = None,
) -> "capo_inspector2.types.create_sbom_export_response.CreateSbomExportResponse":
"""<p>Creates a software bill of materials (SBOM) report.</p>
Args:
resource_filter_criteria: <p>The resource filter criteria for the software bill of materials (SBOM) report.</p>
report_format: <p>The output format for the software bill of materials (SBOM) report.</p>
s3_destination: <p>Contains details of the Amazon S3 bucket and KMS key used to export findings.</p>
Raises:
capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
capo_inspector2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access an invalid resource. Make sure the resource is specified correctly.</p>
capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_inspector2.types.create_sbom_export_request.CreateSbomExportRequest]",
) -> OperationResponse[
"capo_inspector2.types.create_sbom_export_response.CreateSbomExportResponse"
]:
import capo_inspector2._operations.inspector2.create_sbom_export
output, http_response = (
capo_inspector2._operations.inspector2.create_sbom_export.create_sbom_export(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateSbomExport")
)
input_: capo_inspector2.types.create_sbom_export_request.CreateSbomExportRequest = {
"report_format": report_format,
"s3_destination": s3_destination,
}
if resource_filter_criteria is not None:
input_["resource_filter_criteria"] = resource_filter_criteria
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|