Package software.amazon.awssdk.services.inspectorscan

Interface InspectorScanClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@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 String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static 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()
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Detail

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 Detail

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.

Parameters:

scanSbomRequest -

Returns:

Result of the ScanSbom operation returned by the service.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

InspectorScanException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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.

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.

Throws:

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

InspectorScanException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient