Package software.amazon.awssdk.services.supplychain

Interface SupplyChainAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SupplyChainAsyncClient extends AwsClient
Service client for accessing AWS Supply Chain asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply Chain, you can connect and extract your inventory, supply, and demand related data from existing ERP or supply chain systems into a single data model.

The AWS Supply Chain API supports configuration data import for Supply Planning.

All AWS Supply chain API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies.

  • Field Details

  • Method Details

    • createBillOfMaterialsImportJob

      default CompletableFuture<CreateBillOfMaterialsImportJobResponse> createBillOfMaterialsImportJob(CreateBillOfMaterialsImportJobRequest createBillOfMaterialsImportJobRequest)

      CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide.

      The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.

      Parameters:
      createBillOfMaterialsImportJobRequest - The request parameters for CreateBillOfMaterialsImportJob.
      Returns:
      A Java Future containing the result of the CreateBillOfMaterialsImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException Request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource which does not exist.
      • AccessDeniedException You do not have the required privileges to perform this action.
      • ValidationException The input does not satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error during processing of request.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • 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.
      • SupplyChainException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBillOfMaterialsImportJob

      default CompletableFuture<CreateBillOfMaterialsImportJobResponse> createBillOfMaterialsImportJob(Consumer<CreateBillOfMaterialsImportJobRequest.Builder> createBillOfMaterialsImportJobRequest)

      CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide.

      The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.


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

      Parameters:
      createBillOfMaterialsImportJobRequest - A Consumer that will call methods on CreateBillOfMaterialsImportJobRequest.Builder to create a request. The request parameters for CreateBillOfMaterialsImportJob.
      Returns:
      A Java Future containing the result of the CreateBillOfMaterialsImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ThrottlingException Request was denied due to request throttling.
      • ResourceNotFoundException Request references a resource which does not exist.
      • AccessDeniedException You do not have the required privileges to perform this action.
      • ValidationException The input does not satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error during processing of request.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • 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.
      • SupplyChainException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBillOfMaterialsImportJob

      default CompletableFuture<GetBillOfMaterialsImportJobResponse> getBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest getBillOfMaterialsImportJobRequest)

      Get status and details of a BillOfMaterialsImportJob.

      Parameters:
      getBillOfMaterialsImportJobRequest - The request parameters for GetBillOfMaterialsImportJob.
      Returns:
      A Java Future containing the result of the GetBillOfMaterialsImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ResourceNotFoundException Request references a resource which does not exist.
      • ThrottlingException Request was denied due to request throttling.
      • AccessDeniedException You do not have the required privileges to perform this action.
      • ValidationException The input does not satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error during processing of request.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • 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.
      • SupplyChainException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBillOfMaterialsImportJob

      default CompletableFuture<GetBillOfMaterialsImportJobResponse> getBillOfMaterialsImportJob(Consumer<GetBillOfMaterialsImportJobRequest.Builder> getBillOfMaterialsImportJobRequest)

      Get status and details of a BillOfMaterialsImportJob.


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

      Parameters:
      getBillOfMaterialsImportJobRequest - A Consumer that will call methods on GetBillOfMaterialsImportJobRequest.Builder to create a request. The request parameters for GetBillOfMaterialsImportJob.
      Returns:
      A Java Future containing the result of the GetBillOfMaterialsImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ResourceNotFoundException Request references a resource which does not exist.
      • ThrottlingException Request was denied due to request throttling.
      • AccessDeniedException You do not have the required privileges to perform this action.
      • ValidationException The input does not satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error during processing of request.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • 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.
      • SupplyChainException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendDataIntegrationEvent

      default CompletableFuture<SendDataIntegrationEventResponse> sendDataIntegrationEvent(SendDataIntegrationEventRequest sendDataIntegrationEventRequest)

      Send transactional data events with real-time data for analysis or monitoring.

      Parameters:
      sendDataIntegrationEventRequest - The request parameters for SendDataIntegrationEvent.
      Returns:
      A Java Future containing the result of the SendDataIntegrationEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ResourceNotFoundException Request references a resource which does not exist.
      • ThrottlingException Request was denied due to request throttling.
      • AccessDeniedException You do not have the required privileges to perform this action.
      • ValidationException The input does not satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error during processing of request.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • 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.
      • SupplyChainException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendDataIntegrationEvent

      default CompletableFuture<SendDataIntegrationEventResponse> sendDataIntegrationEvent(Consumer<SendDataIntegrationEventRequest.Builder> sendDataIntegrationEventRequest)

      Send transactional data events with real-time data for analysis or monitoring.


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

      Parameters:
      sendDataIntegrationEventRequest - A Consumer that will call methods on SendDataIntegrationEventRequest.Builder to create a request. The request parameters for SendDataIntegrationEvent.
      Returns:
      A Java Future containing the result of the SendDataIntegrationEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceQuotaExceededException Request would cause a service quota to be exceeded.
      • ResourceNotFoundException Request references a resource which does not exist.
      • ThrottlingException Request was denied due to request throttling.
      • AccessDeniedException You do not have the required privileges to perform this action.
      • ValidationException The input does not satisfy the constraints specified by an AWS service.
      • InternalServerException Unexpected error during processing of request.
      • ConflictException Updating or deleting a resource can cause an inconsistent state.
      • 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.
      • SupplyChainException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default SupplyChainServiceClientConfiguration 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

    • create

      static SupplyChainAsyncClient create()
      Create a SupplyChainAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SupplyChainAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SupplyChainAsyncClient.