Struct Client 

pub struct Client { /* private fields */ }

Client for AWS Supply Chain

Client for invoking operations on AWS Supply Chain. Each operation on AWS Supply Chain is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_supplychain::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_supplychain::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateBillOfMaterialsImportJob operation has a Client::create_bill_of_materials_import_job, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_bill_of_materials_import_job()
    .instance_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_bill_of_materials_import_job( &self, ) -> CreateBillOfMaterialsImportJobFluentBuilder

Constructs a fluent builder for the CreateBillOfMaterialsImportJob operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • s3_uri(impl Into<String>) / set_s3_uri(Option<String>):
    required: true
    

    The S3 URI of the CSV file to be imported. The bucket must grant permissions for AWS Supply Chain to read the file.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    An idempotency token ensures the API request is only completed no more than once. This way, retrying the request will not trigger the operation multiple times. A client token is a unique, case-sensitive string of 33 to 128 ASCII characters. To make an idempotent API request, specify a client token in the request. You should not reuse the same client token for other requests. If you retry a successful request with the same client token, the request will succeed with no further actions being taken, and you will receive the same API response as the original successful request.

    
    
• On success, responds with CreateBillOfMaterialsImportJobOutput with field(s):
  • job_id(String):

    The new BillOfMaterialsImportJob identifier.

• On failure, responds with SdkError<CreateBillOfMaterialsImportJobError>

impl Client

pub fn create_data_integration_flow( &self, ) -> CreateDataIntegrationFlowFluentBuilder

Constructs a fluent builder for the CreateDataIntegrationFlow operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of the DataIntegrationFlow.

    
    
  • sources(DataIntegrationFlowSource) / set_sources(Option<Vec::<DataIntegrationFlowSource>>):
    required: true
    

    The source configurations for DataIntegrationFlow.

    
    
  • transformation(DataIntegrationFlowTransformation) / set_transformation(Option<DataIntegrationFlowTransformation>):
    required: true
    

    The transformation configurations for DataIntegrationFlow.

    
    
  • target(DataIntegrationFlowTarget) / set_target(Option<DataIntegrationFlowTarget>):
    required: true
    

    The target configurations for DataIntegrationFlow.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the DataIntegrationFlow to be created

    
    
• On success, responds with CreateDataIntegrationFlowOutput with field(s):
  • instance_id(String):

    The Amazon Web Services Supply Chain instance identifier.

  • name(String):

    The name of the DataIntegrationFlow created.

• On failure, responds with SdkError<CreateDataIntegrationFlowError>

impl Client

pub fn create_data_lake_dataset(&self) -> CreateDataLakeDatasetFluentBuilder

Constructs a fluent builder for the CreateDataLakeDataset operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:

    • asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    • default - For datasets with custom user-defined schemas.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    
    
  • schema(DataLakeDatasetSchema) / set_schema(Option<DataLakeDatasetSchema>):
    required: false
    

    The custom schema of the data lake dataset and required for dataset in default and custom namespaces.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the dataset.

    
    
  • partition_spec(DataLakeDatasetPartitionSpec) / set_partition_spec(Option<DataLakeDatasetPartitionSpec>):
    required: false
    

    The partition specification of the dataset. Partitioning can effectively improve the dataset query performance by reducing the amount of data scanned during query execution. But partitioning or not will affect how data get ingested by data ingestion methods, such as SendDataIntegrationEvent’s dataset UPSERT will upsert records within partition (instead of within whole dataset). For more details, refer to those data ingestion documentations.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the dataset.

    
    
• On success, responds with CreateDataLakeDatasetOutput with field(s):
  • dataset(Option<DataLakeDataset>):

    The detail of created dataset.

• On failure, responds with SdkError<CreateDataLakeDatasetError>

impl Client

pub fn create_data_lake_namespace(&self) -> CreateDataLakeNamespaceFluentBuilder

Constructs a fluent builder for the CreateDataLakeNamespace operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the namespace. Noted you cannot create namespace with name starting with asc, default, scn, aws, amazon, amzn

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the namespace.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags of the namespace.

    
    
