Package software.amazon.awssdk.services.inspectorscan

Interface InspectorScanAsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface InspectorScanAsyncClient
extends AwsClient
    Service client for accessing inspector-scan asynchronously. 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.

    • Method Detail

      • scanSbom

        default CompletableFuture<ScanSbomResponse> scanSbom​(ScanSbomRequest scanSbomRequest)

        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:
        A Java Future containing the result of the ScanSbom operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        See Also:
        AWS API Documentation

      • scanSbom

        default CompletableFuture<ScanSbomResponse> scanSbom​(Consumer<ScanSbomRequest.Builder> scanSbomRequest)

        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:
        A Java Future containing the result of the ScanSbom operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        See Also:
        AWS API Documentation