[ aws . entityresolution ]

generate-match-id

Description

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.

See also: AWS API Documentation

Synopsis

  generate-match-id
--workflow-name <value>
--records <value>
[--processing-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--workflow-name (string)

The name of the rule-based matching workflow.

--records (list)

The records to match.

(structure)

The record.

inputSourceARN -> (string)

The input source ARN of the record.

uniqueId -> (string)

The unique ID of the record.

recordAttributeMap -> (map)

The record’s attribute map.

key -> (string)

value -> (string)

Shorthand Syntax:

inputSourceARN=string,uniqueId=string,recordAttributeMap={KeyName1=string,KeyName2=string} ...

JSON Syntax:

[
  {
    "inputSourceARN": "string",
    "uniqueId": "string",
    "recordAttributeMap": {"string": "string"
      ...}
  }
  ...
]

--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.

Possible values:

• CONSISTENT
• EVENTUAL
• EVENTUAL_NO_LOOKUP

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

matchGroups -> (list)

The match groups from the generated match ID.

(structure)

The match group.

records -> (list)

The matched records.

(structure)

The matched record.

inputSourceARN -> (string)

The input source ARN of the matched record.

recordId -> (string)

The record ID of the matched record.

matchId -> (string)

The match ID.

matchRule -> (string)

The match rule of the match group.

failedRecords -> (list)

The records that didn’t receive a generated Match ID.

(structure)

The record that didn’t generate a Match ID.

inputSourceARN -> (string)

The input source ARN of the record that didn’t generate a Match ID.

uniqueId -> (string)

The unique ID of the record that didn’t generate a Match ID.

errorMessage -> (string)

The error message for the record that didn’t generate a Match ID.