Interface SupplyChainClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SupplyChainClient extends AwsClient
Service client for accessing AWS Supply Chain. This can be created using the staticbuilder()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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SupplyChainClientBuilderbuilder()Create a builder that can be used to configure and create aSupplyChainClient.static SupplyChainClientcreate()Create aSupplyChainClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateBillOfMaterialsImportJobResponsecreateBillOfMaterialsImportJob(Consumer<CreateBillOfMaterialsImportJobRequest.Builder> createBillOfMaterialsImportJobRequest)CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.default CreateBillOfMaterialsImportJobResponsecreateBillOfMaterialsImportJob(CreateBillOfMaterialsImportJobRequest createBillOfMaterialsImportJobRequest)CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.default GetBillOfMaterialsImportJobResponsegetBillOfMaterialsImportJob(Consumer<GetBillOfMaterialsImportJobRequest.Builder> getBillOfMaterialsImportJobRequest)Get status and details of a BillOfMaterialsImportJob.default GetBillOfMaterialsImportJobResponsegetBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest getBillOfMaterialsImportJobRequest)Get status and details of a BillOfMaterialsImportJob.default SendDataIntegrationEventResponsesendDataIntegrationEvent(Consumer<SendDataIntegrationEventRequest.Builder> sendDataIntegrationEventRequest)Send transactional data events with real-time data for analysis or monitoring.default SendDataIntegrationEventResponsesendDataIntegrationEvent(SendDataIntegrationEventRequest sendDataIntegrationEventRequest)Send transactional data events with real-time data for analysis or monitoring.default SupplyChainServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateBillOfMaterialsImportJobRequest.builder()- Parameters:
createBillOfMaterialsImportJobRequest- AConsumerthat will call methods onCreateBillOfMaterialsImportJobRequest.Builderto create a request. The request parameters for CreateBillOfMaterialsImportJob.- Returns:
- Result of the CreateBillOfMaterialsImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetBillOfMaterialsImportJobRequest.builder()- Parameters:
getBillOfMaterialsImportJobRequest- AConsumerthat will call methods onGetBillOfMaterialsImportJobRequest.Builderto create a request. The request parameters for GetBillOfMaterialsImportJob.- Returns:
- Result of the GetBillOfMaterialsImportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaSendDataIntegrationEventRequest.builder()- Parameters:
sendDataIntegrationEventRequest- AConsumerthat will call methods onSendDataIntegrationEventRequest.Builderto create a request. The request parameters for SendDataIntegrationEvent.- Returns:
- Result of the SendDataIntegrationEvent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static SupplyChainClient create()
Create aSupplyChainClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SupplyChainClientBuilder builder()
Create a builder that can be used to configure and create aSupplyChainClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SupplyChainServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-