AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . customer-profiles ]

get-auto-merging-preview

Description

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.

You can't view which profiles are matched and would be merged.

Warning

We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName ), there may be a large number of matches. This increases the chances of erroneous merges.

See also: AWS API Documentation

Synopsis

  get-auto-merging-preview
--domain-name <value>
--consolidation <value>
--conflict-resolution <value>
[--min-allowed-confidence-score-for-merging <value>]
[--cli-input-json <value>]
[--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>]

Options

--domain-name (string)

The unique name of the domain.

--consolidation (structure)

A list of matching attributes that represent matching criteria.

MatchingAttributesList -> (list)

A list of matching criteria.

(list)

(string)

Shorthand Syntax:

MatchingAttributesList=[[string,string],[string,string]]

JSON Syntax:

{
  "MatchingAttributesList": [
    ["string", ...]
    ...
  ]
}

--conflict-resolution (structure)

How the auto-merging process should resolve conflicts between different profiles.

ConflictResolvingModel -> (string)

How the auto-merging process should resolve conflicts between different profiles.

  • RECENCY : Uses the data that was most recently updated.
  • SOURCE : Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

SourceName -> (string)

The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .

Shorthand Syntax:

ConflictResolvingModel=string,SourceName=string

JSON Syntax:

{
  "ConflictResolvingModel": "RECENCY"|"SOURCE",
  "SourceName": "string"
}

--min-allowed-confidence-score-for-merging (double)

Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

DomainName -> (string)

The unique name of the domain.

NumberOfMatchesInSample -> (long)

The number of match groups in the domain that have been reviewed in this preview dry run.

NumberOfProfilesInSample -> (long)

The number of profiles found in this preview dry run.

NumberOfProfilesWillBeMerged -> (long)

The number of profiles that would be merged if this wasn't a preview dry run.