• On success, responds with CreateDataLakeNamespaceOutput with field(s):
  • namespace(Option<DataLakeNamespace>):

    The detail of created namespace.

• On failure, responds with SdkError<CreateDataLakeNamespaceError>

impl Client

pub fn create_instance(&self) -> CreateInstanceFluentBuilder

Constructs a fluent builder for the CreateInstance operation.

• The fluent builder is configurable:
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: false
    

    The AWS Supply Chain instance name.

    
    
  • instance_description(impl Into<String>) / set_instance_description(Option<String>):
    required: false
    

    The AWS Supply Chain instance description.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don’t provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.

    
    
  • web_app_dns_domain(impl Into<String>) / set_web_app_dns_domain(Option<String>):
    required: false
    

    The DNS subdomain of the web app. This would be “example” in the URL “example.scn.global.on.aws”. You can set this to a custom value, as long as the domain isn’t already being used by someone else. The name may only include alphanumeric characters and hyphens.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The Amazon Web Services tags of an instance to be created.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The client token for idempotency.

    
    
• On success, responds with CreateInstanceOutput with field(s):
  • instance(Option<Instance>):

    The AWS Supply Chain instance resource data details.

• On failure, responds with SdkError<CreateInstanceError>

impl Client

pub fn delete_data_integration_flow( &self, ) -> DeleteDataIntegrationFlowFluentBuilder

Constructs a fluent builder for the DeleteDataIntegrationFlow operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the DataIntegrationFlow to be deleted.

    
    
• On success, responds with DeleteDataIntegrationFlowOutput with field(s):
  • instance_id(String):

    The Amazon Web Services Supply Chain instance identifier.

  • name(String):

    The name of the DataIntegrationFlow deleted.

• On failure, responds with SdkError<DeleteDataIntegrationFlowError>

impl Client

pub fn delete_data_lake_dataset(&self) -> DeleteDataLakeDatasetFluentBuilder

Constructs a fluent builder for the DeleteDataLakeDataset operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:

    • asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    • default - For datasets with custom user-defined schemas.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    
    
• On success, responds with DeleteDataLakeDatasetOutput with field(s):
  • instance_id(String):

    The AWS Supply Chain instance identifier.

  • namespace(String):

    The namespace of deleted dataset.

  • name(String):

    The name of deleted dataset.

• On failure, responds with SdkError<DeleteDataLakeDatasetError>

impl Client

pub fn delete_data_lake_namespace(&self) -> DeleteDataLakeNamespaceFluentBuilder

Constructs a fluent builder for the DeleteDataLakeNamespace operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the namespace. Noted you cannot delete pre-defined namespace like asc, default which are only deleted through instance deletion.

    
    
• On success, responds with DeleteDataLakeNamespaceOutput with field(s):
  • instance_id(String):

    The AWS Supply Chain instance identifier.

  • name(String):

    The name of deleted namespace.

• On failure, responds with SdkError<DeleteDataLakeNamespaceError>

impl Client

pub fn delete_instance(&self) -> DeleteInstanceFluentBuilder

Constructs a fluent builder for the DeleteInstance operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
• On success, responds with DeleteInstanceOutput with field(s):
  • instance(Option<Instance>):

    The AWS Supply Chain instance resource data details.

• On failure, responds with SdkError<DeleteInstanceError>

impl Client

pub fn get_bill_of_materials_import_job( &self, ) -> GetBillOfMaterialsImportJobFluentBuilder

Constructs a fluent builder for the GetBillOfMaterialsImportJob operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The BillOfMaterialsImportJob identifier.

    
    
• On success, responds with GetBillOfMaterialsImportJobOutput with field(s):
  • job(Option<BillOfMaterialsImportJob>):

    The BillOfMaterialsImportJob.

• On failure, responds with SdkError<GetBillOfMaterialsImportJobError>

impl Client

pub fn get_data_integration_event(&self) -> GetDataIntegrationEventFluentBuilder

Constructs a fluent builder for the GetDataIntegrationEvent operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • event_id(impl Into<String>) / set_event_id(Option<String>):
    required: true
    

    The unique event identifier.

    
    
