AWS CLI Command Reference

[ aws . entityresolution ]

get-id-mapping-job

Description

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

See also: AWS API Documentation

Synopsis

  get-id-mapping-job
--workflow-name <value>
--job-id <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) [required]

The name of the workflow.

Constraints:

  • pattern: [a-zA-Z_0-9-=+/]*$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idmappingworkflow/[a-zA-Z_0-9-]{1,255})

--job-id (string) [required]

The ID of the job.

Constraints:

  • pattern: [a-f0-9]{32}

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

jobId -> (string)

The ID of the job.

Constraints:

  • pattern: [a-f0-9]{32}

status -> (string)

The current status of the job.

Possible values:

  • RUNNING
  • SUCCEEDED
  • FAILED
  • QUEUED

startTime -> (timestamp)

The time at which the job was started.

endTime -> (timestamp)

The time at which the job has finished.

metrics -> (structure)

Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.

inputRecords -> (integer)

The total number of records that were input for processing.

totalRecordsProcessed -> (integer)

The total number of records that were processed.

recordsNotProcessed -> (integer)

The total number of records that did not get processed.

deleteRecordsProcessed -> (integer)

The number of records processed that were marked for deletion in the input file using the DELETE schema mapping field. These are the records to be removed from the ID mapping table.

totalMappedRecords -> (integer)

The total number of records that were mapped.

totalMappedSourceRecords -> (integer)

The total number of mapped source records.

totalMappedTargetRecords -> (integer)

The total number of distinct mapped target records.

uniqueRecordsLoaded -> (integer)

The number of de-duplicated processed records across all runs, excluding deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if you specified “customer_id” as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.

newMappedRecords -> (integer)

The number of new mapped records.

newMappedSourceRecords -> (integer)

The number of new source records mapped.

newMappedTargetRecords -> (integer)

The number of new mapped target records.

newUniqueRecordsLoaded -> (integer)

The number of new unique records processed in the current job run, after removing duplicates. This metric excludes deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if your current run processes five new records with the same UNIQUE_ID value, they would count as one new unique record in this metric.

mappedRecordsRemoved -> (integer)

The number of mapped records removed.

mappedSourceRecordsRemoved -> (integer)

The number of source records removed due to ID mapping.

mappedTargetRecordsRemoved -> (integer)

The number of mapped target records removed.

errorDetails -> (structure)

An object containing an error message, if there was an error.

errorMessage -> (string)

The error message from the job, if there is one.

Constraints:

  • min: 1
  • max: 2048

outputSourceConfig -> (list)

A list of OutputSource objects.

Constraints:

  • min: 1
  • max: 1

(structure)

An object containing KMSArn , outputS3Path , and roleARN .

roleArn -> (string) [required]

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

Constraints:

  • min: 32
  • max: 512
  • pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

outputS3Path -> (string) [required]

The S3 path to which Entity Resolution will write the output table.

Constraints:

  • min: 1
  • max: 1024
  • pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

KMSArn -> (string)

Customer KMS ARN for encryption at rest. If not provided, system will use an Entity Resolution managed KMS key.

Constraints:

  • pattern: arn:aws:kms:.*:[0-9]+:.*

jobType -> (string)

The job type of the ID mapping job.

A value of INCREMENTAL indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig .

A value of BATCH indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn’t created with an incrementalRunConfig .

A value of DELETE_ONLY indicates that only deletion requests from BatchDeleteUniqueIds were processed.

Possible values:

  • BATCH
  • INCREMENTAL
  • DELETE_ONLY
© Copyright 2025, Amazon Web Services. Created using Sphinx.