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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic 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.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.createDataIntegrationFlow(Consumer<CreateDataIntegrationFlowRequest.Builder> createDataIntegrationFlowRequest) Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.createDataIntegrationFlow(CreateDataIntegrationFlowRequest createDataIntegrationFlowRequest) Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.default CreateDataLakeDatasetResponsecreateDataLakeDataset(Consumer<CreateDataLakeDatasetRequest.Builder> createDataLakeDatasetRequest) Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset.default CreateDataLakeDatasetResponsecreateDataLakeDataset(CreateDataLakeDatasetRequest createDataLakeDatasetRequest) Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset.default CreateInstanceResponsecreateInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.default CreateInstanceResponsecreateInstance(CreateInstanceRequest createInstanceRequest) Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.deleteDataIntegrationFlow(Consumer<DeleteDataIntegrationFlowRequest.Builder> deleteDataIntegrationFlowRequest) Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.deleteDataIntegrationFlow(DeleteDataIntegrationFlowRequest deleteDataIntegrationFlowRequest) Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.default DeleteDataLakeDatasetResponsedeleteDataLakeDataset(Consumer<DeleteDataLakeDatasetRequest.Builder> deleteDataLakeDatasetRequest) Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset.default DeleteDataLakeDatasetResponsedeleteDataLakeDataset(DeleteDataLakeDatasetRequest deleteDataLakeDatasetRequest) Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset.default DeleteInstanceResponsedeleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.default DeleteInstanceResponsedeleteInstance(DeleteInstanceRequest deleteInstanceRequest) Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.getBillOfMaterialsImportJob(Consumer<GetBillOfMaterialsImportJobRequest.Builder> getBillOfMaterialsImportJobRequest) Get status and details of a BillOfMaterialsImportJob.getBillOfMaterialsImportJob(GetBillOfMaterialsImportJobRequest getBillOfMaterialsImportJobRequest) Get status and details of a BillOfMaterialsImportJob.default GetDataIntegrationFlowResponsegetDataIntegrationFlow(Consumer<GetDataIntegrationFlowRequest.Builder> getDataIntegrationFlowRequest) Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.default GetDataIntegrationFlowResponsegetDataIntegrationFlow(GetDataIntegrationFlowRequest getDataIntegrationFlowRequest) Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.default GetDataLakeDatasetResponsegetDataLakeDataset(Consumer<GetDataLakeDatasetRequest.Builder> getDataLakeDatasetRequest) Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset.default GetDataLakeDatasetResponsegetDataLakeDataset(GetDataLakeDatasetRequest getDataLakeDatasetRequest) Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset.default GetInstanceResponsegetInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest) Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.default GetInstanceResponsegetInstance(GetInstanceRequest getInstanceRequest) Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.default ListDataIntegrationFlowsResponselistDataIntegrationFlows(Consumer<ListDataIntegrationFlowsRequest.Builder> listDataIntegrationFlowsRequest) Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.default ListDataIntegrationFlowsResponselistDataIntegrationFlows(ListDataIntegrationFlowsRequest listDataIntegrationFlowsRequest) Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.default ListDataIntegrationFlowsIterablelistDataIntegrationFlowsPaginator(Consumer<ListDataIntegrationFlowsRequest.Builder> listDataIntegrationFlowsRequest) This is a variant oflistDataIntegrationFlows(software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsRequest)operation.default ListDataIntegrationFlowsIterablelistDataIntegrationFlowsPaginator(ListDataIntegrationFlowsRequest listDataIntegrationFlowsRequest) This is a variant oflistDataIntegrationFlows(software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsRequest)operation.default ListDataLakeDatasetsResponselistDataLakeDatasets(Consumer<ListDataLakeDatasetsRequest.Builder> listDataLakeDatasetsRequest) Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets.default ListDataLakeDatasetsResponselistDataLakeDatasets(ListDataLakeDatasetsRequest listDataLakeDatasetsRequest) Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets.default ListDataLakeDatasetsIterablelistDataLakeDatasetsPaginator(Consumer<ListDataLakeDatasetsRequest.Builder> listDataLakeDatasetsRequest) This is a variant oflistDataLakeDatasets(software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsRequest)operation.default ListDataLakeDatasetsIterablelistDataLakeDatasetsPaginator(ListDataLakeDatasetsRequest listDataLakeDatasetsRequest) This is a variant oflistDataLakeDatasets(software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsRequest)operation.default ListInstancesResponselistInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest) List all Amazon Web Services Supply Chain instances for a specific account.default ListInstancesResponselistInstances(ListInstancesRequest listInstancesRequest) List all Amazon Web Services Supply Chain instances for a specific account.default ListInstancesIterablelistInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) This is a variant oflistInstances(software.amazon.awssdk.services.supplychain.model.ListInstancesRequest)operation.default ListInstancesIterablelistInstancesPaginator(ListInstancesRequest listInstancesRequest) This is a variant oflistInstances(software.amazon.awssdk.services.supplychain.model.ListInstancesRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all the tags for an Amazon Web ServicesSupply Chain resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all the tags for an Amazon Web ServicesSupply Chain resource.default SendDataIntegrationEventResponsesendDataIntegrationEvent(Consumer<SendDataIntegrationEventRequest.Builder> sendDataIntegrationEventRequest) Send the transactional data payload for the event with real-time data for analysis or monitoring.default SendDataIntegrationEventResponsesendDataIntegrationEvent(SendDataIntegrationEventRequest sendDataIntegrationEventRequest) Send the transactional data payload for the event with real-time data for analysis or monitoring.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain.updateDataIntegrationFlow(Consumer<UpdateDataIntegrationFlowRequest.Builder> updateDataIntegrationFlowRequest) Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.updateDataIntegrationFlow(UpdateDataIntegrationFlowRequest updateDataIntegrationFlowRequest) Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.default UpdateDataLakeDatasetResponseupdateDataLakeDataset(Consumer<UpdateDataLakeDatasetRequest.Builder> updateDataLakeDatasetRequest) Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset.default UpdateDataLakeDatasetResponseupdateDataLakeDataset(UpdateDataLakeDatasetRequest updateDataLakeDatasetRequest) Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset.default UpdateInstanceResponseupdateInstance(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.default UpdateInstanceResponseupdateInstance(UpdateInstanceRequest updateInstanceRequest) Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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.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.
- See Also:
-
createDataIntegrationFlow
default CreateDataIntegrationFlowResponse createDataIntegrationFlow(CreateDataIntegrationFlowRequest createDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
- Parameters:
createDataIntegrationFlowRequest- The request parameters for CreateDataIntegrationFlow.- Returns:
- Result of the CreateDataIntegrationFlow operation returned by the service.
- See Also:
-
createDataIntegrationFlow
default CreateDataIntegrationFlowResponse createDataIntegrationFlow(Consumer<CreateDataIntegrationFlowRequest.Builder> createDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
This is a convenience which creates an instance of the
CreateDataIntegrationFlowRequest.Builderavoiding the need to create one manually viaCreateDataIntegrationFlowRequest.builder()- Parameters:
createDataIntegrationFlowRequest- AConsumerthat will call methods onCreateDataIntegrationFlowRequest.Builderto create a request. The request parameters for CreateDataIntegrationFlow.- Returns:
- Result of the CreateDataIntegrationFlow operation returned by the service.
- See Also:
-
createDataLakeDataset
default CreateDataLakeDatasetResponse createDataLakeDataset(CreateDataLakeDatasetRequest createDataLakeDatasetRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.
- Parameters:
createDataLakeDatasetRequest- The request parameters for CreateDataLakeDataset.- Returns:
- Result of the CreateDataLakeDataset operation returned by the service.
- See Also:
-
createDataLakeDataset
default CreateDataLakeDatasetResponse createDataLakeDataset(Consumer<CreateDataLakeDatasetRequest.Builder> createDataLakeDatasetRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.
This is a convenience which creates an instance of the
CreateDataLakeDatasetRequest.Builderavoiding the need to create one manually viaCreateDataLakeDatasetRequest.builder()- Parameters:
createDataLakeDatasetRequest- AConsumerthat will call methods onCreateDataLakeDatasetRequest.Builderto create a request. The request parameters for CreateDataLakeDataset.- Returns:
- Result of the CreateDataLakeDataset operation returned by the service.
- See Also:
-
createInstance
default CreateInstanceResponse createInstance(CreateInstanceRequest createInstanceRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.
- Parameters:
createInstanceRequest- The request parameters for CreateInstance.- Returns:
- Result of the CreateInstance operation returned by the service.
- See Also:
-
createInstance
default CreateInstanceResponse createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.
This is a convenience which creates an instance of the
CreateInstanceRequest.Builderavoiding the need to create one manually viaCreateInstanceRequest.builder()- Parameters:
createInstanceRequest- AConsumerthat will call methods onCreateInstanceRequest.Builderto create a request. The request parameters for CreateInstance.- Returns:
- Result of the CreateInstance operation returned by the service.
- See Also:
-
deleteDataIntegrationFlow
default DeleteDataIntegrationFlowResponse deleteDataIntegrationFlow(DeleteDataIntegrationFlowRequest deleteDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
- Parameters:
deleteDataIntegrationFlowRequest- The request parameters for DeleteDataIntegrationFlow.- Returns:
- Result of the DeleteDataIntegrationFlow operation returned by the service.
- See Also:
-
deleteDataIntegrationFlow
default DeleteDataIntegrationFlowResponse deleteDataIntegrationFlow(Consumer<DeleteDataIntegrationFlowRequest.Builder> deleteDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
This is a convenience which creates an instance of the
DeleteDataIntegrationFlowRequest.Builderavoiding the need to create one manually viaDeleteDataIntegrationFlowRequest.builder()- Parameters:
deleteDataIntegrationFlowRequest- AConsumerthat will call methods onDeleteDataIntegrationFlowRequest.Builderto create a request. The request parameters for DeleteDataIntegrationFlow.- Returns:
- Result of the DeleteDataIntegrationFlow operation returned by the service.
- See Also:
-
deleteDataLakeDataset
default DeleteDataLakeDatasetResponse deleteDataLakeDataset(DeleteDataLakeDatasetRequest deleteDataLakeDatasetRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name.
- Parameters:
deleteDataLakeDatasetRequest- The request parameters of DeleteDataLakeDataset.- Returns:
- Result of the DeleteDataLakeDataset operation returned by the service.
- See Also:
-
deleteDataLakeDataset
default DeleteDataLakeDatasetResponse deleteDataLakeDataset(Consumer<DeleteDataLakeDatasetRequest.Builder> deleteDataLakeDatasetRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name.
This is a convenience which creates an instance of the
DeleteDataLakeDatasetRequest.Builderavoiding the need to create one manually viaDeleteDataLakeDatasetRequest.builder()- Parameters:
deleteDataLakeDatasetRequest- AConsumerthat will call methods onDeleteDataLakeDatasetRequest.Builderto create a request. The request parameters of DeleteDataLakeDataset.- Returns:
- Result of the DeleteDataLakeDataset operation returned by the service.
- See Also:
-
deleteInstance
default DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a DeleteInstance request, Amazon Web Services Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.
- Parameters:
deleteInstanceRequest- The request parameters for DeleteInstance.- Returns:
- Result of the DeleteInstance operation returned by the service.
- See Also:
-
deleteInstance
default DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a DeleteInstance request, Amazon Web Services Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.
This is a convenience which creates an instance of the
DeleteInstanceRequest.Builderavoiding the need to create one manually viaDeleteInstanceRequest.builder()- Parameters:
deleteInstanceRequest- AConsumerthat will call methods onDeleteInstanceRequest.Builderto create a request. The request parameters for DeleteInstance.- Returns:
- Result of the DeleteInstance 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.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.
- See Also:
-
getDataIntegrationFlow
default GetDataIntegrationFlowResponse getDataIntegrationFlow(GetDataIntegrationFlowRequest getDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
- Parameters:
getDataIntegrationFlowRequest- The request parameters for GetDataIntegrationFlow.- Returns:
- Result of the GetDataIntegrationFlow operation returned by the service.
- See Also:
-
getDataIntegrationFlow
default GetDataIntegrationFlowResponse getDataIntegrationFlow(Consumer<GetDataIntegrationFlowRequest.Builder> getDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
This is a convenience which creates an instance of the
GetDataIntegrationFlowRequest.Builderavoiding the need to create one manually viaGetDataIntegrationFlowRequest.builder()- Parameters:
getDataIntegrationFlowRequest- AConsumerthat will call methods onGetDataIntegrationFlowRequest.Builderto create a request. The request parameters for GetDataIntegrationFlow.- Returns:
- Result of the GetDataIntegrationFlow operation returned by the service.
- See Also:
-
getDataLakeDataset
default GetDataLakeDatasetResponse getDataLakeDataset(GetDataLakeDatasetRequest getDataLakeDatasetRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name.
- Parameters:
getDataLakeDatasetRequest- The request parameters for GetDataLakeDataset.- Returns:
- Result of the GetDataLakeDataset operation returned by the service.
- See Also:
-
getDataLakeDataset
default GetDataLakeDatasetResponse getDataLakeDataset(Consumer<GetDataLakeDatasetRequest.Builder> getDataLakeDatasetRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name.
This is a convenience which creates an instance of the
GetDataLakeDatasetRequest.Builderavoiding the need to create one manually viaGetDataLakeDatasetRequest.builder()- Parameters:
getDataLakeDatasetRequest- AConsumerthat will call methods onGetDataLakeDatasetRequest.Builderto create a request. The request parameters for GetDataLakeDataset.- Returns:
- Result of the GetDataLakeDataset operation returned by the service.
- See Also:
-
getInstance
default GetInstanceResponse getInstance(GetInstanceRequest getInstanceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
- Parameters:
getInstanceRequest- The request parameters for GetInstance.- Returns:
- Result of the GetInstance operation returned by the service.
- See Also:
-
getInstance
default GetInstanceResponse getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
This is a convenience which creates an instance of the
GetInstanceRequest.Builderavoiding the need to create one manually viaGetInstanceRequest.builder()- Parameters:
getInstanceRequest- AConsumerthat will call methods onGetInstanceRequest.Builderto create a request. The request parameters for GetInstance.- Returns:
- Result of the GetInstance operation returned by the service.
- See Also:
-
listDataIntegrationFlows
default ListDataIntegrationFlowsResponse listDataIntegrationFlows(ListDataIntegrationFlowsRequest listDataIntegrationFlowsRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
- Parameters:
listDataIntegrationFlowsRequest- The request parameters for ListDataIntegrationFlows.- Returns:
- Result of the ListDataIntegrationFlows operation returned by the service.
- See Also:
-
listDataIntegrationFlows
default ListDataIntegrationFlowsResponse listDataIntegrationFlows(Consumer<ListDataIntegrationFlowsRequest.Builder> listDataIntegrationFlowsRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
This is a convenience which creates an instance of the
ListDataIntegrationFlowsRequest.Builderavoiding the need to create one manually viaListDataIntegrationFlowsRequest.builder()- Parameters:
listDataIntegrationFlowsRequest- AConsumerthat will call methods onListDataIntegrationFlowsRequest.Builderto create a request. The request parameters for ListDataIntegrationFlows.- Returns:
- Result of the ListDataIntegrationFlows operation returned by the service.
- See Also:
-
listDataIntegrationFlowsPaginator
default ListDataIntegrationFlowsIterable listDataIntegrationFlowsPaginator(ListDataIntegrationFlowsRequest listDataIntegrationFlowsRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException This is a variant of
listDataIntegrationFlows(software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.supplychain.paginators.ListDataIntegrationFlowsIterable responses = client.listDataIntegrationFlowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.supplychain.paginators.ListDataIntegrationFlowsIterable responses = client .listDataIntegrationFlowsPaginator(request); for (software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.supplychain.paginators.ListDataIntegrationFlowsIterable responses = client.listDataIntegrationFlowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataIntegrationFlows(software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsRequest)operation.- Parameters:
listDataIntegrationFlowsRequest- The request parameters for ListDataIntegrationFlows.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataIntegrationFlowsPaginator
default ListDataIntegrationFlowsIterable listDataIntegrationFlowsPaginator(Consumer<ListDataIntegrationFlowsRequest.Builder> listDataIntegrationFlowsRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException This is a variant of
listDataIntegrationFlows(software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.supplychain.paginators.ListDataIntegrationFlowsIterable responses = client.listDataIntegrationFlowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.supplychain.paginators.ListDataIntegrationFlowsIterable responses = client .listDataIntegrationFlowsPaginator(request); for (software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.supplychain.paginators.ListDataIntegrationFlowsIterable responses = client.listDataIntegrationFlowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataIntegrationFlows(software.amazon.awssdk.services.supplychain.model.ListDataIntegrationFlowsRequest)operation.
This is a convenience which creates an instance of the
ListDataIntegrationFlowsRequest.Builderavoiding the need to create one manually viaListDataIntegrationFlowsRequest.builder()- Parameters:
listDataIntegrationFlowsRequest- AConsumerthat will call methods onListDataIntegrationFlowsRequest.Builderto create a request. The request parameters for ListDataIntegrationFlows.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataLakeDatasets
default ListDataLakeDatasetsResponse listDataLakeDatasets(ListDataLakeDatasetsRequest listDataLakeDatasetsRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.
- Parameters:
listDataLakeDatasetsRequest- The request parameters of ListDataLakeDatasets.- Returns:
- Result of the ListDataLakeDatasets operation returned by the service.
- See Also:
-
listDataLakeDatasets
default ListDataLakeDatasetsResponse listDataLakeDatasets(Consumer<ListDataLakeDatasetsRequest.Builder> listDataLakeDatasetsRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.
This is a convenience which creates an instance of the
ListDataLakeDatasetsRequest.Builderavoiding the need to create one manually viaListDataLakeDatasetsRequest.builder()- Parameters:
listDataLakeDatasetsRequest- AConsumerthat will call methods onListDataLakeDatasetsRequest.Builderto create a request. The request parameters of ListDataLakeDatasets.- Returns:
- Result of the ListDataLakeDatasets operation returned by the service.
- See Also:
-
listDataLakeDatasetsPaginator
default ListDataLakeDatasetsIterable listDataLakeDatasetsPaginator(ListDataLakeDatasetsRequest listDataLakeDatasetsRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException This is a variant of
listDataLakeDatasets(software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.supplychain.paginators.ListDataLakeDatasetsIterable responses = client.listDataLakeDatasetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.supplychain.paginators.ListDataLakeDatasetsIterable responses = client .listDataLakeDatasetsPaginator(request); for (software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.supplychain.paginators.ListDataLakeDatasetsIterable responses = client.listDataLakeDatasetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataLakeDatasets(software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsRequest)operation.- Parameters:
listDataLakeDatasetsRequest- The request parameters of ListDataLakeDatasets.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataLakeDatasetsPaginator
default ListDataLakeDatasetsIterable listDataLakeDatasetsPaginator(Consumer<ListDataLakeDatasetsRequest.Builder> listDataLakeDatasetsRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException This is a variant of
listDataLakeDatasets(software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.supplychain.paginators.ListDataLakeDatasetsIterable responses = client.listDataLakeDatasetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.supplychain.paginators.ListDataLakeDatasetsIterable responses = client .listDataLakeDatasetsPaginator(request); for (software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.supplychain.paginators.ListDataLakeDatasetsIterable responses = client.listDataLakeDatasetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataLakeDatasets(software.amazon.awssdk.services.supplychain.model.ListDataLakeDatasetsRequest)operation.
This is a convenience which creates an instance of the
ListDataLakeDatasetsRequest.Builderavoiding the need to create one manually viaListDataLakeDatasetsRequest.builder()- Parameters:
listDataLakeDatasetsRequest- AConsumerthat will call methods onListDataLakeDatasetsRequest.Builderto create a request. The request parameters of ListDataLakeDatasets.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInstances
default ListInstancesResponse listInstances(ListInstancesRequest listInstancesRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete).
- Parameters:
listInstancesRequest- The request parameters for ListInstances.- Returns:
- Result of the ListInstances operation returned by the service.
- See Also:
-
listInstances
default ListInstancesResponse listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete).
This is a convenience which creates an instance of the
ListInstancesRequest.Builderavoiding the need to create one manually viaListInstancesRequest.builder()- Parameters:
listInstancesRequest- AConsumerthat will call methods onListInstancesRequest.Builderto create a request. The request parameters for ListInstances.- Returns:
- Result of the ListInstances operation returned by the service.
- See Also:
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(ListInstancesRequest listInstancesRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException This is a variant of
listInstances(software.amazon.awssdk.services.supplychain.model.ListInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.supplychain.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.supplychain.paginators.ListInstancesIterable responses = client .listInstancesPaginator(request); for (software.amazon.awssdk.services.supplychain.model.ListInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.supplychain.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.supplychain.model.ListInstancesRequest)operation.- Parameters:
listInstancesRequest- The request parameters for ListInstances.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws ServiceQuotaExceededException, ThrottlingException, ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException This is a variant of
listInstances(software.amazon.awssdk.services.supplychain.model.ListInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.supplychain.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.supplychain.paginators.ListInstancesIterable responses = client .listInstancesPaginator(request); for (software.amazon.awssdk.services.supplychain.model.ListInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.supplychain.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.supplychain.model.ListInstancesRequest)operation.
This is a convenience which creates an instance of the
ListInstancesRequest.Builderavoiding the need to create one manually viaListInstancesRequest.builder()- Parameters:
listInstancesRequest- AConsumerthat will call methods onListInstancesRequest.Builderto create a request. The request parameters for ListInstances.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException List all the tags for an Amazon Web ServicesSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the tag level information on a resource and perform actions such as, deleting a resource associated with a particular tag.
- Parameters:
listTagsForResourceRequest- The request parameters of ListTagsForResource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException List all the tags for an Amazon Web ServicesSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the tag level information on a resource and perform actions such as, deleting a resource associated with a particular tag.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. The request parameters of ListTagsForResource.- Returns:
- Result of the ListTagsForResource 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 the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
- 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 the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
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.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you can add tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. You can use these tags to identify a group of resources or a single resource used by the developer.
- Parameters:
tagResourceRequest- The request parameters of TagResource.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you can add tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. You can use these tags to identify a group of resources or a single resource used by the developer.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request. The request parameters of TagResource.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets.
- Parameters:
untagResourceRequest- The request parameters of UntagResource.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request. The request parameters of UntagResource.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateDataIntegrationFlow
default UpdateDataIntegrationFlowResponse updateDataIntegrationFlow(UpdateDataIntegrationFlowRequest updateDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
- Parameters:
updateDataIntegrationFlowRequest- The request parameters for UpdateDataIntegrationFlow.- Returns:
- Result of the UpdateDataIntegrationFlow operation returned by the service.
- See Also:
-
updateDataIntegrationFlow
default UpdateDataIntegrationFlowResponse updateDataIntegrationFlow(Consumer<UpdateDataIntegrationFlowRequest.Builder> updateDataIntegrationFlowRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
This is a convenience which creates an instance of the
UpdateDataIntegrationFlowRequest.Builderavoiding the need to create one manually viaUpdateDataIntegrationFlowRequest.builder()- Parameters:
updateDataIntegrationFlowRequest- AConsumerthat will call methods onUpdateDataIntegrationFlowRequest.Builderto create a request. The request parameters for UpdateDataIntegrationFlow.- Returns:
- Result of the UpdateDataIntegrationFlow operation returned by the service.
- See Also:
-
updateDataLakeDataset
default UpdateDataLakeDatasetResponse updateDataLakeDataset(UpdateDataLakeDatasetRequest updateDataLakeDatasetRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.
- Parameters:
updateDataLakeDatasetRequest- The request parameters of UpdateDataLakeDataset.- Returns:
- Result of the UpdateDataLakeDataset operation returned by the service.
- See Also:
-
updateDataLakeDataset
default UpdateDataLakeDatasetResponse updateDataLakeDataset(Consumer<UpdateDataLakeDatasetRequest.Builder> updateDataLakeDatasetRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.
This is a convenience which creates an instance of the
UpdateDataLakeDatasetRequest.Builderavoiding the need to create one manually viaUpdateDataLakeDatasetRequest.builder()- Parameters:
updateDataLakeDatasetRequest- AConsumerthat will call methods onUpdateDataLakeDatasetRequest.Builderto create a request. The request parameters of UpdateDataLakeDataset.- Returns:
- Result of the UpdateDataLakeDataset operation returned by the service.
- See Also:
-
updateInstance
default UpdateInstanceResponse updateInstance(UpdateInstanceRequest updateInstanceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.
- Parameters:
updateInstanceRequest- The request parameters for UpdateInstance.- Returns:
- Result of the UpdateInstance operation returned by the service.
- See Also:
-
updateInstance
default UpdateInstanceResponse updateInstance(Consumer<UpdateInstanceRequest.Builder> updateInstanceRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, SupplyChainException Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.
This is a convenience which creates an instance of the
UpdateInstanceRequest.Builderavoiding the need to create one manually viaUpdateInstanceRequest.builder()- Parameters:
updateInstanceRequest- AConsumerthat will call methods onUpdateInstanceRequest.Builderto create a request. The request parameters for UpdateInstance.- Returns:
- Result of the UpdateInstance operation returned by the service.
- See Also:
-
create
Create aSupplyChainClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aSupplyChainClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-