inspectorscan / Client / scan_sbom

scan_sbom#

inspectorscan.Client.scan_sbom(**kwargs)#

Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the `Amazon Inspector SBOM generator.

See also: AWS API Documentation

Request Syntax

response = client.scan_sbom(
    sbom={...}|[...]|123|123.4|'string'|True|None,
    outputFormat='CYCLONE_DX_1_5'|'INSPECTOR'
)
Parameters:

  • sbom (document) –

    [REQUIRED]

    The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format.

  • outputFormat (string) – The output format for the vulnerability report.

Return type:

dict

Returns:

Response Syntax

{
    'sbom': {...}|[...]|123|123.4|'string'|True|None
}

Response Structure

  • (dict) –

    • sbom (document) –

      The vulnerability report for the scanned SBOM.

Exceptions

  • inspectorscan.Client.exceptions.InternalServerException

  • inspectorscan.Client.exceptions.ThrottlingException

  • inspectorscan.Client.exceptions.ValidationException

  • inspectorscan.Client.exceptions.AccessDeniedException