• On success, responds with GetDataIntegrationEventOutput with field(s):
  • event(Option<DataIntegrationEvent>):

    The details of the DataIntegrationEvent returned.

• On failure, responds with SdkError<GetDataIntegrationEventError>

impl Client

pub fn get_data_integration_flow(&self) -> GetDataIntegrationFlowFluentBuilder

Constructs a fluent builder for the GetDataIntegrationFlow operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the DataIntegrationFlow created.

    
    
• On success, responds with GetDataIntegrationFlowOutput with field(s):
  • flow(Option<DataIntegrationFlow>):

    The details of the DataIntegrationFlow returned.

• On failure, responds with SdkError<GetDataIntegrationFlowError>

impl Client

pub fn get_data_integration_flow_execution( &self, ) -> GetDataIntegrationFlowExecutionFluentBuilder

Constructs a fluent builder for the GetDataIntegrationFlowExecution operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The flow name.

    
    
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The flow execution identifier.

    
    
• On success, responds with GetDataIntegrationFlowExecutionOutput with field(s):
  • flow_execution(Option<DataIntegrationFlowExecution>):

    The flow execution details.

• On failure, responds with SdkError<GetDataIntegrationFlowExecutionError>

impl Client

pub fn get_data_lake_dataset(&self) -> GetDataLakeDatasetFluentBuilder

Constructs a fluent builder for the GetDataLakeDataset operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:

    • asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    • default - For datasets with custom user-defined schemas.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    
    
• On success, responds with GetDataLakeDatasetOutput with field(s):
  • dataset(Option<DataLakeDataset>):

    The fetched dataset details.

• On failure, responds with SdkError<GetDataLakeDatasetError>

impl Client

pub fn get_data_lake_namespace(&self) -> GetDataLakeNamespaceFluentBuilder

Constructs a fluent builder for the GetDataLakeNamespace operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the namespace. Besides the namespaces user created, you can also specify the pre-defined namespaces:

    • asc - Pre-defined namespace containing Amazon Web Services Supply Chain supported datasets, see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    • default - Pre-defined namespace containing datasets with custom user-defined schemas.

    
    
• On success, responds with GetDataLakeNamespaceOutput with field(s):
  • namespace(Option<DataLakeNamespace>):

    The fetched namespace details.

• On failure, responds with SdkError<GetDataLakeNamespaceError>

impl Client

pub fn get_instance(&self) -> GetInstanceFluentBuilder

Constructs a fluent builder for the GetInstance operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier

    
    
• On success, responds with GetInstanceOutput with field(s):
  • instance(Option<Instance>):

    The instance resource data details.

• On failure, responds with SdkError<GetInstanceError>

impl Client

pub fn list_data_integration_events( &self, ) -> ListDataIntegrationEventsFluentBuilder

Constructs a fluent builder for the ListDataIntegrationEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • event_type(DataIntegrationEventType) / set_event_type(Option<DataIntegrationEventType>):
    required: false
    

    List data integration events for the specified eventType.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token to fetch the next page of the data integration events.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify the maximum number of data integration events to fetch in one paginated request.

    
    
• On success, responds with ListDataIntegrationEventsOutput with field(s):
  • events(Vec::<DataIntegrationEvent>):

    The list of data integration events.

  • next_token(Option<String>):

    The pagination token to fetch the next page of the ListDataIntegrationEvents.

• On failure, responds with SdkError<ListDataIntegrationEventsError>

impl Client

pub fn list_data_integration_flow_executions( &self, ) -> ListDataIntegrationFlowExecutionsFluentBuilder

Constructs a fluent builder for the ListDataIntegrationFlowExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The flow name.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token to fetch next page of flow executions.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number to specify the max number of flow executions to fetch in this paginated request.

    
    
• On success, responds with ListDataIntegrationFlowExecutionsOutput with field(s):
  • flow_executions(Vec::<DataIntegrationFlowExecution>):

    The list of flow executions.

  • next_token(Option<String>):

    The pagination token to fetch next page of flow executions.

• On failure, responds with SdkError<ListDataIntegrationFlowExecutionsError>

