com.amazonaws.services.supplychain

Interface AWSSupplyChain

All Known Subinterfaces:

AWSSupplyChainAsync

All Known Implementing Classes:

AbstractAWSSupplyChain, AbstractAWSSupplyChainAsync, AWSSupplyChainAsyncClient, AWSSupplyChainClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSupplyChain

Interface for accessing AWS Supply Chain.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSupplyChain instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateBillOfMaterialsImportJobResult	createBillOfMaterialsImportJob(CreateBillOfMaterialsImportJobRequest createBillOfMaterialsImportJobRequest) CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.
GetBillOfMaterialsImportJobResult	getBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest getBillOfMaterialsImportJobRequest) 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.
SendDataIntegrationEventResult	sendDataIntegrationEvent(SendDataIntegrationEventRequest sendDataIntegrationEventRequest) Send transactional data events with real-time data for analysis or monitoring.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createBillOfMaterialsImportJob

CreateBillOfMaterialsImportJobResult 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:

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

GetBillOfMaterialsImportJobResult getBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest getBillOfMaterialsImportJobRequest)

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.

See Also:

AWS API Documentation

sendDataIntegrationEvent

SendDataIntegrationEventResult sendDataIntegrationEvent(SendDataIntegrationEventRequest sendDataIntegrationEventRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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