Interface SupplyChainClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SupplyChainClientBuilder
builder()
Create a builder that can be used to configure and create aSupplyChainClient
.static SupplyChainClient
create()
Create aSupplyChainClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createBillOfMaterialsImportJob
(Consumer<CreateBillOfMaterialsImportJobRequest.Builder> createBillOfMaterialsImportJobRequest) CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.createBillOfMaterialsImportJob
(CreateBillOfMaterialsImportJobRequest createBillOfMaterialsImportJobRequest) CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.getBillOfMaterialsImportJob
(Consumer<GetBillOfMaterialsImportJobRequest.Builder> getBillOfMaterialsImportJobRequest) Get status and details of a BillOfMaterialsImportJob.getBillOfMaterialsImportJob
(GetBillOfMaterialsImportJobRequest getBillOfMaterialsImportJobRequest) Get status and details of a BillOfMaterialsImportJob.default SendDataIntegrationEventResponse
sendDataIntegrationEvent
(Consumer<SendDataIntegrationEventRequest.Builder> sendDataIntegrationEventRequest) Send transactional data events with real-time data for analysis or monitoring.default SendDataIntegrationEventResponse
sendDataIntegrationEvent
(SendDataIntegrationEventRequest sendDataIntegrationEventRequest) Send transactional data events with real-time data for analysis or monitoring.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createBillOfMaterialsImportJob
default CreateBillOfMaterialsImportJobResponse createBillOfMaterialsImportJob(CreateBillOfMaterialsImportJobRequest createBillOfMaterialsImportJobRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException 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:
- Result of the CreateBillOfMaterialsImportJob operation returned by the service.
- See Also:
-
createBillOfMaterialsImportJob
default CreateBillOfMaterialsImportJobResponse createBillOfMaterialsImportJob(Consumer<CreateBillOfMaterialsImportJobRequest.Builder> createBillOfMaterialsImportJobRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException 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 viaCreateBillOfMaterialsImportJobRequest.builder()
- Parameters:
createBillOfMaterialsImportJobRequest
- AConsumer
that will call methods onCreateBillOfMaterialsImportJobRequest.Builder
to create a request. The request parameters for CreateBillOfMaterialsImportJob.- Returns:
- Result of the CreateBillOfMaterialsImportJob operation returned by the service.
- See Also:
-
getBillOfMaterialsImportJob
default GetBillOfMaterialsImportJobResponse getBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest getBillOfMaterialsImportJobRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Get status and details of a BillOfMaterialsImportJob.
- Parameters:
getBillOfMaterialsImportJobRequest
- The request parameters for GetBillOfMaterialsImportJob.- Returns:
- Result of the GetBillOfMaterialsImportJob operation returned by the service.
- See Also:
-
getBillOfMaterialsImportJob
default GetBillOfMaterialsImportJobResponse getBillOfMaterialsImportJob(Consumer<GetBillOfMaterialsImportJobRequest.Builder> getBillOfMaterialsImportJobRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException 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 viaGetBillOfMaterialsImportJobRequest.builder()
- Parameters:
getBillOfMaterialsImportJobRequest
- AConsumer
that will call methods onGetBillOfMaterialsImportJobRequest.Builder
to create a request. The request parameters for GetBillOfMaterialsImportJob.- Returns:
- Result of the GetBillOfMaterialsImportJob operation returned by the service.
- See Also:
-
sendDataIntegrationEvent
default SendDataIntegrationEventResponse sendDataIntegrationEvent(SendDataIntegrationEventRequest sendDataIntegrationEventRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Send transactional data events with real-time data for analysis or monitoring.
- Parameters:
sendDataIntegrationEventRequest
- The request parameters for SendDataIntegrationEvent.- Returns:
- Result of the SendDataIntegrationEvent operation returned by the service.
- See Also:
-
sendDataIntegrationEvent
default SendDataIntegrationEventResponse sendDataIntegrationEvent(Consumer<SendDataIntegrationEventRequest.Builder> sendDataIntegrationEventRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException 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 viaSendDataIntegrationEventRequest.builder()
- Parameters:
sendDataIntegrationEventRequest
- AConsumer
that will call methods onSendDataIntegrationEventRequest.Builder
to create a request. The request parameters for SendDataIntegrationEvent.- Returns:
- Result of the SendDataIntegrationEvent operation returned by the service.
- See Also:
-
create
Create aSupplyChainClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSupplyChainClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-