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.
422 423 424 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 422 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.
488 489 490 491 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 488 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.
534 535 536 537 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 534 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.
655 656 657 658 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 655 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.
779 780 781 782 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 779 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.
918 919 920 921 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 918 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.
987 988 989 990 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 987 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.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1016 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.
1044 1045 1046 1047 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1044 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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1073 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.
1110 1111 1112 1113 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1110 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
.
1141 1142 1143 1144 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1141 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.
1194 1195 1196 1197 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1194 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.
1255 1256 1257 1258 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1255 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.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1315 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.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1359 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.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1410 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.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1476 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1509 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.
1576 1577 1578 1579 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1576 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.
1625 1626 1627 1628 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1625 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.
1669 1670 1671 1672 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1669 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.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1710 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.
1754 1755 1756 1757 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1754 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.
1798 1799 1800 1801 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1798 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.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1840 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.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1886 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.
1928 1929 1930 1931 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1928 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.
1959 1960 1961 1962 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 1959 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_policy(params = {}) ⇒ Types::PutPolicyOutput
Updates the resource-based policy.
2005 2006 2007 2008 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2005 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.
2049 2050 2051 2052 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2049 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.
2078 2079 2080 2081 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2078 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.
2117 2118 2119 2120 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2117 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.
2145 2146 2147 2148 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2145 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.
2259 2260 2261 2262 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2259 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.
2361 2362 2363 2364 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2361 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.
2491 2492 2493 2494 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2491 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.
2557 2558 2559 2560 |
# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/client.rb', line 2557 def update_schema_mapping(params = {}, = {}) req = build_request(:update_schema_mapping, params) req.send_request() end |