# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.EntityResolution do
@moduledoc """
Welcome to the *Entity Resolution API Reference*.
Entity Resolution is an Amazon Web Services service that provides pre-configured
entity resolution capabilities that enable developers and analysts at
advertising and marketing companies to build an accurate and complete view of
their consumers.
With Entity Resolution, you can match source records containing consumer
identifiers, such as name, email address, and phone number. This is true even
when these records have incomplete or conflicting identifiers. For example,
Entity Resolution can effectively match a source record from a customer
relationship management (CRM) system with a source record from a marketing
system containing campaign information.
To learn more about Entity Resolution concepts, procedures, and best practices,
see the [Entity Resolution User Guide](https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html).
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
get_id_mapping_job_input() :: %{}
"""
@type get_id_mapping_job_input() :: %{}
@typedoc """
## Example:
list_provider_services_input() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom(),
optional("providerName") => String.t() | atom()
}
"""
@type list_provider_services_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_matching_job_input() :: %{}
"""
@type start_matching_job_input() :: %{}
@typedoc """
## Example:
id_mapping_techniques() :: %{
"idMappingType" => list(any()),
"providerProperties" => provider_properties(),
"ruleBasedProperties" => id_mapping_rule_based_properties()
}
"""
@type id_mapping_techniques() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
record() :: %{
"inputSourceARN" => [String.t() | atom()],
"recordAttributeMap" => map(),
"uniqueId" => String.t() | atom()
}
"""
@type record() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_source() :: %{
"applyNormalization" => [boolean()],
"inputSourceARN" => [String.t() | atom()],
"schemaName" => String.t() | atom()
}
"""
@type input_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_matching_workflow_input() :: %{}
"""
@type delete_matching_workflow_input() :: %{}
@typedoc """
## Example:
get_match_id_output() :: %{
"matchId" => [String.t() | atom()],
"matchRule" => [String.t() | atom()]
}
"""
@type get_match_id_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resolution_techniques() :: %{
"providerProperties" => provider_properties(),
"resolutionType" => list(any()),
"ruleBasedProperties" => rule_based_properties(),
"ruleConditionProperties" => rule_condition_properties()
}
"""
@type resolution_techniques() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_schema_mapping_output() :: %{
"description" => String.t() | atom(),
"mappedInputFields" => list(schema_input_attribute()),
"schemaArn" => String.t() | atom(),
"schemaName" => String.t() | atom()
}
"""
@type update_schema_mapping_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
deleted_unique_id() :: %{
"uniqueId" => String.t() | atom()
}
"""
@type deleted_unique_id() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_id_mapping_workflow_output() :: %{
"message" => [String.t() | atom()]
}
"""
@type delete_id_mapping_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_policy_statement_input() :: %{
optional("condition") => String.t() | atom(),
required("action") => list(String.t() | atom()),
required("effect") => list(any()),
required("principal") => list(String.t() | atom())
}
"""
@type add_policy_statement_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_schema_mapping_input() :: %{
optional("description") => String.t() | atom(),
required("mappedInputFields") => list(schema_input_attribute())
}
"""
@type update_schema_mapping_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_policy_input() :: %{}
"""
@type get_policy_input() :: %{}
@typedoc """
## Example:
update_matching_workflow_input() :: %{
optional("description") => String.t() | atom(),
optional("incrementalRunConfig") => incremental_run_config(),
required("inputSourceConfig") => list(input_source()),
required("outputSourceConfig") => list(output_source()),
required("resolutionTechniques") => resolution_techniques(),
required("roleArn") => [String.t() | atom()]
}
"""
@type update_matching_workflow_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provider_service_summary() :: %{
"providerName" => String.t() | atom(),
"providerServiceArn" => String.t() | atom(),
"providerServiceDisplayName" => String.t() | atom(),
"providerServiceName" => String.t() | atom(),
"providerServiceType" => list(any())
}
"""
@type provider_service_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_schema_mappings_output() :: %{
"nextToken" => String.t() | atom(),
"schemaList" => list(schema_mapping_summary())
}
"""
@type list_schema_mappings_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
output_attribute() :: %{
"hashed" => [boolean()],
"name" => String.t() | atom()
}
"""
@type output_attribute() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_matching_job_output() :: %{
"jobId" => String.t() | atom()
}
"""
@type start_matching_job_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
exceeds_limit_exception() :: %{
"message" => String.t() | atom(),
"quotaName" => [String.t() | atom()],
"quotaValue" => [integer()]
}
"""
@type exceeds_limit_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_schema_mapping_input() :: %{}
"""
@type delete_schema_mapping_input() :: %{}
@typedoc """
## Example:
put_policy_input() :: %{
optional("token") => String.t() | atom(),
required("policy") => String.t() | atom()
}
"""
@type put_policy_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_policy_output() :: %{
"arn" => String.t() | atom(),
"policy" => String.t() | atom(),
"token" => String.t() | atom()
}
"""
@type put_policy_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_id_mapping_jobs_input() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type list_id_mapping_jobs_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_id_mapping_workflow_input() :: %{}
"""
@type delete_id_mapping_workflow_input() :: %{}
@typedoc """
## Example:
list_id_namespaces_output() :: %{
"idNamespaceSummaries" => list(id_namespace_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_id_namespaces_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_namespace_id_mapping_workflow_properties() :: %{
"idMappingType" => list(any()),
"providerProperties" => namespace_provider_properties(),
"ruleBasedProperties" => namespace_rule_based_properties()
}
"""
@type id_namespace_id_mapping_workflow_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_schema_mapping_output() :: %{
"description" => String.t() | atom(),
"mappedInputFields" => list(schema_input_attribute()),
"schemaArn" => String.t() | atom(),
"schemaName" => String.t() | atom()
}
"""
@type create_schema_mapping_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_matching_workflow_output() :: %{
"description" => String.t() | atom(),
"incrementalRunConfig" => incremental_run_config(),
"inputSourceConfig" => list(input_source()),
"outputSourceConfig" => list(output_source()),
"resolutionTechniques" => resolution_techniques(),
"roleArn" => [String.t() | atom()],
"workflowName" => String.t() | atom()
}
"""
@type update_matching_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_id_mapping_jobs_output() :: %{
"jobs" => list(job_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_id_mapping_jobs_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
job_metrics() :: %{
"inputRecords" => [integer()],
"matchIDs" => [integer()],
"recordsNotProcessed" => [integer()],
"totalRecordsProcessed" => [integer()]
}
"""
@type job_metrics() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_id_mapping_workflow_output() :: %{
"createdAt" => [non_neg_integer()],
"description" => String.t() | atom(),
"idMappingTechniques" => id_mapping_techniques(),
"inputSourceConfig" => list(id_mapping_workflow_input_source()),
"outputSourceConfig" => list(id_mapping_workflow_output_source()),
"roleArn" => String.t() | atom(),
"tags" => map(),
"updatedAt" => [non_neg_integer()],
"workflowArn" => String.t() | atom(),
"workflowName" => String.t() | atom()
}
"""
@type get_id_mapping_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_output() :: %{
"tags" => map()
}
"""
@type list_tags_for_resource_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
failed_record() :: %{
"errorMessage" => String.t() | atom(),
"inputSourceARN" => [String.t() | atom()],
"uniqueId" => [String.t() | atom()]
}
"""
@type failed_record() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_id_namespaces_input() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type list_id_namespaces_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_schema_mapping_output() :: %{
"createdAt" => [non_neg_integer()],
"description" => String.t() | atom(),
"hasWorkflows" => [boolean()],
"mappedInputFields" => list(schema_input_attribute()),
"schemaArn" => String.t() | atom(),
"schemaName" => String.t() | atom(),
"tags" => map(),
"updatedAt" => [non_neg_integer()]
}
"""
@type get_schema_mapping_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
namespace_rule_based_properties() :: %{
"attributeMatchingModel" => list(any()),
"recordMatchingModels" => list(list(any())()),
"ruleDefinitionTypes" => list(list(any())()),
"rules" => list(rule())
}
"""
@type namespace_rule_based_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_matching_workflows_input() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type list_matching_workflows_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_mapping_workflow_output_source() :: %{
"KMSArn" => String.t() | atom(),
"outputS3Path" => String.t() | atom()
}
"""
@type id_mapping_workflow_output_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_matching_workflow_output() :: %{
"description" => String.t() | atom(),
"incrementalRunConfig" => incremental_run_config(),
"inputSourceConfig" => list(input_source()),
"outputSourceConfig" => list(output_source()),
"resolutionTechniques" => resolution_techniques(),
"roleArn" => [String.t() | atom()],
"workflowArn" => String.t() | atom(),
"workflowName" => String.t() | atom()
}
"""
@type create_matching_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
job_summary() :: %{
"endTime" => [non_neg_integer()],
"jobId" => String.t() | atom(),
"startTime" => [non_neg_integer()],
"status" => list(any())
}
"""
@type job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
namespace_provider_properties() :: %{
"providerConfiguration" => [any()],
"providerServiceArn" => String.t() | atom()
}
"""
@type namespace_provider_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_delete_unique_id_output() :: %{
"deleted" => list(deleted_unique_id()),
"disconnectedUniqueIds" => list(String.t() | atom()),
"errors" => list(delete_unique_id_error()),
"status" => list(any())
}
"""
@type batch_delete_unique_id_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_schema_mapping_input() :: %{}
"""
@type get_schema_mapping_input() :: %{}
@typedoc """
## Example:
job_output_source() :: %{
"KMSArn" => String.t() | atom(),
"outputS3Path" => String.t() | atom(),
"roleArn" => String.t() | atom()
}
"""
@type job_output_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provider_id_name_space_configuration() :: %{
"description" => [String.t() | atom()],
"providerSourceConfigurationDefinition" => [any()],
"providerTargetConfigurationDefinition" => [any()]
}
"""
@type provider_id_name_space_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_delete_unique_id_input() :: %{
optional("inputSource") => [String.t() | atom()],
required("uniqueIds") => list(String.t() | atom())
}
"""
@type batch_delete_unique_id_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
intermediate_source_configuration() :: %{
"intermediateS3Path" => String.t() | atom()
}
"""
@type intermediate_source_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_id_namespace_input() :: %{}
"""
@type delete_id_namespace_input() :: %{}
@typedoc """
## Example:
generate_match_id_input() :: %{
optional("processingType") => list(any()),
required("records") => list(record())
}
"""
@type generate_match_id_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_id_mapping_workflows_output() :: %{
"nextToken" => String.t() | atom(),
"workflowSummaries" => list(id_mapping_workflow_summary())
}
"""
@type list_id_mapping_workflows_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_condition_properties() :: %{
"rules" => list(rule_condition())
}
"""
@type rule_condition_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_mapping_job_metrics() :: %{
"inputRecords" => [integer()],
"recordsNotProcessed" => [integer()],
"totalMappedRecords" => [integer()],
"totalMappedSourceRecords" => [integer()],
"totalMappedTargetRecords" => [integer()],
"totalRecordsProcessed" => [integer()],
"uniqueRecordsLoaded" => [integer()]
}
"""
@type id_mapping_job_metrics() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_id_mapping_workflow_input() :: %{
optional("description") => String.t() | atom(),
optional("outputSourceConfig") => list(id_mapping_workflow_output_source()),
optional("roleArn") => String.t() | atom(),
optional("tags") => map(),
required("idMappingTechniques") => id_mapping_techniques(),
required("inputSourceConfig") => list(id_mapping_workflow_input_source()),
required("workflowName") => String.t() | atom()
}
"""
@type create_id_mapping_workflow_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_matching_workflows_output() :: %{
"nextToken" => String.t() | atom(),
"workflowSummaries" => list(matching_workflow_summary())
}
"""
@type list_matching_workflows_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_matching_workflow_input() :: %{
optional("description") => String.t() | atom(),
optional("incrementalRunConfig") => incremental_run_config(),
optional("tags") => map(),
required("inputSourceConfig") => list(input_source()),
required("outputSourceConfig") => list(output_source()),
required("resolutionTechniques") => resolution_techniques(),
required("roleArn") => [String.t() | atom()],
required("workflowName") => String.t() | atom()
}
"""
@type create_matching_workflow_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
error_details() :: %{
"errorMessage" => String.t() | atom()
}
"""
@type error_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
matching_workflow_summary() :: %{
"createdAt" => [non_neg_integer()],
"resolutionType" => list(any()),
"updatedAt" => [non_neg_integer()],
"workflowArn" => String.t() | atom(),
"workflowName" => String.t() | atom()
}
"""
@type matching_workflow_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_id_mapping_job_output() :: %{
"endTime" => [non_neg_integer()],
"errorDetails" => error_details(),
"jobId" => String.t() | atom(),
"metrics" => id_mapping_job_metrics(),
"outputSourceConfig" => list(id_mapping_job_output_source()),
"startTime" => [non_neg_integer()],
"status" => list(any())
}
"""
@type get_id_mapping_job_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provider_schema_attribute() :: %{
"fieldName" => String.t() | atom(),
"hashing" => [boolean()],
"subType" => String.t() | atom(),
"type" => list(any())
}
"""
@type provider_schema_attribute() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_id_mapping_job_input() :: %{
optional("outputSourceConfig") => list(id_mapping_job_output_source())
}
"""
@type start_id_mapping_job_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_id_mapping_workflow_output() :: %{
"description" => String.t() | atom(),
"idMappingTechniques" => id_mapping_techniques(),
"inputSourceConfig" => list(id_mapping_workflow_input_source()),
"outputSourceConfig" => list(id_mapping_workflow_output_source()),
"roleArn" => String.t() | atom(),
"workflowArn" => String.t() | atom(),
"workflowName" => String.t() | atom()
}
"""
@type update_id_mapping_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_provider_service_input() :: %{}
"""
@type get_provider_service_input() :: %{}
@typedoc """
## Example:
id_namespace_id_mapping_workflow_metadata() :: %{
"idMappingType" => list(any())
}
"""
@type id_namespace_id_mapping_workflow_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_schema_mappings_input() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type list_schema_mappings_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_matching_jobs_input() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type list_matching_jobs_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_id_mapping_workflow_input() :: %{}
"""
@type get_id_mapping_workflow_input() :: %{}
@typedoc """
## Example:
get_id_namespace_input() :: %{}
"""
@type get_id_namespace_input() :: %{}
@typedoc """
## Example:
tag_resource_input() :: %{
required("tags") => map()
}
"""
@type tag_resource_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_policy_statement_output() :: %{
"arn" => String.t() | atom(),
"policy" => String.t() | atom(),
"token" => String.t() | atom()
}
"""
@type delete_policy_statement_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule() :: %{
"matchingKeys" => list(String.t() | atom()),
"ruleName" => [String.t() | atom()]
}
"""
@type rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_matching_workflow_output() :: %{
"message" => [String.t() | atom()]
}
"""
@type delete_matching_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_output() :: %{}
"""
@type tag_resource_output() :: %{}
@typedoc """
## Example:
match_group() :: %{
"matchId" => [String.t() | atom()],
"matchRule" => [String.t() | atom()],
"records" => list(matched_record())
}
"""
@type match_group() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => String.t() | atom()
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_id_mapping_workflows_input() :: %{
optional("maxResults") => [integer()],
optional("nextToken") => String.t() | atom()
}
"""
@type list_id_mapping_workflows_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_id_mapping_workflow_output() :: %{
"description" => String.t() | atom(),
"idMappingTechniques" => id_mapping_techniques(),
"inputSourceConfig" => list(id_mapping_workflow_input_source()),
"outputSourceConfig" => list(id_mapping_workflow_output_source()),
"roleArn" => String.t() | atom(),
"workflowArn" => String.t() | atom(),
"workflowName" => String.t() | atom()
}
"""
@type create_id_mapping_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_id_mapping_workflow_input() :: %{
optional("description") => String.t() | atom(),
optional("outputSourceConfig") => list(id_mapping_workflow_output_source()),
optional("roleArn") => String.t() | atom(),
required("idMappingTechniques") => id_mapping_techniques(),
required("inputSourceConfig") => list(id_mapping_workflow_input_source())
}
"""
@type update_id_mapping_workflow_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
schema_mapping_summary() :: %{
"createdAt" => [non_neg_integer()],
"hasWorkflows" => [boolean()],
"schemaArn" => String.t() | atom(),
"schemaName" => String.t() | atom(),
"updatedAt" => [non_neg_integer()]
}
"""
@type schema_mapping_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_id_namespace_output() :: %{
"createdAt" => [non_neg_integer()],
"description" => String.t() | atom(),
"idMappingWorkflowProperties" => list(id_namespace_id_mapping_workflow_properties()),
"idNamespaceArn" => String.t() | atom(),
"idNamespaceName" => String.t() | atom(),
"inputSourceConfig" => list(id_namespace_input_source()),
"roleArn" => String.t() | atom(),
"tags" => map(),
"type" => list(any()),
"updatedAt" => [non_neg_integer()]
}
"""
@type get_id_namespace_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_schema_mapping_input() :: %{
optional("description") => String.t() | atom(),
optional("tags") => map(),
required("mappedInputFields") => list(schema_input_attribute()),
required("schemaName") => String.t() | atom()
}
"""
@type create_schema_mapping_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_id_namespace_input() :: %{
optional("description") => String.t() | atom(),
optional("idMappingWorkflowProperties") => list(id_namespace_id_mapping_workflow_properties()),
optional("inputSourceConfig") => list(id_namespace_input_source()),
optional("roleArn") => String.t() | atom(),
optional("tags") => map(),
required("idNamespaceName") => String.t() | atom(),
required("type") => list(any())
}
"""
@type create_id_namespace_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provider_intermediate_data_access_configuration() :: %{
"awsAccountIds" => list(String.t() | atom()),
"requiredBucketActions" => list([String.t() | atom()]())
}
"""
@type provider_intermediate_data_access_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_unique_id_error() :: %{
"errorType" => list(any()),
"uniqueId" => String.t() | atom()
}
"""
@type delete_unique_id_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => String.t() | atom()
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
generate_match_id_output() :: %{
"failedRecords" => list(failed_record()),
"matchGroups" => list(match_group())
}
"""
@type generate_match_id_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_id_namespace_input() :: %{
optional("description") => String.t() | atom(),
optional("idMappingWorkflowProperties") => list(id_namespace_id_mapping_workflow_properties()),
optional("inputSourceConfig") => list(id_namespace_input_source()),
optional("roleArn") => String.t() | atom()
}
"""
@type update_id_namespace_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_input() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_policy_statement_input() :: %{}
"""
@type delete_policy_statement_input() :: %{}
@typedoc """
## Example:
rule_condition() :: %{
"condition" => [String.t() | atom()],
"ruleName" => [String.t() | atom()]
}
"""
@type rule_condition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
matched_record() :: %{
"inputSourceARN" => [String.t() | atom()],
"recordId" => [String.t() | atom()]
}
"""
@type matched_record() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_matching_job_input() :: %{}
"""
@type get_matching_job_input() :: %{}
@typedoc """
## Example:
delete_id_namespace_output() :: %{
"message" => [String.t() | atom()]
}
"""
@type delete_id_namespace_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_input() :: %{}
"""
@type list_tags_for_resource_input() :: %{}
@typedoc """
## Example:
get_provider_service_output() :: %{
"anonymizedOutput" => [boolean()],
"providerComponentSchema" => provider_component_schema(),
"providerConfigurationDefinition" => [any()],
"providerEndpointConfiguration" => list(),
"providerEntityOutputDefinition" => [any()],
"providerIdNameSpaceConfiguration" => provider_id_name_space_configuration(),
"providerIntermediateDataAccessConfiguration" => provider_intermediate_data_access_configuration(),
"providerJobConfiguration" => [any()],
"providerName" => String.t() | atom(),
"providerServiceArn" => String.t() | atom(),
"providerServiceDisplayName" => String.t() | atom(),
"providerServiceName" => String.t() | atom(),
"providerServiceType" => list(any())
}
"""
@type get_provider_service_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_output() :: %{}
"""
@type untag_resource_output() :: %{}
@typedoc """
## Example:
add_policy_statement_output() :: %{
"arn" => String.t() | atom(),
"policy" => String.t() | atom(),
"token" => String.t() | atom()
}
"""
@type add_policy_statement_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_mapping_workflow_summary() :: %{
"createdAt" => [non_neg_integer()],
"updatedAt" => [non_neg_integer()],
"workflowArn" => String.t() | atom(),
"workflowName" => String.t() | atom()
}
"""
@type id_mapping_workflow_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
output_source() :: %{
"KMSArn" => String.t() | atom(),
"applyNormalization" => [boolean()],
"output" => list(output_attribute()),
"outputS3Path" => String.t() | atom()
}
"""
@type output_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => String.t() | atom()
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provider_properties() :: %{
"intermediateSourceConfiguration" => intermediate_source_configuration(),
"providerConfiguration" => [any()],
"providerServiceArn" => String.t() | atom()
}
"""
@type provider_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_schema_mapping_output() :: %{
"message" => [String.t() | atom()]
}
"""
@type delete_schema_mapping_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provider_component_schema() :: %{
"providerSchemaAttributes" => list(provider_schema_attribute()),
"schemas" => list(list([String.t() | atom()]())())
}
"""
@type provider_component_schema() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_mapping_job_output_source() :: %{
"KMSArn" => String.t() | atom(),
"outputS3Path" => String.t() | atom(),
"roleArn" => String.t() | atom()
}
"""
@type id_mapping_job_output_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_namespace_summary() :: %{
"createdAt" => [non_neg_integer()],
"description" => String.t() | atom(),
"idMappingWorkflowProperties" => list(id_namespace_id_mapping_workflow_metadata()),
"idNamespaceArn" => String.t() | atom(),
"idNamespaceName" => String.t() | atom(),
"type" => list(any()),
"updatedAt" => [non_neg_integer()]
}
"""
@type id_namespace_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_id_mapping_job_output() :: %{
"jobId" => String.t() | atom(),
"outputSourceConfig" => list(id_mapping_job_output_source())
}
"""
@type start_id_mapping_job_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_matching_workflow_output() :: %{
"createdAt" => [non_neg_integer()],
"description" => String.t() | atom(),
"incrementalRunConfig" => incremental_run_config(),
"inputSourceConfig" => list(input_source()),
"outputSourceConfig" => list(output_source()),
"resolutionTechniques" => resolution_techniques(),
"roleArn" => [String.t() | atom()],
"tags" => map(),
"updatedAt" => [non_neg_integer()],
"workflowArn" => String.t() | atom(),
"workflowName" => String.t() | atom()
}
"""
@type get_matching_workflow_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
schema_input_attribute() :: %{
"fieldName" => String.t() | atom(),
"groupName" => String.t() | atom(),
"hashed" => [boolean()],
"matchKey" => String.t() | atom(),
"subType" => String.t() | atom(),
"type" => list(any())
}
"""
@type schema_input_attribute() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_namespace_input_source() :: %{
"inputSourceARN" => [String.t() | atom()],
"schemaName" => String.t() | atom()
}
"""
@type id_namespace_input_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provider_marketplace_configuration() :: %{
"assetId" => [String.t() | atom()],
"dataSetId" => [String.t() | atom()],
"listingId" => [String.t() | atom()],
"revisionId" => [String.t() | atom()]
}
"""
@type provider_marketplace_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_matching_job_output() :: %{
"endTime" => [non_neg_integer()],
"errorDetails" => error_details(),
"jobId" => String.t() | atom(),
"metrics" => job_metrics(),
"outputSourceConfig" => list(job_output_source()),
"startTime" => [non_neg_integer()],
"status" => list(any())
}
"""
@type get_matching_job_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rule_based_properties() :: %{
"attributeMatchingModel" => list(any()),
"matchPurpose" => list(any()),
"rules" => list(rule())
}
"""
@type rule_based_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_id_namespace_output() :: %{
"createdAt" => [non_neg_integer()],
"description" => String.t() | atom(),
"idMappingWorkflowProperties" => list(id_namespace_id_mapping_workflow_properties()),
"idNamespaceArn" => String.t() | atom(),
"idNamespaceName" => String.t() | atom(),
"inputSourceConfig" => list(id_namespace_input_source()),
"roleArn" => String.t() | atom(),
"tags" => map(),
"type" => list(any()),
"updatedAt" => [non_neg_integer()]
}
"""
@type create_id_namespace_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_mapping_rule_based_properties() :: %{
"attributeMatchingModel" => list(any()),
"recordMatchingModel" => list(any()),
"ruleDefinitionType" => list(any()),
"rules" => list(rule())
}
"""
@type id_mapping_rule_based_properties() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_id_namespace_output() :: %{
"createdAt" => [non_neg_integer()],
"description" => String.t() | atom(),
"idMappingWorkflowProperties" => list(id_namespace_id_mapping_workflow_properties()),
"idNamespaceArn" => String.t() | atom(),
"idNamespaceName" => String.t() | atom(),
"inputSourceConfig" => list(id_namespace_input_source()),
"roleArn" => String.t() | atom(),
"type" => list(any()),
"updatedAt" => [non_neg_integer()]
}
"""
@type update_id_namespace_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
id_mapping_workflow_input_source() :: %{
"inputSourceARN" => [String.t() | atom()],
"schemaName" => String.t() | atom(),
"type" => list(any())
}
"""
@type id_mapping_workflow_input_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_match_id_input() :: %{
optional("applyNormalization") => [boolean()],
required("record") => map()
}
"""
@type get_match_id_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
incremental_run_config() :: %{
"incrementalRunType" => list(any())
}
"""
@type incremental_run_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_matching_workflow_input() :: %{}
"""
@type get_matching_workflow_input() :: %{}
@typedoc """
## Example:
list_matching_jobs_output() :: %{
"jobs" => list(job_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_matching_jobs_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_provider_services_output() :: %{
"nextToken" => String.t() | atom(),
"providerServiceSummaries" => list(provider_service_summary())
}
"""
@type list_provider_services_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_policy_output() :: %{
"arn" => String.t() | atom(),
"policy" => String.t() | atom(),
"token" => String.t() | atom()
}
"""
@type get_policy_output() :: %{(String.t() | atom()) => any()}
@type add_policy_statement_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type batch_delete_unique_id_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type create_id_mapping_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
| exceeds_limit_exception()
@type create_id_namespace_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
| exceeds_limit_exception()
@type create_matching_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
| exceeds_limit_exception()
@type create_schema_mapping_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
| exceeds_limit_exception()
@type delete_id_mapping_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_id_namespace_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type delete_matching_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type delete_policy_statement_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_schema_mapping_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| conflict_exception()
@type generate_match_id_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_id_mapping_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_id_mapping_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_id_namespace_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_match_id_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_matching_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_matching_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_policy_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_provider_service_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_schema_mapping_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_id_mapping_jobs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_id_mapping_workflows_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_id_namespaces_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_matching_jobs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_matching_workflows_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_provider_services_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_schema_mappings_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_tags_for_resource_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type put_policy_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type start_id_mapping_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
| exceeds_limit_exception()
@type start_matching_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
| exceeds_limit_exception()
@type tag_resource_errors() ::
validation_exception() | internal_server_exception() | resource_not_found_exception()
@type untag_resource_errors() :: internal_server_exception() | resource_not_found_exception()
@type update_id_mapping_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_id_namespace_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_matching_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_schema_mapping_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
def metadata do
%{
api_version: "2018-05-10",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "entityresolution",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "EntityResolution",
signature_version: "v4",
signing_name: "entityresolution",
target_prefix: nil
}
end
@doc """
Adds a policy statement object.
To retrieve a list of existing policy statements, use the `GetPolicy` API.
"""
@spec add_policy_statement(
map(),
String.t() | atom(),
String.t() | atom(),
add_policy_statement_input(),
list()
) ::
{:ok, add_policy_statement_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, add_policy_statement_errors()}
def add_policy_statement(%Client{} = client, arn, statement_id, input, options \\ []) do
url_path = "/policies/#{AWS.Util.encode_uri(arn)}/#{AWS.Util.encode_uri(statement_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes multiple unique IDs in a matching workflow.
"""
@spec batch_delete_unique_id(map(), String.t() | atom(), batch_delete_unique_id_input(), list()) ::
{:ok, batch_delete_unique_id_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_delete_unique_id_errors()}
def batch_delete_unique_id(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}/uniqueids"
{headers, input} =
[
{"inputSource", "inputSource"},
{"uniqueIds", "uniqueIds"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an `IdMappingWorkflow` object which stores the configuration of the data
processing job to be run.
Each `IdMappingWorkflow` must have a unique workflow name. To modify an existing
workflow, use the UpdateIdMappingWorkflow API.
"""
@spec create_id_mapping_workflow(map(), create_id_mapping_workflow_input(), list()) ::
{:ok, create_id_mapping_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_id_mapping_workflow_errors()}
def create_id_mapping_workflow(%Client{} = client, input, options \\ []) do
url_path = "/idmappingworkflows"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates an ID namespace object which will help customers provide metadata
explaining their dataset and how to use it.
Each ID namespace must have a unique name. To modify an existing ID namespace,
use the UpdateIdNamespace API.
"""
@spec create_id_namespace(map(), create_id_namespace_input(), list()) ::
{:ok, create_id_namespace_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_id_namespace_errors()}
def create_id_namespace(%Client{} = client, input, options \\ []) do
url_path = "/idnamespaces"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a matching workflow that defines the configuration for a data processing
job.
The workflow name must be unique. To modify an existing workflow, use
`UpdateMatchingWorkflow`.
For workflows where `resolutionType` is ML_MATCHING, incremental processing is
not supported.
"""
@spec create_matching_workflow(map(), create_matching_workflow_input(), list()) ::
{:ok, create_matching_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_matching_workflow_errors()}
def create_matching_workflow(%Client{} = client, input, options \\ []) do
url_path = "/matchingworkflows"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a schema mapping, which defines the schema of the input customer records
table.
The `SchemaMapping` also provides Entity Resolution with some metadata about the
table, such as the attribute types of the columns and which columns to match on.
"""
@spec create_schema_mapping(map(), create_schema_mapping_input(), list()) ::
{:ok, create_schema_mapping_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_schema_mapping_errors()}
def create_schema_mapping(%Client{} = client, input, options \\ []) do
url_path = "/schemas"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the `IdMappingWorkflow` with a given name.
This operation will succeed even if a workflow with the given name does not
exist.
"""
@spec delete_id_mapping_workflow(
map(),
String.t() | atom(),
delete_id_mapping_workflow_input(),
list()
) ::
{:ok, delete_id_mapping_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_id_mapping_workflow_errors()}
def delete_id_mapping_workflow(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/idmappingworkflows/#{AWS.Util.encode_uri(workflow_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the `IdNamespace` with a given name.
"""
@spec delete_id_namespace(map(), String.t() | atom(), delete_id_namespace_input(), list()) ::
{:ok, delete_id_namespace_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_id_namespace_errors()}
def delete_id_namespace(%Client{} = client, id_namespace_name, input, options \\ []) do
url_path = "/idnamespaces/#{AWS.Util.encode_uri(id_namespace_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the `MatchingWorkflow` with a given name.
This operation will succeed even if a workflow with the given name does not
exist.
"""
@spec delete_matching_workflow(
map(),
String.t() | atom(),
delete_matching_workflow_input(),
list()
) ::
{:ok, delete_matching_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_matching_workflow_errors()}
def delete_matching_workflow(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the policy statement.
"""
@spec delete_policy_statement(
map(),
String.t() | atom(),
String.t() | atom(),
delete_policy_statement_input(),
list()
) ::
{:ok, delete_policy_statement_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_policy_statement_errors()}
def delete_policy_statement(%Client{} = client, arn, statement_id, input, options \\ []) do
url_path = "/policies/#{AWS.Util.encode_uri(arn)}/#{AWS.Util.encode_uri(statement_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the `SchemaMapping` with a given name.
This operation will succeed even if a schema with the given name does not exist.
This operation will fail if there is a `MatchingWorkflow` object that references
the `SchemaMapping` in the workflow's `InputSourceConfig`.
"""
@spec delete_schema_mapping(map(), String.t() | atom(), delete_schema_mapping_input(), list()) ::
{:ok, delete_schema_mapping_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_schema_mapping_errors()}
def delete_schema_mapping(%Client{} = client, schema_name, input, options \\ []) do
url_path = "/schemas/#{AWS.Util.encode_uri(schema_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Generates or retrieves Match IDs for records using a rule-based matching
workflow.
When you call this operation, it processes your records against the workflow's
matching rules to identify potential matches. For existing records, it retrieves
their Match IDs and associated rules. For records without matches, it generates
new Match IDs. The operation saves results to Amazon S3.
The processing type (`processingType`) you choose affects both the accuracy and
response time of the operation. Additional charges apply for each API call,
whether made through the Entity Resolution console or directly via the API. The
rule-based matching workflow must exist and be active before calling this
operation.
"""
@spec generate_match_id(map(), String.t() | atom(), generate_match_id_input(), list()) ::
{:ok, generate_match_id_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, generate_match_id_errors()}
def generate_match_id(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}/generateMatches"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the status, metrics, and errors (if there are any) that are associated
with a job.
"""
@spec get_id_mapping_job(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_id_mapping_job_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_id_mapping_job_errors()}
def get_id_mapping_job(%Client{} = client, job_id, workflow_name, options \\ []) do
url_path =
"/idmappingworkflows/#{AWS.Util.encode_uri(workflow_name)}/jobs/#{AWS.Util.encode_uri(job_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the `IdMappingWorkflow` with a given name, if it exists.
"""
@spec get_id_mapping_workflow(map(), String.t() | atom(), list()) ::
{:ok, get_id_mapping_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_id_mapping_workflow_errors()}
def get_id_mapping_workflow(%Client{} = client, workflow_name, options \\ []) do
url_path = "/idmappingworkflows/#{AWS.Util.encode_uri(workflow_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the `IdNamespace` with a given name, if it exists.
"""
@spec get_id_namespace(map(), String.t() | atom(), list()) ::
{:ok, get_id_namespace_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_id_namespace_errors()}
def get_id_namespace(%Client{} = client, id_namespace_name, options \\ []) do
url_path = "/idnamespaces/#{AWS.Util.encode_uri(id_namespace_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the corresponding Match ID of a customer record if the record has been
processed in a rule-based matching workflow or ML matching workflow.
You can call this API as a dry run of an incremental load on the rule-based
matching workflow.
"""
@spec get_match_id(map(), String.t() | atom(), get_match_id_input(), list()) ::
{:ok, get_match_id_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_match_id_errors()}
def get_match_id(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}/matches"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Returns the status, metrics, and errors (if there are any) that are associated
with a job.
"""
@spec get_matching_job(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_matching_job_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_matching_job_errors()}
def get_matching_job(%Client{} = client, job_id, workflow_name, options \\ []) do
url_path =
"/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}/jobs/#{AWS.Util.encode_uri(job_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the `MatchingWorkflow` with a given name, if it exists.
"""
@spec get_matching_workflow(map(), String.t() | atom(), list()) ::
{:ok, get_matching_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_matching_workflow_errors()}
def get_matching_workflow(%Client{} = client, workflow_name, options \\ []) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the resource-based policy.
"""
@spec get_policy(map(), String.t() | atom(), list()) ::
{:ok, get_policy_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_policy_errors()}
def get_policy(%Client{} = client, arn, options \\ []) do
url_path = "/policies/#{AWS.Util.encode_uri(arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the `ProviderService` of a given name.
"""
@spec get_provider_service(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_provider_service_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_provider_service_errors()}
def get_provider_service(
%Client{} = client,
provider_name,
provider_service_name,
options \\ []
) do
url_path =
"/providerservices/#{AWS.Util.encode_uri(provider_name)}/#{AWS.Util.encode_uri(provider_service_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns the SchemaMapping of a given name.
"""
@spec get_schema_mapping(map(), String.t() | atom(), list()) ::
{:ok, get_schema_mapping_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_schema_mapping_errors()}
def get_schema_mapping(%Client{} = client, schema_name, options \\ []) do
url_path = "/schemas/#{AWS.Util.encode_uri(schema_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all ID mapping jobs for a given workflow.
"""
@spec list_id_mapping_jobs(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_id_mapping_jobs_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_id_mapping_jobs_errors()}
def list_id_mapping_jobs(
%Client{} = client,
workflow_name,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/idmappingworkflows/#{AWS.Util.encode_uri(workflow_name)}/jobs"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of all the `IdMappingWorkflows` that have been created for an
Amazon Web Services account.
"""
@spec list_id_mapping_workflows(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_id_mapping_workflows_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_id_mapping_workflows_errors()}
def list_id_mapping_workflows(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/idmappingworkflows"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of all ID namespaces.
"""
@spec list_id_namespaces(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_id_namespaces_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_id_namespaces_errors()}
def list_id_namespaces(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/idnamespaces"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all jobs for a given workflow.
"""
@spec list_matching_jobs(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_matching_jobs_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_matching_jobs_errors()}
def list_matching_jobs(
%Client{} = client,
workflow_name,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}/jobs"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of all the `MatchingWorkflows` that have been created for an
Amazon Web Services account.
"""
@spec list_matching_workflows(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_matching_workflows_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_matching_workflows_errors()}
def list_matching_workflows(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/matchingworkflows"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of all the `ProviderServices` that are available in this Amazon
Web Services Region.
"""
@spec list_provider_services(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_provider_services_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_provider_services_errors()}
def list_provider_services(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
provider_name \\ nil,
options \\ []
) do
url_path = "/providerservices"
headers = []
query_params = []
query_params =
if !is_nil(provider_name) do
[{"providerName", provider_name} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of all the `SchemaMappings` that have been created for an Amazon
Web Services account.
"""
@spec list_schema_mappings(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_schema_mappings_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_schema_mappings_errors()}
def list_schema_mappings(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/schemas"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Displays the tags associated with an Entity Resolution resource.
In Entity Resolution, `SchemaMapping`, and `MatchingWorkflow` can be tagged.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Updates the resource-based policy.
"""
@spec put_policy(map(), String.t() | atom(), put_policy_input(), list()) ::
{:ok, put_policy_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_policy_errors()}
def put_policy(%Client{} = client, arn, input, options \\ []) do
url_path = "/policies/#{AWS.Util.encode_uri(arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Starts the `IdMappingJob` of a workflow.
The workflow must have previously been created using the
`CreateIdMappingWorkflow` endpoint.
"""
@spec start_id_mapping_job(map(), String.t() | atom(), start_id_mapping_job_input(), list()) ::
{:ok, start_id_mapping_job_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_id_mapping_job_errors()}
def start_id_mapping_job(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/idmappingworkflows/#{AWS.Util.encode_uri(workflow_name)}/jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Starts the `MatchingJob` of a workflow.
The workflow must have previously been created using the
`CreateMatchingWorkflow` endpoint.
"""
@spec start_matching_job(map(), String.t() | atom(), start_matching_job_input(), list()) ::
{:ok, start_matching_job_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_matching_job_errors()}
def start_matching_job(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}/jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Assigns one or more tags (key-value pairs) to the specified Entity Resolution
resource.
Tags can help you organize and categorize your resources. You can also use them
to scope user permissions by granting a user permission to access or change only
resources with certain tag values. In Entity Resolution, `SchemaMapping` and
`MatchingWorkflow` can be tagged. Tags don't have any semantic meaning to Amazon
Web Services and are interpreted strictly as strings of characters. You can use
the `TagResource` action with a resource that already has tags. If you specify a
new tag key, this tag is appended to the list of tags associated with the
resource. If you specify a tag key that is already associated with the resource,
the new tag value that you specify replaces the previous value for that tag.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_input(), list()) ::
{:ok, tag_resource_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes one or more tags from the specified Entity Resolution resource.
In Entity Resolution, `SchemaMapping`, and `MatchingWorkflow` can be tagged.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_input(), list()) ::
{:ok, untag_resource_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing `IdMappingWorkflow`.
This method is identical to CreateIdMappingWorkflow, except it uses an HTTP
`PUT` request instead of a `POST` request, and the `IdMappingWorkflow` must
already exist for the method to succeed.
"""
@spec update_id_mapping_workflow(
map(),
String.t() | atom(),
update_id_mapping_workflow_input(),
list()
) ::
{:ok, update_id_mapping_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_id_mapping_workflow_errors()}
def update_id_mapping_workflow(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/idmappingworkflows/#{AWS.Util.encode_uri(workflow_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing ID namespace.
"""
@spec update_id_namespace(map(), String.t() | atom(), update_id_namespace_input(), list()) ::
{:ok, update_id_namespace_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_id_namespace_errors()}
def update_id_namespace(%Client{} = client, id_namespace_name, input, options \\ []) do
url_path = "/idnamespaces/#{AWS.Util.encode_uri(id_namespace_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing matching workflow.
The workflow must already exist for this operation to succeed.
For workflows where `resolutionType` is ML_MATCHING, incremental processing is
not supported.
"""
@spec update_matching_workflow(
map(),
String.t() | atom(),
update_matching_workflow_input(),
list()
) ::
{:ok, update_matching_workflow_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_matching_workflow_errors()}
def update_matching_workflow(%Client{} = client, workflow_name, input, options \\ []) do
url_path = "/matchingworkflows/#{AWS.Util.encode_uri(workflow_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates a schema mapping.
A schema is immutable if it is being used by a workflow. Therefore, you can't
update a schema mapping if it's associated with a workflow.
"""
@spec update_schema_mapping(map(), String.t() | atom(), update_schema_mapping_input(), list()) ::
{:ok, update_schema_mapping_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_schema_mapping_errors()}
def update_schema_mapping(%Client{} = client, schema_name, input, options \\ []) do
url_path = "/schemas/#{AWS.Util.encode_uri(schema_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
