Interface InspectorScanClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface InspectorScanClient
extends AwsClient

Service client for accessing inspector-scan. This can be created using the static builder() method.

Amazon Inspector Scan is a vulnerability discovery service that scans a provided Software Bill of Materials (SBOM) for security vulnerabilities.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static InspectorScanClientBuilder	builder()	Create a builder that can be used to configure and create a InspectorScanClient.
static InspectorScanClient	create()	Create a InspectorScanClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ScanSbomResponse	scanSbom(Consumer<ScanSbomRequest.Builder> scanSbomRequest)	Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM.
default ScanSbomResponse	scanSbom(ScanSbomRequest scanSbomRequest)	Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM.
default InspectorScanServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

scanSbom

default ScanSbomResponse scanSbom(ScanSbomRequest scanSbomRequest)
                           throws InternalServerException,
ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
InspectorScanException

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.

The output of this action reports NVD and CVSS scores when NVD and CVSS scores are available. Because the output reports both scores, you might notice a discrepency between them. However, you can triage the severity of either score depending on the vendor of your choosing.

Parameters:

scanSbomRequest -

Returns:

Result of the ScanSbom operation returned by the service.

See Also:

• AWS API Documentation

scanSbom

default ScanSbomResponse scanSbom(Consumer<ScanSbomRequest.Builder> scanSbomRequest)
                           throws InternalServerException,
ThrottlingException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
InspectorScanException

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.

The output of this action reports NVD and CVSS scores when NVD and CVSS scores are available. Because the output reports both scores, you might notice a discrepency between them. However, you can triage the severity of either score depending on the vendor of your choosing.

This is a convenience which creates an instance of the ScanSbomRequest.Builder avoiding the need to create one manually via ScanSbomRequest.builder()

Parameters:

scanSbomRequest - A Consumer that will call methods on ScanSbomRequest.Builder to create a request.

Returns:

Result of the ScanSbom operation returned by the service.

See Also:

• AWS API Documentation

create

static InspectorScanClient create()

Create a InspectorScanClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static InspectorScanClientBuilder builder()

Create a builder that can be used to configure and create a InspectorScanClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default InspectorScanServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration