com.amazonaws.services.supplychain

Class AWSSupplyChainClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.supplychain.AWSSupplyChainClient

All Implemented Interfaces:

AWSSupplyChain

Direct Known Subclasses:

AWSSupplyChainAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSupplyChainClient
extends AmazonWebServiceClient
implements AWSSupplyChain

Client for accessing AWS Supply Chain. All service calls made using this client are blocking, and will not return until the service call completes.

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 and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.supplychain.AWSSupplyChain

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSupplyChainClientBuilder	builder()
CreateBillOfMaterialsImportJobResult	createBillOfMaterialsImportJob(CreateBillOfMaterialsImportJobRequest request) CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.
GetBillOfMaterialsImportJobResult	getBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest request) Get status and details of a BillOfMaterialsImportJob.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSSupplyChainClientBuilder builder()

createBillOfMaterialsImportJob

public CreateBillOfMaterialsImportJobResult createBillOfMaterialsImportJob(CreateBillOfMaterialsImportJobRequest request)

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.

Specified by:

createBillOfMaterialsImportJob in interface AWSSupplyChain

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.

See Also:

AWS API Documentation

getBillOfMaterialsImportJob

public GetBillOfMaterialsImportJobResult getBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest request)

Get status and details of a BillOfMaterialsImportJob.

Specified by:

getBillOfMaterialsImportJob in interface AWSSupplyChain

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSSupplyChain

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSSupplyChain

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSupplyChain

Overrides:

shutdown in class AmazonWebServiceClient