entityresolution: AWS EntityResolution

In paws: Amazon Web Services Software Development Kit

AWS EntityResolution

Description

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.

Usage

entityresolution(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- entityresolution(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

add_policy_statement	Adds a policy statement object
batch_delete_unique_id	Deletes multiple unique IDs in a matching workflow
create_id_mapping_workflow	Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run
create_id_namespace	Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it
create_matching_workflow	Creates a MatchingWorkflow object which stores the configuration of the data processing job to be run
create_schema_mapping	Creates a schema mapping, which defines the schema of the input customer records table
delete_id_mapping_workflow	Deletes the IdMappingWorkflow with a given name
delete_id_namespace	Deletes the IdNamespace with a given name
delete_matching_workflow	Deletes the MatchingWorkflow with a given name
delete_policy_statement	Deletes the policy statement
delete_schema_mapping	Deletes the SchemaMapping with a given name
get_id_mapping_job	Gets the status, metrics, and errors (if there are any) that are associated with a job
get_id_mapping_workflow	Returns the IdMappingWorkflow with a given name, if it exists
get_id_namespace	Returns the IdNamespace with a given name, if it exists
get_match_id	Returns the corresponding Match ID of a customer record if the record has been processed
get_matching_job	Gets the status, metrics, and errors (if there are any) that are associated with a job
get_matching_workflow	Returns the MatchingWorkflow with a given name, if it exists
get_policy	Returns the resource-based policy
get_provider_service	Returns the ProviderService of a given name
get_schema_mapping	Returns the SchemaMapping of a given name
list_id_mapping_jobs	Lists all ID mapping jobs for a given workflow
list_id_mapping_workflows	Returns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account
list_id_namespaces	Returns a list of all ID namespaces
list_matching_jobs	Lists all jobs for a given workflow
list_matching_workflows	Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account
list_provider_services	Returns a list of all the ProviderServices that are available in this Amazon Web Services Region
list_schema_mappings	Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account
list_tags_for_resource	Displays the tags associated with an Entity Resolution resource
put_policy	Updates the resource-based policy
start_id_mapping_job	Starts the IdMappingJob of a workflow
start_matching_job	Starts the MatchingJob of a workflow
tag_resource	Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource
untag_resource	Removes one or more tags from the specified Entity Resolution resource
update_id_mapping_workflow	Updates an existing IdMappingWorkflow
update_id_namespace	Updates an existing ID namespace
update_matching_workflow	Updates an existing MatchingWorkflow
update_schema_mapping	Updates a schema mapping

Examples

## Not run: 
svc <- entityresolution()
svc$add_policy_statement(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.