impl Client

pub fn list_data_integration_flows( &self, ) -> ListDataIntegrationFlowsFluentBuilder

Constructs a fluent builder for the ListDataIntegrationFlows operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token to fetch the next page of the DataIntegrationFlows.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.

    
    
• On success, responds with ListDataIntegrationFlowsOutput with field(s):
  • flows(Vec::<DataIntegrationFlow>):

    The response parameters for ListDataIntegrationFlows.

  • next_token(Option<String>):

    The pagination token to fetch the next page of the DataIntegrationFlows.

• On failure, responds with SdkError<ListDataIntegrationFlowsError>

impl Client

pub fn list_data_lake_datasets(&self) -> ListDataLakeDatasetsFluentBuilder

Constructs a fluent builder for the ListDataLakeDatasets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:

    • asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    • default - For datasets with custom user-defined schemas.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token to fetch next page of datasets.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The max number of datasets to fetch in this paginated request.

    
    
• On success, responds with ListDataLakeDatasetsOutput with field(s):
  • datasets(Vec::<DataLakeDataset>):

    The list of fetched dataset details.

  • next_token(Option<String>):

    The pagination token to fetch next page of datasets.

• On failure, responds with SdkError<ListDataLakeDatasetsError>

impl Client

pub fn list_data_lake_namespaces(&self) -> ListDataLakeNamespacesFluentBuilder

Constructs a fluent builder for the ListDataLakeNamespaces operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token to fetch next page of namespaces.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The max number of namespaces to fetch in this paginated request.

    
    
• On success, responds with ListDataLakeNamespacesOutput with field(s):
  • namespaces(Vec::<DataLakeNamespace>):

    The list of fetched namespace details. Noted it only contains custom namespaces, pre-defined namespaces are not included.

  • next_token(Option<String>):

    The pagination token to fetch next page of namespaces.

• On failure, responds with SdkError<ListDataLakeNamespacesError>

impl Client

pub fn list_instances(&self) -> ListInstancesFluentBuilder

Constructs a fluent builder for the ListInstances operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token to fetch the next page of instances.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specify the maximum number of instances to fetch in this paginated request.

    
    
  • instance_name_filter(impl Into<String>) / set_instance_name_filter(Option<Vec::<String>>):
    required: false
    

    The filter to ListInstances based on their names.

    
    
  • instance_state_filter(InstanceState) / set_instance_state_filter(Option<Vec::<InstanceState>>):
    required: false
    

    The filter to ListInstances based on their state.

    
    
• On success, responds with ListInstancesOutput with field(s):
  • instances(Vec::<Instance>):

    The list of instances resource data details.

  • next_token(Option<String>):

    The pagination token to fetch the next page of instances.

• On failure, responds with SdkError<ListInstancesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Web Services Supply chain resource ARN that needs tags to be listed.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(HashMap::<String, String>):

    The tags added to an Amazon Web Services Supply Chain resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn send_data_integration_event( &self, ) -> SendDataIntegrationEventFluentBuilder

Constructs a fluent builder for the SendDataIntegrationEvent operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • event_type(DataIntegrationEventType) / set_event_type(Option<DataIntegrationEventType>):
    required: true
    

    The data event type.

    • scn.data.dataset - Send data directly to any specified dataset.

    • scn.data.supplyplan - Send data to supply_plan dataset.

    • scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.

    • scn.data.shipmentstop - Send data to shipment_stop dataset.

    • scn.data.shipment - Send data to shipment dataset.

    • scn.data.reservation - Send data to reservation dataset.

    • scn.data.processproduct - Send data to process_product dataset.

    • scn.data.processoperation - Send data to process_operation dataset.

    • scn.data.processheader - Send data to process_header dataset.

    • scn.data.forecast - Send data to forecast dataset.

    • scn.data.inventorylevel - Send data to inv_level dataset.

    • scn.data.inboundorder - Send data to inbound_order dataset.

    • scn.data.inboundorderline - Send data to inbound_order_line dataset.

    • scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.

    • scn.data.outboundorderline - Send data to outbound_order_line dataset.

    • scn.data.outboundshipment - Send data to outbound_shipment dataset.

    
    
  • data(impl Into<String>) / set_data(Option<String>):
    required: true
    

    The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format.

    Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.

    
    
  • event_group_id(impl Into<String>) / set_event_group_id(Option<String>):
    required: true
    

    Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server.

    
    
  • event_timestamp(DateTime) / set_event_timestamp(Option<DateTime>):
    required: false
    

    The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors.

    
    
  • dataset_target(DataIntegrationEventDatasetTargetConfiguration) / set_dataset_target(Option<DataIntegrationEventDatasetTargetConfiguration>):
    required: false
    

    The target dataset configuration for scn.data.dataset event type.

    
    
