Class: Aws::EntityResolution::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::EntityResolution::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::EntityResolution::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2768
2769
2770
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2768

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2771
2772
2773
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2771

def errors_module
  Errors
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.

Examples:

Request syntax with placeholder values


resp = client.add_policy_statement({
  arn: "VeniceGlobalArn", # required
  statement_id: "StatementId", # required
  effect: "Allow", # required, accepts Allow, Deny
  action: ["StatementAction"], # required
  principal: ["StatementPrincipal"], # required
  condition: "StatementCondition",
})

Response structure


resp.arn #=> String
resp.token #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that will be accessed by the principal.

  • :statement_id (required, String) —

    A statement identifier that differentiates the statement from others in the same policy.

  • :effect (required, String) —

    Determines whether the permissions specified in the policy are to be allowed (‘Allow`) or denied (`Deny`).

    If you set the value of the ‘effect` parameter to `Deny` for the `AddPolicyStatement` operation, you must also set the value of the `effect` parameter in the `policy` to `Deny` for the `PutPolicy` operation.

  • :action (required, Array<String>) —

    The action that the principal can use on the resource.

    For example, ‘entityresolution:GetIdMappingJob`, `entityresolution:GetMatchingJob`.

  • :principal (required, Array<String>) —

    The Amazon Web Services service or Amazon Web Services account that can access the resource defined as ARN.

  • :condition (String) —

    A set of condition keys that you can use in key policies.

Returns:

See Also:



539
540
541
542
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 539

def add_policy_statement(params = {}, options = {})
  req = build_request(:add_policy_statement, params)
  req.send_request(options)
end

#batch_delete_unique_id(params = {}) ⇒ Types::BatchDeleteUniqueIdOutput

Deletes multiple unique IDs in a matching workflow.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_unique_id({
  workflow_name: "EntityName", # required
  input_source: "BatchDeleteUniqueIdInputInputSourceString",
  unique_ids: ["HeaderSafeUniqueId"], # required
})

Response structure


resp.status #=> String, one of "COMPLETED", "ACCEPTED"
resp.errors #=> Array
resp.errors[0].unique_id #=> String
resp.errors[0].error_type #=> String, one of "SERVICE_ERROR", "VALIDATION_ERROR"
resp.deleted #=> Array
resp.deleted[0].unique_id #=> String
resp.disconnected_unique_ids #=> Array
resp.disconnected_unique_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow.

  • :input_source (String) —

    The input source for the batch delete unique ID operation.

  • :unique_ids (required, Array<String>) —

    The unique IDs to delete.

Returns:

See Also:



585
586
587
588
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 585

def batch_delete_unique_id(params = {}, options = {})
  req = build_request(:batch_delete_unique_id, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2741

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::EntityResolution')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-entityresolution'
  context[:gem_version] = '1.36.0'
  Seahorse::Client::Request.new(handlers, context)
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.

Examples:

Request syntax with placeholder values


resp = client.create_id_mapping_workflow({
  workflow_name: "EntityName", # required
  description: "Description",
  input_source_config: [ # required
    {
      input_source_arn: "IdMappingWorkflowInputSourceInputSourceARNString", # required
      schema_name: "EntityName",
      type: "SOURCE", # accepts SOURCE, TARGET
    },
  ],
  output_source_config: [
    {
      output_s3_path: "S3Path", # required
      kms_arn: "KMSArn",
    },
  ],
  id_mapping_techniques: { # required
    id_mapping_type: "PROVIDER", # required, accepts PROVIDER, RULE_BASED
    rule_based_properties: {
      rules: [
        {
          rule_name: "RuleRuleNameString", # required
          matching_keys: ["AttributeName"], # required
        },
      ],
      rule_definition_type: "SOURCE", # required, accepts SOURCE, TARGET
      attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
      record_matching_model: "ONE_SOURCE_TO_ONE_TARGET", # required, accepts ONE_SOURCE_TO_ONE_TARGET, MANY_SOURCE_TO_ONE_TARGET
    },
    provider_properties: {
      provider_service_arn: "ProviderServiceArn", # required
      provider_configuration: {
      },
      intermediate_source_configuration: {
        intermediate_s3_path: "S3Path", # required
      },
    },
  },
  role_arn: "IdMappingRoleArn",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.workflow_name #=> String
resp.workflow_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.input_source_config[0].type #=> String, one of "SOURCE", "TARGET"
resp.output_source_config #=> Array
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String
resp.id_mapping_techniques.id_mapping_type #=> String, one of "PROVIDER", "RULE_BASED"
resp.id_mapping_techniques.rule_based_properties.rules #=> Array
resp.id_mapping_techniques.rule_based_properties.rules[0].rule_name #=> String
resp.id_mapping_techniques.rule_based_properties.rules[0].matching_keys #=> Array
resp.id_mapping_techniques.rule_based_properties.rules[0].matching_keys[0] #=> String
resp.id_mapping_techniques.rule_based_properties.rule_definition_type #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.id_mapping_techniques.rule_based_properties.record_matching_model #=> String, one of "ONE_SOURCE_TO_ONE_TARGET", "MANY_SOURCE_TO_ONE_TARGET"
resp.id_mapping_techniques.provider_properties.provider_service_arn #=> String
resp.id_mapping_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
resp.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow. There can’t be multiple ‘IdMappingWorkflows` with the same name.

  • :description (String) —

    A description of the workflow.

  • :input_source_config (required, Array<Types::IdMappingWorkflowInputSource>) —

    A list of ‘InputSource` objects, which have the fields `InputSourceARN` and `SchemaName`.

  • :output_source_config (Array<Types::IdMappingWorkflowOutputSource>) —

    A list of ‘IdMappingWorkflowOutputSource` objects, each of which contains fields `outputS3Path` and `KMSArn`.

  • :id_mapping_techniques (required, Types::IdMappingTechniques) —

    An object which defines the ID mapping technique and any additional configurations.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource.

Returns:

See Also:



706
707
708
709
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 706

def create_id_mapping_workflow(params = {}, options = {})
  req = build_request(:create_id_mapping_workflow, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_id_namespace({
  id_namespace_name: "EntityName", # required
  description: "Description",
  input_source_config: [
    {
      input_source_arn: "IdNamespaceInputSourceInputSourceARNString", # required
      schema_name: "EntityName",
    },
  ],
  id_mapping_workflow_properties: [
    {
      id_mapping_type: "PROVIDER", # required, accepts PROVIDER, RULE_BASED
      rule_based_properties: {
        rules: [
          {
            rule_name: "RuleRuleNameString", # required
            matching_keys: ["AttributeName"], # required
          },
        ],
        rule_definition_types: ["SOURCE"], # accepts SOURCE, TARGET
        attribute_matching_model: "ONE_TO_ONE", # accepts ONE_TO_ONE, MANY_TO_MANY
        record_matching_models: ["ONE_SOURCE_TO_ONE_TARGET"], # accepts ONE_SOURCE_TO_ONE_TARGET, MANY_SOURCE_TO_ONE_TARGET
      },
      provider_properties: {
        provider_service_arn: "ProviderServiceArn", # required
        provider_configuration: {
        },
      },
    },
  ],
  type: "SOURCE", # required, accepts SOURCE, TARGET
  role_arn: "RoleArn",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id_namespace_name #=> String
resp.id_namespace_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.id_mapping_workflow_properties #=> Array
resp.id_mapping_workflow_properties[0].id_mapping_type #=> String, one of "PROVIDER", "RULE_BASED"
resp.id_mapping_workflow_properties[0].rule_based_properties.rules #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].rule_name #=> String
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].matching_keys #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].matching_keys[0] #=> String
resp.id_mapping_workflow_properties[0].rule_based_properties.rule_definition_types #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rule_definition_types[0] #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_workflow_properties[0].rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.id_mapping_workflow_properties[0].rule_based_properties.record_matching_models #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.record_matching_models[0] #=> String, one of "ONE_SOURCE_TO_ONE_TARGET", "MANY_SOURCE_TO_ONE_TARGET"
resp.id_mapping_workflow_properties[0].provider_properties.provider_service_arn #=> String
resp.type #=> String, one of "SOURCE", "TARGET"
resp.role_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id_namespace_name (required, String) —

    The name of the ID namespace.

  • :description (String) —

    The description of the ID namespace.

  • :input_source_config (Array<Types::IdNamespaceInputSource>) —

    A list of ‘InputSource` objects, which have the fields `InputSourceARN` and `SchemaName`.

  • :id_mapping_workflow_properties (Array<Types::IdNamespaceIdMappingWorkflowProperties>) —

    Determines the properties of ‘IdMappingWorflow` where this `IdNamespace` can be used as a `Source` or a `Target`.

  • :type (required, String) —

    The type of ID namespace. There are two types: ‘SOURCE` and `TARGET`.

    The ‘SOURCE` contains configurations for `sourceId` data that will be processed in an ID mapping workflow.

    The ‘TARGET` contains a configuration of `targetId` to which all `sourceIds` will resolve to.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this ‘IdNamespace` on your behalf as part of the workflow run.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource.

Returns:

See Also:



830
831
832
833
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 830

def create_id_namespace(params = {}, options = {})
  req = build_request(:create_id_namespace, params)
  req.send_request(options)
end

#create_matching_workflow(params = {}) ⇒ Types::CreateMatchingWorkflowOutput

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.

Examples:

Request syntax with placeholder values


resp = client.create_matching_workflow({
  workflow_name: "EntityName", # required
  description: "Description",
  input_source_config: [ # required
    {
      input_source_arn: "InputSourceInputSourceARNString", # required
      schema_name: "EntityName", # required
      apply_normalization: false,
    },
  ],
  output_source_config: [ # required
    {
      output_s3_path: "S3Path", # required
      kms_arn: "KMSArn",
      output: [ # required
        {
          name: "AttributeName", # required
          hashed: false,
        },
      ],
      apply_normalization: false,
    },
  ],
  resolution_techniques: { # required
    resolution_type: "RULE_MATCHING", # required, accepts RULE_MATCHING, ML_MATCHING, PROVIDER
    rule_based_properties: {
      rules: [ # required
        {
          rule_name: "RuleRuleNameString", # required
          matching_keys: ["AttributeName"], # required
        },
      ],
      attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
      match_purpose: "IDENTIFIER_GENERATION", # accepts IDENTIFIER_GENERATION, INDEXING
    },
    rule_condition_properties: {
      rules: [ # required
        {
          rule_name: "RuleConditionRuleNameString", # required
          condition: "RuleConditionConditionString", # required
        },
      ],
    },
    provider_properties: {
      provider_service_arn: "ProviderServiceArn", # required
      provider_configuration: {
      },
      intermediate_source_configuration: {
        intermediate_s3_path: "S3Path", # required
      },
    },
  },
  incremental_run_config: {
    incremental_run_type: "IMMEDIATE", # accepts IMMEDIATE
  },
  role_arn: "String", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.workflow_name #=> String
resp.workflow_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.input_source_config[0].apply_normalization #=> Boolean
resp.output_source_config #=> Array
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String
resp.output_source_config[0].output #=> Array
resp.output_source_config[0].output[0].name #=> String
resp.output_source_config[0].output[0].hashed #=> Boolean
resp.output_source_config[0].apply_normalization #=> Boolean
resp.resolution_techniques.resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
resp.resolution_techniques.rule_based_properties.rules #=> Array
resp.resolution_techniques.rule_based_properties.rules[0].rule_name #=> String
resp.resolution_techniques.rule_based_properties.rules[0].matching_keys #=> Array
resp.resolution_techniques.rule_based_properties.rules[0].matching_keys[0] #=> String
resp.resolution_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.resolution_techniques.rule_based_properties.match_purpose #=> String, one of "IDENTIFIER_GENERATION", "INDEXING"
resp.resolution_techniques.rule_condition_properties.rules #=> Array
resp.resolution_techniques.rule_condition_properties.rules[0].rule_name #=> String
resp.resolution_techniques.rule_condition_properties.rules[0].condition #=> String
resp.resolution_techniques.provider_properties.provider_service_arn #=> String
resp.resolution_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
resp.incremental_run_config.incremental_run_type #=> String, one of "IMMEDIATE"
resp.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow. There can’t be multiple ‘MatchingWorkflows` with the same name.

  • :description (String) —

    A description of the workflow.

  • :input_source_config (required, Array<Types::InputSource>) —

    A list of ‘InputSource` objects, which have the fields `InputSourceARN` and `SchemaName`.

  • :output_source_config (required, Array<Types::OutputSource>) —

    A list of ‘OutputSource` objects, each of which contains fields `outputS3Path`, `applyNormalization`, `KMSArn`, and `output`.

  • :resolution_techniques (required, Types::ResolutionTechniques) —

    An object which defines the ‘resolutionType` and the `ruleBasedProperties`.

  • :incremental_run_config (Types::IncrementalRunConfig) —

    Optional. An object that defines the incremental run type. This object contains only the ‘incrementalRunType` field, which appears as “Automatic” in the console.

    For workflows where ‘resolutionType` is `ML_MATCHING`, incremental processing is not supported.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource.

Returns:

See Also:



986
987
988
989
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 986

def create_matching_workflow(params = {}, options = {})
  req = build_request(:create_matching_workflow, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_schema_mapping({
  schema_name: "EntityName", # required
  description: "Description",
  mapped_input_fields: [ # required
    {
      field_name: "AttributeName", # required
      type: "NAME", # required, accepts NAME, NAME_FIRST, NAME_MIDDLE, NAME_LAST, ADDRESS, ADDRESS_STREET1, ADDRESS_STREET2, ADDRESS_STREET3, ADDRESS_CITY, ADDRESS_STATE, ADDRESS_COUNTRY, ADDRESS_POSTALCODE, PHONE, PHONE_NUMBER, PHONE_COUNTRYCODE, EMAIL_ADDRESS, UNIQUE_ID, DATE, STRING, PROVIDER_ID, IPV4, IPV6, MAID
      group_name: "AttributeName",
      match_key: "AttributeName",
      sub_type: "AttributeName",
      hashed: false,
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.schema_name #=> String
resp.schema_arn #=> String
resp.description #=> String
resp.mapped_input_fields #=> Array
resp.mapped_input_fields[0].field_name #=> String
resp.mapped_input_fields[0].type #=> String, one of "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID", "IPV4", "IPV6", "MAID"
resp.mapped_input_fields[0].group_name #=> String
resp.mapped_input_fields[0].match_key #=> String
resp.mapped_input_fields[0].sub_type #=> String
resp.mapped_input_fields[0].hashed #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :schema_name (required, String) —

    The name of the schema. There can’t be multiple ‘SchemaMappings` with the same name.

  • :description (String) —

    A description of the schema.

  • :mapped_input_fields (required, Array<Types::SchemaInputAttribute>) —

    A list of ‘MappedInputFields`. Each `MappedInputField` corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

  • :tags (Hash<String,String>) —

    The tags used to organize, track, or control access for this resource.

Returns:

See Also:



1055
1056
1057
1058
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1055

def create_schema_mapping(params = {}, options = {})
  req = build_request(:create_schema_mapping, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_id_mapping_workflow({
  workflow_name: "EntityName", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow to be deleted.

Returns:

See Also:



1084
1085
1086
1087
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1084

def delete_id_mapping_workflow(params = {}, options = {})
  req = build_request(:delete_id_mapping_workflow, params)
  req.send_request(options)
end

#delete_id_namespace(params = {}) ⇒ Types::DeleteIdNamespaceOutput

Deletes the ‘IdNamespace` with a given name.

Examples:

Request syntax with placeholder values


resp = client.delete_id_namespace({
  id_namespace_name: "EntityName", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id_namespace_name (required, String) —

    The name of the ID namespace.

Returns:

See Also:



1112
1113
1114
1115
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1112

def delete_id_namespace(params = {}, options = {})
  req = build_request(:delete_id_namespace, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_matching_workflow({
  workflow_name: "EntityName", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow to be retrieved.

Returns:

See Also:



1141
1142
1143
1144
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1141

def delete_matching_workflow(params = {}, options = {})
  req = build_request(:delete_matching_workflow, params)
  req.send_request(options)
end

#delete_policy_statement(params = {}) ⇒ Types::DeletePolicyStatementOutput

Deletes the policy statement.

Examples:

Request syntax with placeholder values


resp = client.delete_policy_statement({
  arn: "VeniceGlobalArn", # required
  statement_id: "StatementId", # required
})

Response structure


resp.arn #=> String
resp.token #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the resource for which the policy need to be deleted.

  • :statement_id (required, String) —

    A statement identifier that differentiates the statement from others in the same policy.

Returns:

See Also:



1178
1179
1180
1181
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1178

def delete_policy_statement(params = {}, options = {})
  req = build_request(:delete_policy_statement, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.delete_schema_mapping({
  schema_name: "EntityName", # required
})

Response structure


resp.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :schema_name (required, String) —

    The name of the schema to delete.

Returns:

See Also:



1209
1210
1211
1212
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1209

def delete_schema_mapping(params = {}, options = {})
  req = build_request(:delete_schema_mapping, params)
  req.send_request(options)
end

#generate_match_id(params = {}) ⇒ Types::GenerateMatchIdOutput

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.

Examples:

Request syntax with placeholder values


resp = client.generate_match_id({
  workflow_name: "EntityName", # required
  records: [ # required
    {
      input_source_arn: "RecordInputSourceARNString", # required
      unique_id: "UniqueId", # required
      record_attribute_map: { # required
        "RecordAttributeMapString255KeyString" => "RecordAttributeMapString255ValueString",
      },
    },
  ],
  processing_type: "CONSISTENT", # accepts CONSISTENT, EVENTUAL, EVENTUAL_NO_LOOKUP
})

Response structure


resp.match_groups #=> Array
resp.match_groups[0].records #=> Array
resp.match_groups[0].records[0].input_source_arn #=> String
resp.match_groups[0].records[0].record_id #=> String
resp.match_groups[0].match_id #=> String
resp.match_groups[0].match_rule #=> String
resp.failed_records #=> Array
resp.failed_records[0].input_source_arn #=> String
resp.failed_records[0].unique_id #=> String
resp.failed_records[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the rule-based matching workflow.

  • :records (required, Array<Types::Record>) —

    The records to match.

  • :processing_type (String) —

    The processing mode that determines how Match IDs are generated and results are saved. Each mode provides different levels of accuracy, response time, and completeness of results.

    If not specified, defaults to ‘CONSISTENT`.

    ‘CONSISTENT`: Performs immediate lookup and matching against all existing records, with results saved synchronously. Provides highest accuracy but slower response time.

    ‘EVENTUAL` (shown as Background in the console): Performs initial match ID lookup or generation immediately, with record updates processed asynchronously in the background. Offers faster initial response time, with complete matching results available later in S3.

    ‘EVENTUAL_NO_LOOKUP` (shown as *Quick ID generation* in the console): Generates new match IDs without checking existing matches, with updates processed asynchronously. Provides fastest response time but should only be used for records known to be unique.

Returns:

See Also:



1292
1293
1294
1295
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1292

def generate_match_id(params = {}, options = {})
  req = build_request(:generate_match_id, params)
  req.send_request(options)
end

#get_id_mapping_job(params = {}) ⇒ Types::GetIdMappingJobOutput

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Examples:

Request syntax with placeholder values


resp = client.get_id_mapping_job({
  workflow_name: "EntityNameOrIdMappingWorkflowArn", # required
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "QUEUED"
resp.start_time #=> Time
resp.end_time #=> Time
resp.metrics.input_records #=> Integer
resp.metrics.total_records_processed #=> Integer
resp.metrics.records_not_processed #=> Integer
resp.metrics.total_mapped_records #=> Integer
resp.metrics.total_mapped_source_records #=> Integer
resp.metrics.total_mapped_target_records #=> Integer
resp.metrics.unique_records_loaded #=> Integer
resp.error_details.error_message #=> String
resp.output_source_config #=> Array
resp.output_source_config[0].role_arn #=> String
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow.

  • :job_id (required, String) —

    The ID of the job.

Returns:

See Also:



1346
1347
1348
1349
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1346

def get_id_mapping_job(params = {}, options = {})
  req = build_request(:get_id_mapping_job, params)
  req.send_request(options)
end

#get_id_mapping_workflow(params = {}) ⇒ Types::GetIdMappingWorkflowOutput

Returns the ‘IdMappingWorkflow` with a given name, if it exists.

Examples:

Request syntax with placeholder values


resp = client.get_id_mapping_workflow({
  workflow_name: "EntityName", # required
})

Response structure


resp.workflow_name #=> String
resp.workflow_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.input_source_config[0].type #=> String, one of "SOURCE", "TARGET"
resp.output_source_config #=> Array
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String
resp.id_mapping_techniques.id_mapping_type #=> String, one of "PROVIDER", "RULE_BASED"
resp.id_mapping_techniques.rule_based_properties.rules #=> Array
resp.id_mapping_techniques.rule_based_properties.rules[0].rule_name #=> String
resp.id_mapping_techniques.rule_based_properties.rules[0].matching_keys #=> Array
resp.id_mapping_techniques.rule_based_properties.rules[0].matching_keys[0] #=> String
resp.id_mapping_techniques.rule_based_properties.rule_definition_type #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.id_mapping_techniques.rule_based_properties.record_matching_model #=> String, one of "ONE_SOURCE_TO_ONE_TARGET", "MANY_SOURCE_TO_ONE_TARGET"
resp.id_mapping_techniques.provider_properties.provider_service_arn #=> String
resp.id_mapping_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.role_arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow.

Returns:

See Also:



1407
1408
1409
1410
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1407

def get_id_mapping_workflow(params = {}, options = {})
  req = build_request(:get_id_mapping_workflow, params)
  req.send_request(options)
end

#get_id_namespace(params = {}) ⇒ Types::GetIdNamespaceOutput

Returns the ‘IdNamespace` with a given name, if it exists.

Examples:

Request syntax with placeholder values


resp = client.get_id_namespace({
  id_namespace_name: "EntityNameOrIdNamespaceArn", # required
})

Response structure


resp.id_namespace_name #=> String
resp.id_namespace_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.id_mapping_workflow_properties #=> Array
resp.id_mapping_workflow_properties[0].id_mapping_type #=> String, one of "PROVIDER", "RULE_BASED"
resp.id_mapping_workflow_properties[0].rule_based_properties.rules #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].rule_name #=> String
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].matching_keys #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].matching_keys[0] #=> String
resp.id_mapping_workflow_properties[0].rule_based_properties.rule_definition_types #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rule_definition_types[0] #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_workflow_properties[0].rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.id_mapping_workflow_properties[0].rule_based_properties.record_matching_models #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.record_matching_models[0] #=> String, one of "ONE_SOURCE_TO_ONE_TARGET", "MANY_SOURCE_TO_ONE_TARGET"
resp.id_mapping_workflow_properties[0].provider_properties.provider_service_arn #=> String
resp.type #=> String, one of "SOURCE", "TARGET"
resp.role_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id_namespace_name (required, String) —

    The name of the ID namespace.

Returns:

See Also:



1467
1468
1469
1470
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1467

def get_id_namespace(params = {}, options = {})
  req = build_request(:get_id_namespace, params)
  req.send_request(options)
end

#get_match_id(params = {}) ⇒ Types::GetMatchIdOutput

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.

Examples:

Request syntax with placeholder values


resp = client.get_match_id({
  workflow_name: "EntityName", # required
  record: { # required
    "RecordAttributeMapKeyString" => "RecordAttributeMapValueString",
  },
  apply_normalization: false,
})

Response structure


resp.match_id #=> String
resp.match_rule #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow.

  • :record (required, Hash<String,String>) —

    The record to fetch the Match ID for.

  • :apply_normalization (Boolean) —

    Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an ‘AttributeType` of `PHONE_NUMBER`, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

Returns:

See Also:



1515
1516
1517
1518
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1515

def get_match_id(params = {}, options = {})
  req = build_request(:get_match_id, params)
  req.send_request(options)
end

#get_matching_job(params = {}) ⇒ Types::GetMatchingJobOutput

Returns the status, metrics, and errors (if there are any) that are associated with a job.

Examples:

Request syntax with placeholder values


resp = client.get_matching_job({
  workflow_name: "EntityName", # required
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "QUEUED"
resp.start_time #=> Time
resp.end_time #=> Time
resp.metrics.input_records #=> Integer
resp.metrics.total_records_processed #=> Integer
resp.metrics.records_not_processed #=> Integer
resp.metrics.match_i_ds #=> Integer
resp.error_details.error_message #=> String
resp.output_source_config #=> Array
resp.output_source_config[0].role_arn #=> String
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow.

  • :job_id (required, String) —

    The ID of the job.

Returns:

See Also:



1566
1567
1568
1569
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1566

def get_matching_job(params = {}, options = {})
  req = build_request(:get_matching_job, params)
  req.send_request(options)
end

#get_matching_workflow(params = {}) ⇒ Types::GetMatchingWorkflowOutput

Returns the ‘MatchingWorkflow` with a given name, if it exists.

Examples:

Request syntax with placeholder values


resp = client.get_matching_workflow({
  workflow_name: "EntityName", # required
})

Response structure


resp.workflow_name #=> String
resp.workflow_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.input_source_config[0].apply_normalization #=> Boolean
resp.output_source_config #=> Array
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String
resp.output_source_config[0].output #=> Array
resp.output_source_config[0].output[0].name #=> String
resp.output_source_config[0].output[0].hashed #=> Boolean
resp.output_source_config[0].apply_normalization #=> Boolean
resp.resolution_techniques.resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
resp.resolution_techniques.rule_based_properties.rules #=> Array
resp.resolution_techniques.rule_based_properties.rules[0].rule_name #=> String
resp.resolution_techniques.rule_based_properties.rules[0].matching_keys #=> Array
resp.resolution_techniques.rule_based_properties.rules[0].matching_keys[0] #=> String
resp.resolution_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.resolution_techniques.rule_based_properties.match_purpose #=> String, one of "IDENTIFIER_GENERATION", "INDEXING"
resp.resolution_techniques.rule_condition_properties.rules #=> Array
resp.resolution_techniques.rule_condition_properties.rules[0].rule_name #=> String
resp.resolution_techniques.rule_condition_properties.rules[0].condition #=> String
resp.resolution_techniques.provider_properties.provider_service_arn #=> String
resp.resolution_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.incremental_run_config.incremental_run_type #=> String, one of "IMMEDIATE"
resp.role_arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow.

Returns:

See Also:



1635
1636
1637
1638
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1635

def get_matching_workflow(params = {}, options = {})
  req = build_request(:get_matching_workflow, params)
  req.send_request(options)
end

#get_policy(params = {}) ⇒ Types::GetPolicyOutput

Returns the resource-based policy.

Examples:

Request syntax with placeholder values


resp = client.get_policy({
  arn: "VeniceGlobalArn", # required
})

Response structure


resp.arn #=> String
resp.token #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which the policy need to be returned.

Returns:

See Also:



1668
1669
1670
1671
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1668

def get_policy(params = {}, options = {})
  req = build_request(:get_policy, params)
  req.send_request(options)
end

#get_provider_service(params = {}) ⇒ Types::GetProviderServiceOutput

Returns the ‘ProviderService` of a given name.

Examples:

Request syntax with placeholder values


resp = client.get_provider_service({
  provider_name: "EntityName", # required
  provider_service_name: "ProviderServiceArn", # required
})

Response structure


resp.provider_name #=> String
resp.provider_service_name #=> String
resp.provider_service_display_name #=> String
resp.provider_service_type #=> String, one of "ASSIGNMENT", "ID_MAPPING"
resp.provider_service_arn #=> String
resp.provider_id_name_space_configuration.description #=> String
resp.provider_endpoint_configuration.marketplace_configuration.data_set_id #=> String
resp.provider_endpoint_configuration.marketplace_configuration.revision_id #=> String
resp.provider_endpoint_configuration.marketplace_configuration.asset_id #=> String
resp.provider_endpoint_configuration.marketplace_configuration.listing_id #=> String
resp.anonymized_output #=> Boolean
resp.provider_intermediate_data_access_configuration. #=> Array
resp.provider_intermediate_data_access_configuration.[0] #=> String
resp.provider_intermediate_data_access_configuration.required_bucket_actions #=> Array
resp.provider_intermediate_data_access_configuration.required_bucket_actions[0] #=> String
resp.provider_component_schema.schemas #=> Array
resp.provider_component_schema.schemas[0] #=> Array
resp.provider_component_schema.schemas[0][0] #=> String
resp.provider_component_schema.provider_schema_attributes #=> Array
resp.provider_component_schema.provider_schema_attributes[0].field_name #=> String
resp.provider_component_schema.provider_schema_attributes[0].type #=> String, one of "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID", "IPV4", "IPV6", "MAID"
resp.provider_component_schema.provider_schema_attributes[0].sub_type #=> String
resp.provider_component_schema.provider_schema_attributes[0].hashing #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :provider_name (required, String) —

    The name of the provider. This name is typically the company name.

  • :provider_service_name (required, String) —

    The ARN (Amazon Resource Name) of the product that the provider service provides.

Returns:

See Also:



1735
1736
1737
1738
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1735

def get_provider_service(params = {}, options = {})
  req = build_request(:get_provider_service, params)
  req.send_request(options)
end

#get_schema_mapping(params = {}) ⇒ Types::GetSchemaMappingOutput

Returns the SchemaMapping of a given name.

Examples:

Request syntax with placeholder values


resp = client.get_schema_mapping({
  schema_name: "EntityName", # required
})

Response structure


resp.schema_name #=> String
resp.schema_arn #=> String
resp.description #=> String
resp.mapped_input_fields #=> Array
resp.mapped_input_fields[0].field_name #=> String
resp.mapped_input_fields[0].type #=> String, one of "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID", "IPV4", "IPV6", "MAID"
resp.mapped_input_fields[0].group_name #=> String
resp.mapped_input_fields[0].match_key #=> String
resp.mapped_input_fields[0].sub_type #=> String
resp.mapped_input_fields[0].hashed #=> Boolean
resp.created_at #=> Time
resp.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.has_workflows #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :schema_name (required, String) —

    The name of the schema to be retrieved.

Returns:

See Also:



1784
1785
1786
1787
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1784

def get_schema_mapping(params = {}, options = {})
  req = build_request(:get_schema_mapping, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_id_mapping_jobs({
  workflow_name: "EntityNameOrIdMappingWorkflowArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_id #=> String
resp.jobs[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "QUEUED"
resp.jobs[0].start_time #=> Time
resp.jobs[0].end_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow to be retrieved.

  • :next_token (String) —

    The pagination token from the previous API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1828
1829
1830
1831
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1828

def list_id_mapping_jobs(params = {}, options = {})
  req = build_request(:list_id_mapping_jobs, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_id_mapping_workflows({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workflow_summaries #=> Array
resp.workflow_summaries[0].workflow_name #=> String
resp.workflow_summaries[0].workflow_arn #=> String
resp.workflow_summaries[0].created_at #=> Time
resp.workflow_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1869
1870
1871
1872
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1869

def list_id_mapping_workflows(params = {}, options = {})
  req = build_request(:list_id_mapping_workflows, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_id_namespaces({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.id_namespace_summaries #=> Array
resp.id_namespace_summaries[0].id_namespace_name #=> String
resp.id_namespace_summaries[0].id_namespace_arn #=> String
resp.id_namespace_summaries[0].description #=> String
resp.id_namespace_summaries[0].id_mapping_workflow_properties #=> Array
resp.id_namespace_summaries[0].id_mapping_workflow_properties[0].id_mapping_type #=> String, one of "PROVIDER", "RULE_BASED"
resp.id_namespace_summaries[0].type #=> String, one of "SOURCE", "TARGET"
resp.id_namespace_summaries[0].created_at #=> Time
resp.id_namespace_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous API call.

  • :max_results (Integer) —

    The maximum number of ‘IdNamespace` objects returned per page.

Returns:

See Also:



1913
1914
1915
1916
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1913

def list_id_namespaces(params = {}, options = {})
  req = build_request(:list_id_namespaces, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_matching_jobs({
  workflow_name: "EntityName", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_id #=> String
resp.jobs[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "QUEUED"
resp.jobs[0].start_time #=> Time
resp.jobs[0].end_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow to be retrieved.

  • :next_token (String) —

    The pagination token from the previous API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1957
1958
1959
1960
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1957

def list_matching_jobs(params = {}, options = {})
  req = build_request(:list_matching_jobs, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_matching_workflows({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workflow_summaries #=> Array
resp.workflow_summaries[0].workflow_name #=> String
resp.workflow_summaries[0].workflow_arn #=> String
resp.workflow_summaries[0].created_at #=> Time
resp.workflow_summaries[0].updated_at #=> Time
resp.workflow_summaries[0].resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



1999
2000
2001
2002
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 1999

def list_matching_workflows(params = {}, options = {})
  req = build_request(:list_matching_workflows, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_provider_services({
  next_token: "NextToken",
  max_results: 1,
  provider_name: "EntityName",
})

Response structure


resp.provider_service_summaries #=> Array
resp.provider_service_summaries[0].provider_service_arn #=> String
resp.provider_service_summaries[0].provider_name #=> String
resp.provider_service_summaries[0].provider_service_display_name #=> String
resp.provider_service_summaries[0].provider_service_name #=> String
resp.provider_service_summaries[0].provider_service_type #=> String, one of "ASSIGNMENT", "ID_MAPPING"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

  • :provider_name (String) —

    The name of the provider. This name is typically the company name.

Returns:

See Also:



2045
2046
2047
2048
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2045

def list_provider_services(params = {}, options = {})
  req = build_request(:list_provider_services, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_schema_mappings({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.schema_list #=> Array
resp.schema_list[0].schema_name #=> String
resp.schema_list[0].schema_arn #=> String
resp.schema_list[0].created_at #=> Time
resp.schema_list[0].updated_at #=> Time
resp.schema_list[0].has_workflows #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token from the previous API call.

  • :max_results (Integer) —

    The maximum number of objects returned per page.

Returns:

See Also:



2087
2088
2089
2090
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2087

def list_schema_mappings(params = {}, options = {})
  req = build_request(:list_schema_mappings, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "VeniceGlobalArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource for which you want to view tags.

Returns:

See Also:



2118
2119
2120
2121
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2118

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_policy(params = {}) ⇒ Types::PutPolicyOutput

Updates the resource-based policy.

Examples:

Request syntax with placeholder values


resp = client.put_policy({
  arn: "VeniceGlobalArn", # required
  token: "PolicyToken",
  policy: "PolicyDocument", # required
})

Response structure


resp.arn #=> String
resp.token #=> String
resp.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which the policy needs to be updated.

  • :token (String) —

    A unique identifier for the current revision of the policy.

  • :policy (required, String) —

    The resource-based policy.

    If you set the value of the ‘effect` parameter in the `policy` to `Deny` for the `PutPolicy` operation, you must also set the value of the `effect` parameter to `Deny` for the `AddPolicyStatement` operation.

Returns:

See Also:



2164
2165
2166
2167
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2164

def put_policy(params = {}, options = {})
  req = build_request(:put_policy, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.start_id_mapping_job({
  workflow_name: "EntityNameOrIdMappingWorkflowArn", # required
  output_source_config: [
    {
      role_arn: "RoleArn", # required
      output_s3_path: "S3Path", # required
      kms_arn: "KMSArn",
    },
  ],
})

Response structure


resp.job_id #=> String
resp.output_source_config #=> Array
resp.output_source_config[0].role_arn #=> String
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the ID mapping job to be retrieved.

  • :output_source_config (Array<Types::IdMappingJobOutputSource>) —

    A list of ‘OutputSource` objects.

Returns:

See Also:



2208
2209
2210
2211
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2208

def start_id_mapping_job(params = {}, options = {})
  req = build_request(:start_id_mapping_job, params)
  req.send_request(options)
end

#start_matching_job(params = {}) ⇒ Types::StartMatchingJobOutput

Starts the ‘MatchingJob` of a workflow. The workflow must have previously been created using the `CreateMatchingWorkflow` endpoint.

Examples:

Request syntax with placeholder values


resp = client.start_matching_job({
  workflow_name: "EntityName", # required
})

Response structure


resp.job_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the matching job to be retrieved.

Returns:

See Also:



2237
2238
2239
2240
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2237

def start_matching_job(params = {}, options = {})
  req = build_request(:start_matching_job, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "VeniceGlobalArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource for which you want to view tags.

  • :tags (required, Hash<String,String>) —

    The tags used to organize, track, or control access for this resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2276
2277
2278
2279
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2276

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "VeniceGlobalArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource for which you want to untag.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2304
2305
2306
2307
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2304

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_id_mapping_workflow({
  workflow_name: "EntityName", # required
  description: "Description",
  input_source_config: [ # required
    {
      input_source_arn: "IdMappingWorkflowInputSourceInputSourceARNString", # required
      schema_name: "EntityName",
      type: "SOURCE", # accepts SOURCE, TARGET
    },
  ],
  output_source_config: [
    {
      output_s3_path: "S3Path", # required
      kms_arn: "KMSArn",
    },
  ],
  id_mapping_techniques: { # required
    id_mapping_type: "PROVIDER", # required, accepts PROVIDER, RULE_BASED
    rule_based_properties: {
      rules: [
        {
          rule_name: "RuleRuleNameString", # required
          matching_keys: ["AttributeName"], # required
        },
      ],
      rule_definition_type: "SOURCE", # required, accepts SOURCE, TARGET
      attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
      record_matching_model: "ONE_SOURCE_TO_ONE_TARGET", # required, accepts ONE_SOURCE_TO_ONE_TARGET, MANY_SOURCE_TO_ONE_TARGET
    },
    provider_properties: {
      provider_service_arn: "ProviderServiceArn", # required
      provider_configuration: {
      },
      intermediate_source_configuration: {
        intermediate_s3_path: "S3Path", # required
      },
    },
  },
  role_arn: "IdMappingRoleArn",
})

Response structure


resp.workflow_name #=> String
resp.workflow_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.input_source_config[0].type #=> String, one of "SOURCE", "TARGET"
resp.output_source_config #=> Array
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String
resp.id_mapping_techniques.id_mapping_type #=> String, one of "PROVIDER", "RULE_BASED"
resp.id_mapping_techniques.rule_based_properties.rules #=> Array
resp.id_mapping_techniques.rule_based_properties.rules[0].rule_name #=> String
resp.id_mapping_techniques.rule_based_properties.rules[0].matching_keys #=> Array
resp.id_mapping_techniques.rule_based_properties.rules[0].matching_keys[0] #=> String
resp.id_mapping_techniques.rule_based_properties.rule_definition_type #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.id_mapping_techniques.rule_based_properties.record_matching_model #=> String, one of "ONE_SOURCE_TO_ONE_TARGET", "MANY_SOURCE_TO_ONE_TARGET"
resp.id_mapping_techniques.provider_properties.provider_service_arn #=> String
resp.id_mapping_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
resp.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow.

  • :description (String) —

    A description of the workflow.

  • :input_source_config (required, Array<Types::IdMappingWorkflowInputSource>) —

    A list of ‘InputSource` objects, which have the fields `InputSourceARN` and `SchemaName`.

  • :output_source_config (Array<Types::IdMappingWorkflowOutputSource>) —

    A list of ‘OutputSource` objects, each of which contains fields `outputS3Path` and `KMSArn`.

  • :id_mapping_techniques (required, Types::IdMappingTechniques) —

    An object which defines the ID mapping technique and any additional configurations.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf.

Returns:

See Also:



2418
2419
2420
2421
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2418

def update_id_mapping_workflow(params = {}, options = {})
  req = build_request(:update_id_mapping_workflow, params)
  req.send_request(options)
end

#update_id_namespace(params = {}) ⇒ Types::UpdateIdNamespaceOutput

Updates an existing ID namespace.

Examples:

Request syntax with placeholder values


resp = client.update_id_namespace({
  id_namespace_name: "EntityName", # required
  description: "Description",
  input_source_config: [
    {
      input_source_arn: "IdNamespaceInputSourceInputSourceARNString", # required
      schema_name: "EntityName",
    },
  ],
  id_mapping_workflow_properties: [
    {
      id_mapping_type: "PROVIDER", # required, accepts PROVIDER, RULE_BASED
      rule_based_properties: {
        rules: [
          {
            rule_name: "RuleRuleNameString", # required
            matching_keys: ["AttributeName"], # required
          },
        ],
        rule_definition_types: ["SOURCE"], # accepts SOURCE, TARGET
        attribute_matching_model: "ONE_TO_ONE", # accepts ONE_TO_ONE, MANY_TO_MANY
        record_matching_models: ["ONE_SOURCE_TO_ONE_TARGET"], # accepts ONE_SOURCE_TO_ONE_TARGET, MANY_SOURCE_TO_ONE_TARGET
      },
      provider_properties: {
        provider_service_arn: "ProviderServiceArn", # required
        provider_configuration: {
        },
      },
    },
  ],
  role_arn: "RoleArn",
})

Response structure


resp.id_namespace_name #=> String
resp.id_namespace_arn #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.id_mapping_workflow_properties #=> Array
resp.id_mapping_workflow_properties[0].id_mapping_type #=> String, one of "PROVIDER", "RULE_BASED"
resp.id_mapping_workflow_properties[0].rule_based_properties.rules #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].rule_name #=> String
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].matching_keys #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rules[0].matching_keys[0] #=> String
resp.id_mapping_workflow_properties[0].rule_based_properties.rule_definition_types #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.rule_definition_types[0] #=> String, one of "SOURCE", "TARGET"
resp.id_mapping_workflow_properties[0].rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.id_mapping_workflow_properties[0].rule_based_properties.record_matching_models #=> Array
resp.id_mapping_workflow_properties[0].rule_based_properties.record_matching_models[0] #=> String, one of "ONE_SOURCE_TO_ONE_TARGET", "MANY_SOURCE_TO_ONE_TARGET"
resp.id_mapping_workflow_properties[0].provider_properties.provider_service_arn #=> String
resp.type #=> String, one of "SOURCE", "TARGET"
resp.role_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id_namespace_name (required, String) —

    The name of the ID namespace.

  • :description (String) —

    The description of the ID namespace.

  • :input_source_config (Array<Types::IdNamespaceInputSource>) —

    A list of ‘InputSource` objects, which have the fields `InputSourceARN` and `SchemaName`.

  • :id_mapping_workflow_properties (Array<Types::IdNamespaceIdMappingWorkflowProperties>) —

    Determines the properties of ‘IdMappingWorkflow` where this `IdNamespace` can be used as a `Source` or a `Target`.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this ‘IdNamespace` on your behalf as part of a workflow run.

Returns:

See Also:



2520
2521
2522
2523
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2520

def update_id_namespace(params = {}, options = {})
  req = build_request(:update_id_namespace, params)
  req.send_request(options)
end

#update_matching_workflow(params = {}) ⇒ Types::UpdateMatchingWorkflowOutput

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.

Examples:

Request syntax with placeholder values


resp = client.update_matching_workflow({
  workflow_name: "EntityName", # required
  description: "Description",
  input_source_config: [ # required
    {
      input_source_arn: "InputSourceInputSourceARNString", # required
      schema_name: "EntityName", # required
      apply_normalization: false,
    },
  ],
  output_source_config: [ # required
    {
      output_s3_path: "S3Path", # required
      kms_arn: "KMSArn",
      output: [ # required
        {
          name: "AttributeName", # required
          hashed: false,
        },
      ],
      apply_normalization: false,
    },
  ],
  resolution_techniques: { # required
    resolution_type: "RULE_MATCHING", # required, accepts RULE_MATCHING, ML_MATCHING, PROVIDER
    rule_based_properties: {
      rules: [ # required
        {
          rule_name: "RuleRuleNameString", # required
          matching_keys: ["AttributeName"], # required
        },
      ],
      attribute_matching_model: "ONE_TO_ONE", # required, accepts ONE_TO_ONE, MANY_TO_MANY
      match_purpose: "IDENTIFIER_GENERATION", # accepts IDENTIFIER_GENERATION, INDEXING
    },
    rule_condition_properties: {
      rules: [ # required
        {
          rule_name: "RuleConditionRuleNameString", # required
          condition: "RuleConditionConditionString", # required
        },
      ],
    },
    provider_properties: {
      provider_service_arn: "ProviderServiceArn", # required
      provider_configuration: {
      },
      intermediate_source_configuration: {
        intermediate_s3_path: "S3Path", # required
      },
    },
  },
  incremental_run_config: {
    incremental_run_type: "IMMEDIATE", # accepts IMMEDIATE
  },
  role_arn: "String", # required
})

Response structure


resp.workflow_name #=> String
resp.description #=> String
resp.input_source_config #=> Array
resp.input_source_config[0].input_source_arn #=> String
resp.input_source_config[0].schema_name #=> String
resp.input_source_config[0].apply_normalization #=> Boolean
resp.output_source_config #=> Array
resp.output_source_config[0].output_s3_path #=> String
resp.output_source_config[0].kms_arn #=> String
resp.output_source_config[0].output #=> Array
resp.output_source_config[0].output[0].name #=> String
resp.output_source_config[0].output[0].hashed #=> Boolean
resp.output_source_config[0].apply_normalization #=> Boolean
resp.resolution_techniques.resolution_type #=> String, one of "RULE_MATCHING", "ML_MATCHING", "PROVIDER"
resp.resolution_techniques.rule_based_properties.rules #=> Array
resp.resolution_techniques.rule_based_properties.rules[0].rule_name #=> String
resp.resolution_techniques.rule_based_properties.rules[0].matching_keys #=> Array
resp.resolution_techniques.rule_based_properties.rules[0].matching_keys[0] #=> String
resp.resolution_techniques.rule_based_properties.attribute_matching_model #=> String, one of "ONE_TO_ONE", "MANY_TO_MANY"
resp.resolution_techniques.rule_based_properties.match_purpose #=> String, one of "IDENTIFIER_GENERATION", "INDEXING"
resp.resolution_techniques.rule_condition_properties.rules #=> Array
resp.resolution_techniques.rule_condition_properties.rules[0].rule_name #=> String
resp.resolution_techniques.rule_condition_properties.rules[0].condition #=> String
resp.resolution_techniques.provider_properties.provider_service_arn #=> String
resp.resolution_techniques.provider_properties.intermediate_source_configuration.intermediate_s3_path #=> String
resp.incremental_run_config.incremental_run_type #=> String, one of "IMMEDIATE"
resp.role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_name (required, String) —

    The name of the workflow to be retrieved.

  • :description (String) —

    A description of the workflow.

  • :input_source_config (required, Array<Types::InputSource>) —

    A list of ‘InputSource` objects, which have the fields `InputSourceARN` and `SchemaName`.

  • :output_source_config (required, Array<Types::OutputSource>) —

    A list of ‘OutputSource` objects, each of which contains fields `outputS3Path`, `applyNormalization`, `KMSArn`, and `output`.

  • :resolution_techniques (required, Types::ResolutionTechniques) —

    An object which defines the ‘resolutionType` and the `ruleBasedProperties`.

  • :incremental_run_config (Types::IncrementalRunConfig) —

    Optional. An object that defines the incremental run type. This object contains only the ‘incrementalRunType` field, which appears as “Automatic” in the console.

    For workflows where ‘resolutionType` is `ML_MATCHING`, incremental processing is not supported.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.

Returns:

See Also:



2666
2667
2668
2669
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2666

def update_matching_workflow(params = {}, options = {})
  req = build_request(:update_matching_workflow, params)
  req.send_request(options)
end

#update_schema_mapping(params = {}) ⇒ Types::UpdateSchemaMappingOutput

Updates a schema mapping.

<note markdown=“1”> 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.

</note>

Examples:

Request syntax with placeholder values


resp = client.update_schema_mapping({
  schema_name: "EntityName", # required
  description: "Description",
  mapped_input_fields: [ # required
    {
      field_name: "AttributeName", # required
      type: "NAME", # required, accepts NAME, NAME_FIRST, NAME_MIDDLE, NAME_LAST, ADDRESS, ADDRESS_STREET1, ADDRESS_STREET2, ADDRESS_STREET3, ADDRESS_CITY, ADDRESS_STATE, ADDRESS_COUNTRY, ADDRESS_POSTALCODE, PHONE, PHONE_NUMBER, PHONE_COUNTRYCODE, EMAIL_ADDRESS, UNIQUE_ID, DATE, STRING, PROVIDER_ID, IPV4, IPV6, MAID
      group_name: "AttributeName",
      match_key: "AttributeName",
      sub_type: "AttributeName",
      hashed: false,
    },
  ],
})

Response structure


resp.schema_name #=> String
resp.schema_arn #=> String
resp.description #=> String
resp.mapped_input_fields #=> Array
resp.mapped_input_fields[0].field_name #=> String
resp.mapped_input_fields[0].type #=> String, one of "NAME", "NAME_FIRST", "NAME_MIDDLE", "NAME_LAST", "ADDRESS", "ADDRESS_STREET1", "ADDRESS_STREET2", "ADDRESS_STREET3", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_COUNTRY", "ADDRESS_POSTALCODE", "PHONE", "PHONE_NUMBER", "PHONE_COUNTRYCODE", "EMAIL_ADDRESS", "UNIQUE_ID", "DATE", "STRING", "PROVIDER_ID", "IPV4", "IPV6", "MAID"
resp.mapped_input_fields[0].group_name #=> String
resp.mapped_input_fields[0].match_key #=> String
resp.mapped_input_fields[0].sub_type #=> String
resp.mapped_input_fields[0].hashed #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :schema_name (required, String) —

    The name of the schema. There can’t be multiple ‘SchemaMappings` with the same name.

  • :description (String) —

    A description of the schema.

  • :mapped_input_fields (required, Array<Types::SchemaInputAttribute>) —

    A list of ‘MappedInputFields`. Each `MappedInputField` corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

Returns:

See Also:



2732
2733
2734
2735
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2732

def update_schema_mapping(params = {}, options = {})
  req = build_request(:update_schema_mapping, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2761
2762
2763
 
# File 'lib/aws-sdk-entityresolution/client.rb', line 2761

def waiter_names
  []
end