supplychain/aws.sdk.kotlin.services.supplychain

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createBillOfMaterialsImportJob

inline suspend fun SupplyChainClient.createBillOfMaterialsImportJob(crossinline block: CreateBillOfMaterialsImportJobRequest.Builder.() -> Unit): CreateBillOfMaterialsImportJobResponse

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.

createDataIntegrationFlow

inline suspend fun SupplyChainClient.createDataIntegrationFlow(crossinline block: CreateDataIntegrationFlowRequest.Builder.() -> Unit): CreateDataIntegrationFlowResponse

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.

createDataLakeDataset

inline suspend fun SupplyChainClient.createDataLakeDataset(crossinline block: CreateDataLakeDatasetRequest.Builder.() -> Unit): CreateDataLakeDatasetResponse

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.

createDataLakeNamespace

inline suspend fun SupplyChainClient.createDataLakeNamespace(crossinline block: CreateDataLakeNamespaceRequest.Builder.() -> Unit): CreateDataLakeNamespaceResponse

Enables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.

createInstance

inline suspend fun SupplyChainClient.createInstance(crossinline block: CreateInstanceRequest.Builder.() -> Unit): CreateInstanceResponse

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

inline suspend fun SupplyChainClient.deleteDataIntegrationFlow(crossinline block: DeleteDataIntegrationFlowRequest.Builder.() -> Unit): DeleteDataIntegrationFlowResponse

Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.

deleteDataLakeDataset

inline suspend fun SupplyChainClient.deleteDataLakeDataset(crossinline block: DeleteDataLakeDatasetRequest.Builder.() -> Unit): DeleteDataLakeDatasetResponse

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.

deleteDataLakeNamespace

inline suspend fun SupplyChainClient.deleteDataLakeNamespace(crossinline block: DeleteDataLakeNamespaceRequest.Builder.() -> Unit): DeleteDataLakeNamespaceResponse

Enables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name.

deleteInstance

inline suspend fun SupplyChainClient.deleteInstance(crossinline block: DeleteInstanceRequest.Builder.() -> Unit): DeleteInstanceResponse

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

inline suspend fun SupplyChainClient.getBillOfMaterialsImportJob(crossinline block: GetBillOfMaterialsImportJobRequest.Builder.() -> Unit): GetBillOfMaterialsImportJobResponse

Get status and details of a BillOfMaterialsImportJob.

getDataIntegrationEvent

inline suspend fun SupplyChainClient.getDataIntegrationEvent(crossinline block: GetDataIntegrationEventRequest.Builder.() -> Unit): GetDataIntegrationEventResponse

Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.

getDataIntegrationFlow

inline suspend fun SupplyChainClient.getDataIntegrationFlow(crossinline block: GetDataIntegrationFlowRequest.Builder.() -> Unit): GetDataIntegrationFlowResponse

Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.

getDataIntegrationFlowExecution

inline suspend fun SupplyChainClient.getDataIntegrationFlowExecution(crossinline block: GetDataIntegrationFlowExecutionRequest.Builder.() -> Unit): GetDataIntegrationFlowExecutionResponse

Get the flow execution.

getDataLakeDataset

inline suspend fun SupplyChainClient.getDataLakeDataset(crossinline block: GetDataLakeDatasetRequest.Builder.() -> Unit): GetDataLakeDatasetResponse

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.

getDataLakeNamespace

inline suspend fun SupplyChainClient.getDataLakeNamespace(crossinline block: GetDataLakeNamespaceRequest.Builder.() -> Unit): GetDataLakeNamespaceResponse

Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.

getInstance

inline suspend fun SupplyChainClient.getInstance(crossinline block: GetInstanceRequest.Builder.() -> Unit): GetInstanceResponse

Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.

listDataIntegrationEvents

inline suspend fun SupplyChainClient.listDataIntegrationEvents(crossinline block: ListDataIntegrationEventsRequest.Builder.() -> Unit): ListDataIntegrationEventsResponse

Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.

listDataIntegrationFlowExecutions

inline suspend fun SupplyChainClient.listDataIntegrationFlowExecutions(crossinline block: ListDataIntegrationFlowExecutionsRequest.Builder.() -> Unit): ListDataIntegrationFlowExecutionsResponse

List flow executions.

listDataIntegrationFlows

inline suspend fun SupplyChainClient.listDataIntegrationFlows(crossinline block: ListDataIntegrationFlowsRequest.Builder.() -> Unit): ListDataIntegrationFlowsResponse

Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.

listDataLakeDatasets

inline suspend fun SupplyChainClient.listDataLakeDatasets(crossinline block: ListDataLakeDatasetsRequest.Builder.() -> Unit): ListDataLakeDatasetsResponse

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.

listDataLakeNamespaces

inline suspend fun SupplyChainClient.listDataLakeNamespaces(crossinline block: ListDataLakeNamespacesRequest.Builder.() -> Unit): ListDataLakeNamespacesResponse

Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included.

listInstances

inline suspend fun SupplyChainClient.listInstances(crossinline block: ListInstancesRequest.Builder.() -> Unit): ListInstancesResponse

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).

listTagsForResource

inline suspend fun SupplyChainClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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.

sendDataIntegrationEvent

inline suspend fun SupplyChainClient.sendDataIntegrationEvent(crossinline block: SendDataIntegrationEventRequest.Builder.() -> Unit): SendDataIntegrationEventResponse

Send the 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.

tagResource

inline suspend fun SupplyChainClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun SupplyChainClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

updateDataIntegrationFlow

inline suspend fun SupplyChainClient.updateDataIntegrationFlow(crossinline block: UpdateDataIntegrationFlowRequest.Builder.() -> Unit): UpdateDataIntegrationFlowResponse

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.

updateDataLakeDataset

inline suspend fun SupplyChainClient.updateDataLakeDataset(crossinline block: UpdateDataLakeDatasetRequest.Builder.() -> Unit): UpdateDataLakeDatasetResponse

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.

updateDataLakeNamespace

inline suspend fun SupplyChainClient.updateDataLakeNamespace(crossinline block: UpdateDataLakeNamespaceRequest.Builder.() -> Unit): UpdateDataLakeNamespaceResponse

Enables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name.

updateInstance

inline suspend fun SupplyChainClient.updateInstance(crossinline block: UpdateInstanceRequest.Builder.() -> Unit): UpdateInstanceResponse

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.

withConfig

fun SupplyChainClient.withConfig(block: SupplyChainClient.Config.Builder.() -> Unit): SupplyChainClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.