• On success, responds with SendDataIntegrationEventOutput with field(s):
  • event_id(String):

    The unique event identifier.

• On failure, responds with SdkError<SendDataIntegrationEventError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Web Services Supply chain resource ARN that needs to be tagged.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags of the Amazon Web Services Supply chain resource to be created.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Web Services Supply chain resource ARN that needs to be untagged.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to be deleted for an Amazon Web Services Supply Chain resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_data_integration_flow( &self, ) -> UpdateDataIntegrationFlowFluentBuilder

Constructs a fluent builder for the UpdateDataIntegrationFlow operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Supply Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the DataIntegrationFlow to be updated.

    
    
  • sources(DataIntegrationFlowSource) / set_sources(Option<Vec::<DataIntegrationFlowSource>>):
    required: false
    

    The new source configurations for the DataIntegrationFlow.

    
    
  • transformation(DataIntegrationFlowTransformation) / set_transformation(Option<DataIntegrationFlowTransformation>):
    required: false
    

    The new transformation configurations for the DataIntegrationFlow.

    
    
  • target(DataIntegrationFlowTarget) / set_target(Option<DataIntegrationFlowTarget>):
    required: false
    

    The new target configurations for the DataIntegrationFlow.

    
    
• On success, responds with UpdateDataIntegrationFlowOutput with field(s):
  • flow(Option<DataIntegrationFlow>):

    The details of the updated DataIntegrationFlow.

• On failure, responds with SdkError<UpdateDataIntegrationFlowError>

impl Client

pub fn update_data_lake_dataset(&self) -> UpdateDataLakeDatasetFluentBuilder

Constructs a fluent builder for the UpdateDataLakeDataset operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Chain instance identifier.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:

    • asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    • default - For datasets with custom user-defined schemas.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the data lake dataset.

    
    
• On success, responds with UpdateDataLakeDatasetOutput with field(s):
  • dataset(Option<DataLakeDataset>):

    The updated dataset details.

• On failure, responds with SdkError<UpdateDataLakeDatasetError>

impl Client

pub fn update_data_lake_namespace(&self) -> UpdateDataLakeNamespaceFluentBuilder

Constructs a fluent builder for the UpdateDataLakeNamespace operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The Amazon Web Services Chain instance identifier.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the namespace. Noted you cannot update namespace with name starting with asc, default, scn, aws, amazon, amzn

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description of the data lake namespace.

    
    
• On success, responds with UpdateDataLakeNamespaceOutput with field(s):
  • namespace(Option<DataLakeNamespace>):

    The updated namespace details.

• On failure, responds with SdkError<UpdateDataLakeNamespaceError>

impl Client

pub fn update_instance(&self) -> UpdateInstanceFluentBuilder

Constructs a fluent builder for the UpdateInstance operation.

• The fluent builder is configurable:
  • instance_id(impl Into<String>) / set_instance_id(Option<String>):
    required: true
    

    The AWS Supply Chain instance identifier.

    
    
  • instance_name(impl Into<String>) / set_instance_name(Option<String>):
    required: false
    

    The AWS Supply Chain instance name.

    
    
  • instance_description(impl Into<String>) / set_instance_description(Option<String>):
    required: false
    

    The AWS Supply Chain instance description.

    
    
• On success, responds with UpdateInstanceOutput with field(s):
  • instance(Option<Instance>):

    The instance resource data details.

• On failure, responds with SdkError<UpdateInstanceError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.