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.
409 410 411 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 409 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.
470 471 472 473 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 470 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.
516 517 518 519 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 516 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.
619 620 621 622 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 619 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.
723 724 725 726 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 723 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.
860 861 862 863 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 860 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.
927 928 929 930 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 927 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.
956 957 958 959 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 956 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.
984 985 986 987 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 984 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.
1013 1014 1015 1016 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1013 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.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1050 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
.
1081 1082 1083 1084 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1081 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.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1131 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.
1185 1186 1187 1188 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1185 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.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1236 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.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1280 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.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1331 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.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1396 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.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1429 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.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1496 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.
1544 1545 1546 1547 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1544 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.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1588 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.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1629 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.
1671 1672 1673 1674 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1671 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.
1715 1716 1717 1718 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1715 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.
1757 1758 1759 1760 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1757 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.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1803 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.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1845 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.
1876 1877 1878 1879 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1876 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_policy(params = {}) ⇒ Types::PutPolicyOutput
Updates the resource-based policy.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1917 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.
1961 1962 1963 1964 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1961 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.
1990 1991 1992 1993 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1990 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.
2029 2030 2031 2032 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2029 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.
2057 2058 2059 2060 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2057 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.
2153 2154 2155 2156 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2153 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.
2235 2236 2237 2238 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2235 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.
2363 2364 2365 2366 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2363 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.
2427 2428 2429 2430 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2427 def update_schema_mapping(params = {}, = {}) req = build_request(:update_schema_mapping, params) req.send_request() end |