Struct aws_sdk_entityresolution::Client

pub struct Client { /* private fields */ }

Client for AWS EntityResolution

Client for invoking operations on AWS EntityResolution. Each operation on AWS EntityResolution 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_entityresolution::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config 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_entityresolution::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 CreateIdMappingWorkflow operation has a Client::create_id_mapping_workflow, 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_id_mapping_workflow()
    .workflow_name("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_id_mapping_workflow(&self) -> CreateIdMappingWorkflowFluentBuilder

Constructs a fluent builder for the CreateIdMappingWorkflow operation.

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

    The name of the workflow. There can’t be multiple IdMappingWorkflows with the same name.

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

    A description of the workflow.

    
    
  • input_source_config(IdMappingWorkflowInputSource) / set_input_source_config(Option<Vec::<IdMappingWorkflowInputSource>>):
    required: true
    

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

    
    
  • output_source_config(IdMappingWorkflowOutputSource) / set_output_source_config(Option<Vec::<IdMappingWorkflowOutputSource>>):
    required: true
    

    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.

    
    
  • id_mapping_techniques(IdMappingTechniques) / set_id_mapping_techniques(Option<IdMappingTechniques>):
    required: true
    

    An object which defines the idMappingType and the providerProperties.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

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

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateIdMappingWorkflowOutput with field(s):
  • workflow_name(String):

    The name of the workflow.

  • workflow_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the IDMappingWorkflow.

  • description(Option<String>):

    A description of the workflow.

  • input_source_config(Vec::<IdMappingWorkflowInputSource>):

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • output_source_config(Vec::<IdMappingWorkflowOutputSource>):

    A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output.

  • id_mapping_techniques(Option<IdMappingTechniques>):

    An object which defines the idMappingType and the providerProperties.

  • role_arn(String):

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

• On failure, responds with SdkError<CreateIdMappingWorkflowError>

impl Client

pub fn create_matching_workflow(&self) -> CreateMatchingWorkflowFluentBuilder

Constructs a fluent builder for the CreateMatchingWorkflow operation.

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

    The name of the workflow. There can’t be multiple MatchingWorkflows with the same name.

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

    A description of the workflow.

    
    
  • input_source_config(InputSource) / set_input_source_config(Option<Vec::<InputSource>>):
    required: true
    

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

    
    
  • output_source_config(OutputSource) / set_output_source_config(Option<Vec::<OutputSource>>):
    required: true
    

    A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

    
    
  • resolution_techniques(ResolutionTechniques) / set_resolution_techniques(Option<ResolutionTechniques>):
    required: true
    

    An object which defines the resolutionType and the ruleBasedProperties.

    
    
  • incremental_run_config(IncrementalRunConfig) / set_incremental_run_config(Option<IncrementalRunConfig>):
    required: false
    

    An object which defines an incremental run type and has only incrementalRunType as a field.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

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

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateMatchingWorkflowOutput with field(s):
  • workflow_name(String):

    The name of the workflow.

  • workflow_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.

  • description(Option<String>):

    A description of the workflow.

  • input_source_config(Vec::<InputSource>):

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • output_source_config(Vec::<OutputSource>):

    A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

  • resolution_techniques(Option<ResolutionTechniques>):

    An object which defines the resolutionType and the ruleBasedProperties.

  • incremental_run_config(Option<IncrementalRunConfig>):

    An object which defines an incremental run type and has only incrementalRunType as a field.

  • role_arn(String):

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

• On failure, responds with SdkError<CreateMatchingWorkflowError>

impl Client

pub fn create_schema_mapping(&self) -> CreateSchemaMappingFluentBuilder

Constructs a fluent builder for the CreateSchemaMapping operation.

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

    The name of the schema. There can’t be multiple SchemaMappings with the same name.

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

    A description of the schema.

    
    
  • mapped_input_fields(SchemaInputAttribute) / set_mapped_input_fields(Option<Vec::<SchemaInputAttribute>>):
    required: true
    

    A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

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

    The tags used to organize, track, or control access for this resource.

    
    
• On success, responds with CreateSchemaMappingOutput with field(s):
  • schema_name(String):

    The name of the schema.

  • schema_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

  • description(String):

    A description of the schema.

  • mapped_input_fields(Vec::<SchemaInputAttribute>):

    A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

• On failure, responds with SdkError<CreateSchemaMappingError>

impl Client

pub fn delete_id_mapping_workflow(&self) -> DeleteIdMappingWorkflowFluentBuilder

Constructs a fluent builder for the DeleteIdMappingWorkflow operation.

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

    The name of the workflow to be deleted.

    
    
• On success, responds with DeleteIdMappingWorkflowOutput with field(s):
  • message(String):

    A successful operation message.

• On failure, responds with SdkError<DeleteIdMappingWorkflowError>

impl Client

pub fn delete_matching_workflow(&self) -> DeleteMatchingWorkflowFluentBuilder

Constructs a fluent builder for the DeleteMatchingWorkflow operation.

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

    The name of the workflow to be retrieved.

    
    
• On success, responds with DeleteMatchingWorkflowOutput with field(s):
  • message(String):

    A successful operation message.

• On failure, responds with SdkError<DeleteMatchingWorkflowError>

impl Client

pub fn delete_schema_mapping(&self) -> DeleteSchemaMappingFluentBuilder

Constructs a fluent builder for the DeleteSchemaMapping operation.

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

    The name of the schema to delete.

    
    
• On success, responds with DeleteSchemaMappingOutput with field(s):
  • message(String):

    A successful operation message.

• On failure, responds with SdkError<DeleteSchemaMappingError>

impl Client

pub fn get_id_mapping_job(&self) -> GetIdMappingJobFluentBuilder

Constructs a fluent builder for the GetIdMappingJob operation.

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

    The name of the workflow.

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

    The ID of the job.

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

    The ID of the job.

  • status(JobStatus):

    The current status of the job.

  • start_time(DateTime):

    The time at which the job was started.

  • end_time(Option<DateTime>):

    The time at which the job has finished.

  • metrics(Option<IdMappingJobMetrics>):

    Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.

  • error_details(Option<ErrorDetails>):

    An object containing an error message, if there was an error.

• On failure, responds with SdkError<GetIdMappingJobError>

impl Client

pub fn get_id_mapping_workflow(&self) -> GetIdMappingWorkflowFluentBuilder

Constructs a fluent builder for the GetIdMappingWorkflow operation.

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

    The name of the workflow.

    
    
• On success, responds with GetIdMappingWorkflowOutput with field(s):
  • workflow_name(String):

    The name of the workflow.

  • workflow_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the IdMappingWorkflow .

  • description(Option<String>):

    A description of the workflow.

  • input_source_config(Vec::<IdMappingWorkflowInputSource>):

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • output_source_config(Vec::<IdMappingWorkflowOutputSource>):

    A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

  • id_mapping_techniques(Option<IdMappingTechniques>):

    An object which defines the idMappingType and the providerProperties.

  • created_at(DateTime):

    The timestamp of when the workflow was created.

  • updated_at(DateTime):

    The timestamp of when the workflow was last updated.

  • role_arn(String):

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetIdMappingWorkflowError>

impl Client

pub fn get_match_id(&self) -> GetMatchIdFluentBuilder

Constructs a fluent builder for the GetMatchId operation.

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

    The name of the workflow.

    
    
  • record(impl Into<String>, impl Into<String>) / set_record(Option<HashMap::<String, String>>):
    required: true
    

    The record to fetch the Match ID for.

    
    
• On success, responds with GetMatchIdOutput with field(s):
  • match_id(Option<String>):

    The unique identifiers for this group of match records.

• On failure, responds with SdkError<GetMatchIdError>

impl Client

pub fn get_matching_job(&self) -> GetMatchingJobFluentBuilder

Constructs a fluent builder for the GetMatchingJob operation.

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

    The name of the workflow.

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

    The ID of the job.

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

    The ID of the job.

  • status(JobStatus):

    The current status of the job.

  • start_time(DateTime):

    The time at which the job was started.

  • end_time(Option<DateTime>):

    The time at which the job has finished.

  • metrics(Option<JobMetrics>):

    Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.

  • error_details(Option<ErrorDetails>):

    An object containing an error message, if there was an error.

• On failure, responds with SdkError<GetMatchingJobError>

impl Client

pub fn get_matching_workflow(&self) -> GetMatchingWorkflowFluentBuilder

Constructs a fluent builder for the GetMatchingWorkflow operation.

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

    The name of the workflow.

    
    
• On success, responds with GetMatchingWorkflowOutput with field(s):
  • workflow_name(String):

    The name of the workflow.

  • workflow_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.

  • description(Option<String>):

    A description of the workflow.

  • input_source_config(Vec::<InputSource>):

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • output_source_config(Vec::<OutputSource>):

    A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

  • resolution_techniques(Option<ResolutionTechniques>):

    An object which defines the resolutionType and the ruleBasedProperties.

  • created_at(DateTime):

    The timestamp of when the workflow was created.

  • updated_at(DateTime):

    The timestamp of when the workflow was last updated.

  • incremental_run_config(Option<IncrementalRunConfig>):

    An object which defines an incremental run type and has only incrementalRunType as a field.

  • role_arn(String):

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<GetMatchingWorkflowError>

impl Client

pub fn get_provider_service(&self) -> GetProviderServiceFluentBuilder

Constructs a fluent builder for the GetProviderService operation.

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

    The name of the provider. This name is typically the company name.

    
    
  • provider_service_name(impl Into<String>) / set_provider_service_name(Option<String>):
    required: true
    

    The ARN (Amazon Resource Name) of the product that the provider service provides.

    
    
• On success, responds with GetProviderServiceOutput with field(s):
  • provider_name(String):

    The name of the provider. This name is typically the company name.

  • provider_service_name(String):

    The name of the product that the provider service provides.

  • provider_service_display_name(String):

    The display name of the provider service.

  • provider_service_type(ServiceType):

    The type of provider service.

  • provider_service_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the provider service.

  • provider_configuration_definition(Option<Document>):

    The definition of the provider configuration.

  • provider_endpoint_configuration(Option<ProviderEndpointConfiguration>):

    The required configuration fields to use with the provider service.

  • anonymized_output(bool):

    Specifies whether output data from the provider is anonymized. A value of TRUE means the output will be anonymized and you can’t relate the data that comes back from the provider to the identifying input. A value of FALSE means the output won’t be anonymized and you can relate the data that comes back from the provider to your source data.

  • provider_entity_output_definition(Document):

    The definition of the provider entity output.

  • provider_intermediate_data_access_configuration(Option<ProviderIntermediateDataAccessConfiguration>):

    The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.

• On failure, responds with SdkError<GetProviderServiceError>

impl Client

pub fn get_schema_mapping(&self) -> GetSchemaMappingFluentBuilder

Constructs a fluent builder for the GetSchemaMapping operation.

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

    The name of the schema to be retrieved.

    
    
• On success, responds with GetSchemaMappingOutput with field(s):
  • schema_name(String):

    The name of the schema.

  • schema_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

  • description(Option<String>):

    A description of the schema.

  • mapped_input_fields(Vec::<SchemaInputAttribute>):

    A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.

  • created_at(DateTime):

    The timestamp of when the SchemaMapping was created.

  • updated_at(DateTime):

    The timestamp of when the SchemaMapping was last updated.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for this resource.

  • has_workflows(bool):

    Specifies whether the schema mapping has been applied to a workflow.

• On failure, responds with SdkError<GetSchemaMappingError>

impl Client

pub fn list_id_mapping_jobs(&self) -> ListIdMappingJobsFluentBuilder

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

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

    The name of the workflow to be retrieved.

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

    The pagination token from the previous API call.

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

    The maximum number of objects returned per page.

    
    
• On success, responds with ListIdMappingJobsOutput with field(s):
  • jobs(Option<Vec::<JobSummary>>):

    A list of JobSummary objects.

  • next_token(Option<String>):

    The pagination token from the previous API call.

• On failure, responds with SdkError<ListIdMappingJobsError>

impl Client

pub fn list_id_mapping_workflows(&self) -> ListIdMappingWorkflowsFluentBuilder

Constructs a fluent builder for the ListIdMappingWorkflows 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 from the previous API call.

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

    The maximum number of objects returned per page.

    
    
• On success, responds with ListIdMappingWorkflowsOutput with field(s):
  • workflow_summaries(Option<Vec::<IdMappingWorkflowSummary>>):

    A list of IdMappingWorkflowSummary objects.

  • next_token(Option<String>):

    The pagination token from the previous API call.

• On failure, responds with SdkError<ListIdMappingWorkflowsError>

impl Client

pub fn list_matching_jobs(&self) -> ListMatchingJobsFluentBuilder

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

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

    The name of the workflow to be retrieved.

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

    The pagination token from the previous API call.

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

    The maximum number of objects returned per page.

    
    
• On success, responds with ListMatchingJobsOutput with field(s):
  • jobs(Option<Vec::<JobSummary>>):

    A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

  • next_token(Option<String>):

    The pagination token from the previous API call.

• On failure, responds with SdkError<ListMatchingJobsError>

impl Client

pub fn list_matching_workflows(&self) -> ListMatchingWorkflowsFluentBuilder

Constructs a fluent builder for the ListMatchingWorkflows 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 from the previous API call.

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

    The maximum number of objects returned per page.

    
    
• On success, responds with ListMatchingWorkflowsOutput with field(s):
  • workflow_summaries(Option<Vec::<MatchingWorkflowSummary>>):

    A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.

  • next_token(Option<String>):

    The pagination token from the previous API call.

• On failure, responds with SdkError<ListMatchingWorkflowsError>

impl Client

pub fn list_provider_services(&self) -> ListProviderServicesFluentBuilder

Constructs a fluent builder for the ListProviderServices 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 from the previous API call.

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

    The maximum number of objects returned per page.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The name of the provider. This name is typically the company name.

    
    
• On success, responds with ListProviderServicesOutput with field(s):
  • provider_service_summaries(Option<Vec::<ProviderServiceSummary>>):

    A list of ProviderServices objects.

  • next_token(Option<String>):

    The pagination token from the previous API call.

• On failure, responds with SdkError<ListProviderServicesError>

impl Client

pub fn list_schema_mappings(&self) -> ListSchemaMappingsFluentBuilder

Constructs a fluent builder for the ListSchemaMappings 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 from the previous API call.

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

    The maximum number of objects returned per page.

    
    
• On success, responds with ListSchemaMappingsOutput with field(s):
  • schema_list(Option<Vec::<SchemaMappingSummary>>):

    A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.

  • next_token(Option<String>):

    The pagination token from the previous API call.

• On failure, responds with SdkError<ListSchemaMappingsError>

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 ARN of the resource for which you want to view tags.

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

    The tags used to organize, track, or control access for this resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_id_mapping_job(&self) -> StartIdMappingJobFluentBuilder

Constructs a fluent builder for the StartIdMappingJob operation.

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

    The name of the ID mapping job to be retrieved.

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

    The ID of the job.

• On failure, responds with SdkError<StartIdMappingJobError>

impl Client

pub fn start_matching_job(&self) -> StartMatchingJobFluentBuilder

Constructs a fluent builder for the StartMatchingJob operation.

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

    The name of the matching job to be retrieved.

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

    The ID of the job.

• On failure, responds with SdkError<StartMatchingJobError>

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 ARN of the resource for which you want to view tags.

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

    The tags used to organize, track, or control access for this resource.

    
    
• 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 ARN of the resource for which you want to untag.

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

    The list of tag keys to remove from the resource.

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

impl Client

pub fn update_id_mapping_workflow(&self) -> UpdateIdMappingWorkflowFluentBuilder

Constructs a fluent builder for the UpdateIdMappingWorkflow operation.

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

    The name of the workflow.

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

    A description of the workflow.

    
    
  • input_source_config(IdMappingWorkflowInputSource) / set_input_source_config(Option<Vec::<IdMappingWorkflowInputSource>>):
    required: true
    

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

    
    
  • output_source_config(IdMappingWorkflowOutputSource) / set_output_source_config(Option<Vec::<IdMappingWorkflowOutputSource>>):
    required: true
    

    A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

    
    
  • id_mapping_techniques(IdMappingTechniques) / set_id_mapping_techniques(Option<IdMappingTechniques>):
    required: true
    

    An object which defines the idMappingType and the providerProperties.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.

    
    
• On success, responds with UpdateIdMappingWorkflowOutput with field(s):
  • workflow_name(String):

    The name of the workflow.

  • workflow_arn(String):

    The Amazon Resource Name (ARN) of the workflow role. Entity Resolution assumes this role to access resources on your behalf.

  • description(Option<String>):

    A description of the workflow.

  • input_source_config(Vec::<IdMappingWorkflowInputSource>):

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • output_source_config(Vec::<IdMappingWorkflowOutputSource>):

    A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

  • id_mapping_techniques(Option<IdMappingTechniques>):

    An object which defines the idMappingType and the providerProperties.

  • role_arn(String):

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access resources on your behalf.

• On failure, responds with SdkError<UpdateIdMappingWorkflowError>

impl Client

pub fn update_matching_workflow(&self) -> UpdateMatchingWorkflowFluentBuilder

Constructs a fluent builder for the UpdateMatchingWorkflow operation.

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

    The name of the workflow to be retrieved.

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

    A description of the workflow.

    
    
  • input_source_config(InputSource) / set_input_source_config(Option<Vec::<InputSource>>):
    required: true
    

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

    
    
  • output_source_config(OutputSource) / set_output_source_config(Option<Vec::<OutputSource>>):
    required: true
    

    A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

    
    
  • resolution_techniques(ResolutionTechniques) / set_resolution_techniques(Option<ResolutionTechniques>):
    required: true
    

    An object which defines the resolutionType and the ruleBasedProperties.

    
    
  • incremental_run_config(IncrementalRunConfig) / set_incremental_run_config(Option<IncrementalRunConfig>):
    required: false
    

    An object which defines an incremental run type and has only incrementalRunType as a field.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

    
    
• On success, responds with UpdateMatchingWorkflowOutput with field(s):
  • workflow_name(String):

    The name of the workflow.

  • description(Option<String>):

    A description of the workflow.

  • input_source_config(Vec::<InputSource>):

    A list of InputSource objects, which have the fields InputSourceARN and SchemaName.

  • output_source_config(Vec::<OutputSource>):

    A list of OutputSource objects, each of which contains fields OutputS3Path, ApplyNormalization, and Output.

  • resolution_techniques(Option<ResolutionTechniques>):

    An object which defines the resolutionType and the ruleBasedProperties

  • incremental_run_config(Option<IncrementalRunConfig>):

    An object which defines an incremental run type and has only incrementalRunType as a field.

  • role_arn(String):

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

• On failure, responds with SdkError<UpdateMatchingWorkflowError>

impl Client

pub fn update_schema_mapping(&self) -> UpdateSchemaMappingFluentBuilder

Constructs a fluent builder for the UpdateSchemaMapping operation.

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

    The name of the schema. There can’t be multiple SchemaMappings with the same name.

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

    A description of the schema.

    
    
  • mapped_input_fields(SchemaInputAttribute) / set_mapped_input_fields(Option<Vec::<SchemaInputAttribute>>):
    required: true
    

    A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

    
    
• On success, responds with UpdateSchemaMappingOutput with field(s):
  • schema_name(String):

    The name of the schema.

  • schema_arn(String):

    The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.

  • description(Option<String>):

    A description of the schema.

  • mapped_input_fields(Vec::<SchemaInputAttribute>):

    A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

• On failure, responds with SdkError<UpdateSchemaMappingError>

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