SDK for PHP V3

Inspector Scan 2023-08-08

Client: Aws\InspectorScan\InspectorScanClient
Service ID: inspector-scan
Version: 2023-08-08

This page describes the parameters and results for the operations of the Inspector Scan (2023-08-08), and shows how to use the Aws\InspectorScan\InspectorScanClient object to call the described operations. This documentation is specific to the 2023-08-08 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

ScanSbom ( array $params = [] )
Scans a provided CycloneDX 1.

Operations

ScanSbom 

$result = $client->scanSbom([/* ... */]);
$promise = $client->scanSbomAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->scanSbom([
    'outputFormat' => 'CYCLONE_DX_1_5|INSPECTOR',
    'sbom' => [ // REQUIRED
    ],
]);

Parameter Details

Members
outputFormat
Type: string

The output format for the vulnerability report.

sbom
Required: Yes
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

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

Result Syntax

[
    'sbom' => [
    ],
]

Result Details

Members
sbom
Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The vulnerability report for the scanned SBOM.

Errors

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

Examples

Example 1: Sample ScanSbom Call 
$result = $client->scanSbom([
    'outputFormat' => 'CYCLONE_DX_1_5',
    'sbom' => [
    ],
]);

Result syntax:

[
    'sbom' => [
    ],
]

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

InternalServerException

Description

The request processing has failed because of an unknown error, exception or failure.

Members
message
Required: Yes
Type: string
reason
Required: Yes
Type: string

The reason for the validation failure.

retryAfterSeconds
Type: int

The number of seconds to wait before retrying the request.

Sbom

Members

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string
retryAfterSeconds
Type: int

The number of seconds to wait before retrying the request.

ValidationException

Description

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

Members
fields
Type: Array of ValidationExceptionField structures

The fields that failed validation.

message
Required: Yes
Type: string
reason
Required: Yes
Type: string

The reason for the validation failure.

ValidationExceptionField

Description

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

Members
message
Required: Yes
Type: string

The validation exception message.

name
Required: Yes
Type: string

The name of the validation exception.