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 ]

list-identity-resolution-jobs

Description

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime .

See also: AWS API Documentation

Synopsis

  list-identity-resolution-jobs
--domain-name <value>
[--next-token <value>]
[--max-results <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.

--next-token (string)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

--max-results (integer)

The maximum number of results to return per page.

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

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

IdentityResolutionJobsList -> (list)

A list of Identity Resolution Jobs.

(structure)

Information about the Identity Resolution Job.

DomainName -> (string)

The unique name of the domain.

JobId -> (string)

The unique identifier of the Identity Resolution Job.

Status -> (string)

The status of the Identity Resolution Job.

  • PENDING : The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.
  • PREPROCESSING : The Identity Resolution Job is loading your data.
  • FIND_MATCHING : The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.
  • MERGING : The Identity Resolution Job is merging duplicate profiles.
  • COMPLETED : The Identity Resolution Job completed successfully.
  • PARTIAL_SUCCESS : There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.
  • FAILED : The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

JobStartTime -> (timestamp)

The timestamp of when the job was started or will be started.

JobEndTime -> (timestamp)

The timestamp of when the job was completed.

JobStats -> (structure)

Statistics about an Identity Resolution Job.

NumberOfProfilesReviewed -> (long)

The number of profiles reviewed.

NumberOfMatchesFound -> (long)

The number of matches found.

NumberOfMergesDone -> (long)

The number of merges completed.

ExportingLocation -> (structure)

The S3 location where the Identity Resolution Job writes result files.

S3Exporting -> (structure)

Information about the S3 location where Identity Resolution Jobs write result files.

S3BucketName -> (string)

The name of the S3 bucket name where Identity Resolution Jobs write result files.

S3KeyName -> (string)

The S3 key name of the location where Identity Resolution Jobs write result files.

Message -> (string)

The error messages that are generated when the Identity Resolution Job runs.

NextToken -> (string)

If there are additional results, this is the token for the next set of results.