Class: Aws::EntityResolution::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::EntityResolution::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb
Overview
An API client for EntityResolution. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::EntityResolution::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_policy_statement(params = {}) ⇒ Types::AddPolicyStatementOutput
Adds a policy statement object.
-
#batch_delete_unique_id(params = {}) ⇒ Types::BatchDeleteUniqueIdOutput
Deletes multiple unique IDs in a matching workflow.
-
#create_id_mapping_workflow(params = {}) ⇒ Types::CreateIdMappingWorkflowOutput
Creates an
IdMappingWorkflow
object which stores the configuration of the data processing job to be run. -
#create_id_namespace(params = {}) ⇒ Types::CreateIdNamespaceOutput
Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.
-
#create_matching_workflow(params = {}) ⇒ Types::CreateMatchingWorkflowOutput
Creates a
MatchingWorkflow
object which stores the configuration of the data processing job to be run. -
#create_schema_mapping(params = {}) ⇒ Types::CreateSchemaMappingOutput
Creates a schema mapping, which defines the schema of the input customer records table.
-
#delete_id_mapping_workflow(params = {}) ⇒ Types::DeleteIdMappingWorkflowOutput
Deletes the
IdMappingWorkflow
with a given name. -
#delete_id_namespace(params = {}) ⇒ Types::DeleteIdNamespaceOutput
Deletes the
IdNamespace
with a given name. -
#delete_matching_workflow(params = {}) ⇒ Types::DeleteMatchingWorkflowOutput
Deletes the
MatchingWorkflow
with a given name. -
#delete_policy_statement(params = {}) ⇒ Types::DeletePolicyStatementOutput
Deletes the policy statement.
-
#delete_schema_mapping(params = {}) ⇒ Types::DeleteSchemaMappingOutput
Deletes the
SchemaMapping
with a given name. -
#get_id_mapping_job(params = {}) ⇒ Types::GetIdMappingJobOutput
Gets the status, metrics, and errors (if there are any) that are associated with a job.
-
#get_id_mapping_workflow(params = {}) ⇒ Types::GetIdMappingWorkflowOutput
Returns the
IdMappingWorkflow
with a given name, if it exists. -
#get_id_namespace(params = {}) ⇒ Types::GetIdNamespaceOutput
Returns the
IdNamespace
with a given name, if it exists. -
#get_match_id(params = {}) ⇒ Types::GetMatchIdOutput
Returns the corresponding Match ID of a customer record if the record has been processed.
-
#get_matching_job(params = {}) ⇒ Types::GetMatchingJobOutput
Gets the status, metrics, and errors (if there are any) that are associated with a job.
-
#get_matching_workflow(params = {}) ⇒ Types::GetMatchingWorkflowOutput
Returns the
MatchingWorkflow
with a given name, if it exists. -
#get_policy(params = {}) ⇒ Types::GetPolicyOutput
Returns the resource-based policy.
-
#get_provider_service(params = {}) ⇒ Types::GetProviderServiceOutput
Returns the
ProviderService
of a given name. -
#get_schema_mapping(params = {}) ⇒ Types::GetSchemaMappingOutput
Returns the SchemaMapping of a given name.
-
#list_id_mapping_jobs(params = {}) ⇒ Types::ListIdMappingJobsOutput
Lists all ID mapping jobs for a given workflow.
-
#list_id_mapping_workflows(params = {}) ⇒ Types::ListIdMappingWorkflowsOutput
Returns a list of all the
IdMappingWorkflows
that have been created for an Amazon Web Services account. -
#list_id_namespaces(params = {}) ⇒ Types::ListIdNamespacesOutput
Returns a list of all ID namespaces.
-
#list_matching_jobs(params = {}) ⇒ Types::ListMatchingJobsOutput
Lists all jobs for a given workflow.
-
#list_matching_workflows(params = {}) ⇒ Types::ListMatchingWorkflowsOutput
Returns a list of all the
MatchingWorkflows
that have been created for an Amazon Web Services account. -
#list_provider_services(params = {}) ⇒ Types::ListProviderServicesOutput
Returns a list of all the
ProviderServices
that are available in this Amazon Web Services Region. -
#list_schema_mappings(params = {}) ⇒ Types::ListSchemaMappingsOutput
Returns a list of all the
SchemaMappings
that have been created for an Amazon Web Services account. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Displays the tags associated with an Entity Resolution resource.
-
#put_policy(params = {}) ⇒ Types::PutPolicyOutput
Updates the resource-based policy.
-
#start_id_mapping_job(params = {}) ⇒ Types::StartIdMappingJobOutput
Starts the
IdMappingJob
of a workflow. -
#start_matching_job(params = {}) ⇒ Types::StartMatchingJobOutput
Starts the
MatchingJob
of a workflow. -
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified Entity Resolution resource.
-
#update_id_mapping_workflow(params = {}) ⇒ Types::UpdateIdMappingWorkflowOutput
Updates an existing
IdMappingWorkflow
. -
#update_id_namespace(params = {}) ⇒ Types::UpdateIdNamespaceOutput
Updates an existing ID namespace.
-
#update_matching_workflow(params = {}) ⇒ Types::UpdateMatchingWorkflowOutput
Updates an existing
MatchingWorkflow
. -
#update_schema_mapping(params = {}) ⇒ Types::UpdateSchemaMappingOutput
Updates a schema mapping.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
440 441 442 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#add_policy_statement(params = {}) ⇒ Types::AddPolicyStatementOutput
Adds a policy statement object. To retrieve a list of existing policy
statements, use the GetPolicy
API.
506 507 508 509 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 506 def add_policy_statement(params = {}, = {}) req = build_request(:add_policy_statement, params) req.send_request() end |
#batch_delete_unique_id(params = {}) ⇒ Types::BatchDeleteUniqueIdOutput
Deletes multiple unique IDs in a matching workflow.
552 553 554 555 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 552 def batch_delete_unique_id(params = {}, = {}) req = build_request(:batch_delete_unique_id, params) req.send_request() end |
#create_id_mapping_workflow(params = {}) ⇒ Types::CreateIdMappingWorkflowOutput
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.
673 674 675 676 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 673 def create_id_mapping_workflow(params = {}, = {}) req = build_request(:create_id_mapping_workflow, params) req.send_request() end |
#create_id_namespace(params = {}) ⇒ Types::CreateIdNamespaceOutput
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.
797 798 799 800 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 797 def create_id_namespace(params = {}, = {}) req = build_request(:create_id_namespace, params) req.send_request() end |
#create_matching_workflow(params = {}) ⇒ Types::CreateMatchingWorkflowOutput
Creates a MatchingWorkflow
object which stores the configuration of
the data processing job to be run. It is important to note that there
should not be a pre-existing MatchingWorkflow
with the same name. To
modify an existing workflow, utilize the UpdateMatchingWorkflow
API.
936 937 938 939 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 936 def create_matching_workflow(params = {}, = {}) req = build_request(:create_matching_workflow, params) req.send_request() end |
#create_schema_mapping(params = {}) ⇒ Types::CreateSchemaMappingOutput
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.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1005 def create_schema_mapping(params = {}, = {}) req = build_request(:create_schema_mapping, params) req.send_request() end |
#delete_id_mapping_workflow(params = {}) ⇒ Types::DeleteIdMappingWorkflowOutput
Deletes the IdMappingWorkflow
with a given name. This operation will
succeed even if a workflow with the given name does not exist.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1034 def delete_id_mapping_workflow(params = {}, = {}) req = build_request(:delete_id_mapping_workflow, params) req.send_request() end |
#delete_id_namespace(params = {}) ⇒ Types::DeleteIdNamespaceOutput
Deletes the IdNamespace
with a given name.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1062 def delete_id_namespace(params = {}, = {}) req = build_request(:delete_id_namespace, params) req.send_request() end |
#delete_matching_workflow(params = {}) ⇒ Types::DeleteMatchingWorkflowOutput
Deletes the MatchingWorkflow
with a given name. This operation will
succeed even if a workflow with the given name does not exist.
1091 1092 1093 1094 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1091 def delete_matching_workflow(params = {}, = {}) req = build_request(:delete_matching_workflow, params) req.send_request() end |
#delete_policy_statement(params = {}) ⇒ Types::DeletePolicyStatementOutput
Deletes the policy statement.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1128 def delete_policy_statement(params = {}, = {}) req = build_request(:delete_policy_statement, params) req.send_request() end |
#delete_schema_mapping(params = {}) ⇒ Types::DeleteSchemaMappingOutput
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
.
1159 1160 1161 1162 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1159 def delete_schema_mapping(params = {}, = {}) req = build_request(:delete_schema_mapping, params) req.send_request() end |
#get_id_mapping_job(params = {}) ⇒ Types::GetIdMappingJobOutput
Gets the status, metrics, and errors (if there are any) that are associated with a job.
1212 1213 1214 1215 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1212 def get_id_mapping_job(params = {}, = {}) req = build_request(:get_id_mapping_job, params) req.send_request() end |
#get_id_mapping_workflow(params = {}) ⇒ Types::GetIdMappingWorkflowOutput
Returns the IdMappingWorkflow
with a given name, if it exists.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1273 def get_id_mapping_workflow(params = {}, = {}) req = build_request(:get_id_mapping_workflow, params) req.send_request() end |
#get_id_namespace(params = {}) ⇒ Types::GetIdNamespaceOutput
Returns the IdNamespace
with a given name, if it exists.
1333 1334 1335 1336 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1333 def get_id_namespace(params = {}, = {}) req = build_request(:get_id_namespace, params) req.send_request() end |
#get_match_id(params = {}) ⇒ Types::GetMatchIdOutput
Returns the corresponding Match ID of a customer record if the record has been processed.
1377 1378 1379 1380 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1377 def get_match_id(params = {}, = {}) req = build_request(:get_match_id, params) req.send_request() end |
#get_matching_job(params = {}) ⇒ Types::GetMatchingJobOutput
Gets the status, metrics, and errors (if there are any) that are associated with a job.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1428 def get_matching_job(params = {}, = {}) req = build_request(:get_matching_job, params) req.send_request() end |
#get_matching_workflow(params = {}) ⇒ Types::GetMatchingWorkflowOutput
Returns the MatchingWorkflow
with a given name, if it exists.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1494 def get_matching_workflow(params = {}, = {}) req = build_request(:get_matching_workflow, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyOutput
Returns the resource-based policy.
1527 1528 1529 1530 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1527 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#get_provider_service(params = {}) ⇒ Types::GetProviderServiceOutput
Returns the ProviderService
of a given name.
1594 1595 1596 1597 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1594 def get_provider_service(params = {}, = {}) req = build_request(:get_provider_service, params) req.send_request() end |
#get_schema_mapping(params = {}) ⇒ Types::GetSchemaMappingOutput
Returns the SchemaMapping of a given name.
1643 1644 1645 1646 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1643 def get_schema_mapping(params = {}, = {}) req = build_request(:get_schema_mapping, params) req.send_request() end |
#list_id_mapping_jobs(params = {}) ⇒ Types::ListIdMappingJobsOutput
Lists all ID mapping jobs for a given workflow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1687 1688 1689 1690 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1687 def list_id_mapping_jobs(params = {}, = {}) req = build_request(:list_id_mapping_jobs, params) req.send_request() end |
#list_id_mapping_workflows(params = {}) ⇒ Types::ListIdMappingWorkflowsOutput
Returns a list of all the IdMappingWorkflows
that have been created
for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1728 1729 1730 1731 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1728 def list_id_mapping_workflows(params = {}, = {}) req = build_request(:list_id_mapping_workflows, params) req.send_request() end |
#list_id_namespaces(params = {}) ⇒ Types::ListIdNamespacesOutput
Returns a list of all ID namespaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1772 1773 1774 1775 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1772 def list_id_namespaces(params = {}, = {}) req = build_request(:list_id_namespaces, params) req.send_request() end |
#list_matching_jobs(params = {}) ⇒ Types::ListMatchingJobsOutput
Lists all jobs for a given workflow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1816 1817 1818 1819 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1816 def list_matching_jobs(params = {}, = {}) req = build_request(:list_matching_jobs, params) req.send_request() end |
#list_matching_workflows(params = {}) ⇒ Types::ListMatchingWorkflowsOutput
Returns a list of all the MatchingWorkflows
that have been created
for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1858 1859 1860 1861 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1858 def list_matching_workflows(params = {}, = {}) req = build_request(:list_matching_workflows, params) req.send_request() end |
#list_provider_services(params = {}) ⇒ Types::ListProviderServicesOutput
Returns a list of all the ProviderServices
that are available in
this Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1904 1905 1906 1907 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1904 def list_provider_services(params = {}, = {}) req = build_request(:list_provider_services, params) req.send_request() end |
#list_schema_mappings(params = {}) ⇒ Types::ListSchemaMappingsOutput
Returns a list of all the SchemaMappings
that have been created for
an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1946 def list_schema_mappings(params = {}, = {}) req = build_request(:list_schema_mappings, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Displays the tags associated with an Entity Resolution resource. In
Entity Resolution, SchemaMapping
, and MatchingWorkflow
can be
tagged.
1977 1978 1979 1980 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1977 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_policy(params = {}) ⇒ Types::PutPolicyOutput
Updates the resource-based policy.
2023 2024 2025 2026 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2023 def put_policy(params = {}, = {}) req = build_request(:put_policy, params) req.send_request() end |
#start_id_mapping_job(params = {}) ⇒ Types::StartIdMappingJobOutput
Starts the IdMappingJob
of a workflow. The workflow must have
previously been created using the CreateIdMappingWorkflow
endpoint.
2067 2068 2069 2070 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2067 def start_id_mapping_job(params = {}, = {}) req = build_request(:start_id_mapping_job, params) req.send_request() end |
#start_matching_job(params = {}) ⇒ Types::StartMatchingJobOutput
Starts the MatchingJob
of a workflow. The workflow must have
previously been created using the CreateMatchingWorkflow
endpoint.
2096 2097 2098 2099 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2096 def start_matching_job(params = {}, = {}) req = build_request(:start_matching_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
2135 2136 2137 2138 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2135 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified Entity Resolution
resource. In Entity Resolution, SchemaMapping
, and
MatchingWorkflow
can be tagged.
2163 2164 2165 2166 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2163 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_id_mapping_workflow(params = {}) ⇒ Types::UpdateIdMappingWorkflowOutput
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.
2277 2278 2279 2280 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2277 def update_id_mapping_workflow(params = {}, = {}) req = build_request(:update_id_mapping_workflow, params) req.send_request() end |
#update_id_namespace(params = {}) ⇒ Types::UpdateIdNamespaceOutput
Updates an existing ID namespace.
2379 2380 2381 2382 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2379 def update_id_namespace(params = {}, = {}) req = build_request(:update_id_namespace, params) req.send_request() end |
#update_matching_workflow(params = {}) ⇒ Types::UpdateMatchingWorkflowOutput
Updates an existing MatchingWorkflow
. This method is identical to
CreateMatchingWorkflow
, except it uses an HTTP PUT
request instead
of a POST
request, and the MatchingWorkflow
must already exist for
the method to succeed.
2509 2510 2511 2512 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2509 def update_matching_workflow(params = {}, = {}) req = build_request(:update_matching_workflow, params) req.send_request() end |
#update_schema_mapping(params = {}) ⇒ Types::UpdateSchemaMappingOutput
Updates a schema mapping.
2575 2576 2577 2578 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2575 def update_schema_mapping(params = {}, = {}) req = build_request(:update_schema_mapping, params) req.send_request() end |