Class: Aws::SupplyChain::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SupplyChain::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb
Overview
An API client for SupplyChain. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SupplyChain::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_bill_of_materials_import_job(params = {}) ⇒ Types::CreateBillOfMaterialsImportJobResponse
CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.
-
#create_data_integration_flow(params = {}) ⇒ Types::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.
-
#create_data_lake_dataset(params = {}) ⇒ Types::CreateDataLakeDatasetResponse
Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset.
-
#create_data_lake_namespace(params = {}) ⇒ Types::CreateDataLakeNamespaceResponse
Enables you to programmatically create an Amazon Web Services Supply Chain data lake namespace.
-
#create_instance(params = {}) ⇒ Types::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.
-
#delete_data_integration_flow(params = {}) ⇒ Types::DeleteDataIntegrationFlowResponse
Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
-
#delete_data_lake_dataset(params = {}) ⇒ Types::DeleteDataLakeDatasetResponse
Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset.
-
#delete_data_lake_namespace(params = {}) ⇒ Types::DeleteDataLakeNamespaceResponse
Enables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets.
-
#delete_instance(params = {}) ⇒ Types::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.
-
#get_bill_of_materials_import_job(params = {}) ⇒ Types::GetBillOfMaterialsImportJobResponse
Get status and details of a BillOfMaterialsImportJob.
-
#get_data_integration_event(params = {}) ⇒ Types::GetDataIntegrationEventResponse
Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event.
-
#get_data_integration_flow(params = {}) ⇒ Types::GetDataIntegrationFlowResponse
Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
-
#get_data_integration_flow_execution(params = {}) ⇒ Types::GetDataIntegrationFlowExecutionResponse
Get the flow execution.
-
#get_data_lake_dataset(params = {}) ⇒ Types::GetDataLakeDatasetResponse
Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset.
-
#get_data_lake_namespace(params = {}) ⇒ Types::GetDataLakeNamespaceResponse
Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace.
-
#get_instance(params = {}) ⇒ Types::GetInstanceResponse
Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
-
#list_data_integration_events(params = {}) ⇒ Types::ListDataIntegrationEventsResponse
Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.
-
#list_data_integration_flow_executions(params = {}) ⇒ Types::ListDataIntegrationFlowExecutionsResponse
List flow executions.
-
#list_data_integration_flows(params = {}) ⇒ Types::ListDataIntegrationFlowsResponse
Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
-
#list_data_lake_datasets(params = {}) ⇒ Types::ListDataLakeDatasetsResponse
Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets.
-
#list_data_lake_namespaces(params = {}) ⇒ Types::ListDataLakeNamespacesResponse
Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces.
-
#list_instances(params = {}) ⇒ Types::ListInstancesResponse
List all Amazon Web Services Supply Chain instances for a specific account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all the tags for an Amazon Web ServicesSupply Chain resource.
-
#send_data_integration_event(params = {}) ⇒ Types::SendDataIntegrationEventResponse
Send the data payload for the event with real-time data for analysis or monitoring.
-
#tag_resource(params = {}) ⇒ Struct
You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain.
-
#untag_resource(params = {}) ⇒ Struct
You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain.
-
#update_data_integration_flow(params = {}) ⇒ Types::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.
-
#update_data_lake_dataset(params = {}) ⇒ Types::UpdateDataLakeDatasetResponse
Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset.
-
#update_data_lake_namespace(params = {}) ⇒ Types::UpdateDataLakeNamespaceResponse
Enables you to programmatically update an Amazon Web Services Supply Chain data lake namespace.
-
#update_instance(params = {}) ⇒ Types::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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#create_bill_of_materials_import_job(params = {}) ⇒ Types::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.
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.
542 543 544 545 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 542 def create_bill_of_materials_import_job(params = {}, = {}) req = build_request(:create_bill_of_materials_import_job, params) req.send_request() end |
#create_data_integration_flow(params = {}) ⇒ Types::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.
758 759 760 761 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 758 def create_data_integration_flow(params = {}, = {}) req = build_request(:create_data_integration_flow, params) req.send_request() end |
#create_data_lake_dataset(params = {}) ⇒ Types::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.
1188 1189 1190 1191 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1188 def create_data_lake_dataset(params = {}, = {}) req = build_request(:create_data_lake_dataset, params) req.send_request() end |
#create_data_lake_namespace(params = {}) ⇒ Types::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.
1264 1265 1266 1267 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1264 def create_data_lake_namespace(params = {}, = {}) req = build_request(:create_data_lake_namespace, params) req.send_request() end |
#create_instance(params = {}) ⇒ Types::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.
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.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1390 def create_instance(params = {}, = {}) req = build_request(:create_instance, params) req.send_request() end |
#delete_data_integration_flow(params = {}) ⇒ Types::DeleteDataIntegrationFlowResponse
Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
1440 1441 1442 1443 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1440 def delete_data_integration_flow(params = {}, = {}) req = build_request(:delete_data_integration_flow, params) req.send_request() end |
#delete_data_lake_dataset(params = {}) ⇒ Types::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.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1530 def delete_data_lake_dataset(params = {}, = {}) req = build_request(:delete_data_lake_dataset, params) req.send_request() end |
#delete_data_lake_namespace(params = {}) ⇒ Types::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.
1583 1584 1585 1586 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1583 def delete_data_lake_namespace(params = {}, = {}) req = build_request(:delete_data_lake_namespace, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Types::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.
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.
1652 1653 1654 1655 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1652 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#get_bill_of_materials_import_job(params = {}) ⇒ Types::GetBillOfMaterialsImportJobResponse
Get status and details of a BillOfMaterialsImportJob.
1724 1725 1726 1727 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1724 def get_bill_of_materials_import_job(params = {}, = {}) req = build_request(:get_bill_of_materials_import_job, params) req.send_request() end |
#get_data_integration_event(params = {}) ⇒ Types::GetDataIntegrationEventResponse
Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.
1792 1793 1794 1795 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1792 def get_data_integration_event(params = {}, = {}) req = build_request(:get_data_integration_event, params) req.send_request() end |
#get_data_integration_flow(params = {}) ⇒ Types::GetDataIntegrationFlowResponse
Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
1895 1896 1897 1898 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1895 def get_data_integration_flow(params = {}, = {}) req = build_request(:get_data_integration_flow, params) req.send_request() end |
#get_data_integration_flow_execution(params = {}) ⇒ Types::GetDataIntegrationFlowExecutionResponse
Get the flow execution.
1996 1997 1998 1999 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 1996 def get_data_integration_flow_execution(params = {}, = {}) req = build_request(:get_data_integration_flow_execution, params) req.send_request() end |
#get_data_lake_dataset(params = {}) ⇒ Types::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.
2317 2318 2319 2320 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 2317 def get_data_lake_dataset(params = {}, = {}) req = build_request(:get_data_lake_dataset, params) req.send_request() end |
#get_data_lake_namespace(params = {}) ⇒ Types::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.
2407 2408 2409 2410 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 2407 def get_data_lake_namespace(params = {}, = {}) req = build_request(:get_data_lake_namespace, params) req.send_request() end |
#get_instance(params = {}) ⇒ Types::GetInstanceResponse
Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
2490 2491 2492 2493 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 2490 def get_instance(params = {}, = {}) req = build_request(:get_instance, params) req.send_request() end |
#list_data_integration_events(params = {}) ⇒ Types::ListDataIntegrationEventsResponse
Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2573 2574 2575 2576 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 2573 def list_data_integration_events(params = {}, = {}) req = build_request(:list_data_integration_events, params) req.send_request() end |
#list_data_integration_flow_executions(params = {}) ⇒ Types::ListDataIntegrationFlowExecutionsResponse
List flow executions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2659 2660 2661 2662 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 2659 def list_data_integration_flow_executions(params = {}, = {}) req = build_request(:list_data_integration_flow_executions, params) req.send_request() end |
#list_data_integration_flows(params = {}) ⇒ Types::ListDataIntegrationFlowsResponse
Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2822 2823 2824 2825 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 2822 def list_data_integration_flows(params = {}, = {}) req = build_request(:list_data_integration_flows, params) req.send_request() end |
#list_data_lake_datasets(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3175 3176 3177 3178 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 3175 def list_data_lake_datasets(params = {}, = {}) req = build_request(:list_data_lake_datasets, params) req.send_request() end |
#list_data_lake_namespaces(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3274 3275 3276 3277 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 3274 def list_data_lake_namespaces(params = {}, = {}) req = build_request(:list_data_lake_namespaces, params) req.send_request() end |
#list_instances(params = {}) ⇒ Types::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).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3441 3442 3443 3444 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 3441 def list_instances(params = {}, = {}) req = build_request(:list_instances, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::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.
3489 3490 3491 3492 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 3489 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#send_data_integration_event(params = {}) ⇒ Types::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.
3873 3874 3875 3876 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 3873 def send_data_integration_event(params = {}, = {}) req = build_request(:send_data_integration_event, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
3922 3923 3924 3925 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 3922 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
3968 3969 3970 3971 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 3968 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_data_integration_flow(params = {}) ⇒ Types::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.
4272 4273 4274 4275 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 4272 def update_data_integration_flow(params = {}, = {}) req = build_request(:update_data_integration_flow, params) req.send_request() end |
#update_data_lake_dataset(params = {}) ⇒ Types::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.
4599 4600 4601 4602 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 4599 def update_data_lake_dataset(params = {}, = {}) req = build_request(:update_data_lake_dataset, params) req.send_request() end |
#update_data_lake_namespace(params = {}) ⇒ Types::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.
4665 4666 4667 4668 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 4665 def update_data_lake_namespace(params = {}, = {}) req = build_request(:update_data_lake_namespace, params) req.send_request() end |
#update_instance(params = {}) ⇒ Types::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.
4738 4739 4740 4741 |
# File 'gems/aws-sdk-supplychain/lib/aws-sdk-supplychain/client.rb', line 4738 def update_instance(params = {}, = {}) req = build_request(:update_instance, params) req.send_request() end |