Inspector Scan

{'outputFormat': {'INSPECTOR_ALT'}}

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

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

type sbom:

:ref:`document<document>`

param sbom:

[REQUIRED]

The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format. This format limits you to passing 2000 components before throwing a ValidException error.

type outputFormat:

string

param outputFormat:

The output format for the vulnerability report.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • sbom (:ref:`document<document>`) --

    The vulnerability report for the scanned SBOM.