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

create-id-mapping-workflow¶

Description¶

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.

Synopsis¶

  create-id-mapping-workflow
[--description <value>]
--id-mapping-techniques <value>
--input-source-config <value>
[--output-source-config <value>]
[--role-arn <value>]
[--tags <value>]
--workflow-name <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¶

--description (string)

A description of the workflow.

--id-mapping-techniques (structure)

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

idMappingType -> (string)

The type of ID mapping.

providerProperties -> (structure)

An object which defines any additional configurations required by the provider service.

intermediateSourceConfiguration -> (structure)

The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.

intermediateS3Path -> (string)

The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET

providerConfiguration -> (document)

The required configuration fields to use with the provider service.

providerServiceArn -> (string)

The ARN of the provider service.

ruleBasedProperties -> (structure)

An object which defines any additional configurations required by rule-based matching.

attributeMatchingModel -> (string)

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

recordMatchingModel -> (string)

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source can be matched to the same record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET , multiple records in the source can be matched to one record in the target.

ruleDefinitionType -> (string)

The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.

rules -> (list)

The rules that can be used for ID mapping.

(structure)

An object containing RuleName , and MatchingKeys .

matchingKeys -> (list)

A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.

(string)

ruleName -> (string)

A name for the matching rule.

JSON Syntax:

{
  "idMappingType": "PROVIDER"|"RULE_BASED",
  "providerProperties": {
    "intermediateSourceConfiguration": {
      "intermediateS3Path": "string"
    },
    "providerConfiguration": {...},
    "providerServiceArn": "string"
  },
  "ruleBasedProperties": {
    "attributeMatchingModel": "ONE_TO_ONE"|"MANY_TO_MANY",
    "recordMatchingModel": "ONE_SOURCE_TO_ONE_TARGET"|"MANY_SOURCE_TO_ONE_TARGET",
    "ruleDefinitionType": "SOURCE"|"TARGET",
    "rules": [
      {
        "matchingKeys": ["string", ...],
        "ruleName": "string"
      }
      ...
    ]
  }
}

--input-source-config (list)

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

(structure)

An object containing InputSourceARN , SchemaName , and Type .

inputSourceARN -> (string)

An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

schemaName -> (string)

The name of the schema to be retrieved.

type -> (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 which all sourceIds will resolve to.

Shorthand Syntax:

inputSourceARN=string,schemaName=string,type=string ...

JSON Syntax:

[
  {
    "inputSourceARN": "string",
    "schemaName": "string",
    "type": "SOURCE"|"TARGET"
  }
  ...
]

--output-source-config (list)

A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .

(structure)

The output source for the ID mapping workflow.

KMSArn -> (string)

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

outputS3Path -> (string)

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

Shorthand Syntax:

KMSArn=string,outputS3Path=string ...

JSON Syntax:

[
  {
    "KMSArn": "string",
    "outputS3Path": "string"
  }
  ...
]

--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 (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--workflow-name (string)

The name of the workflow. There can't be multiple IdMappingWorkflows with the same name.

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

description -> (string)

A description of the workflow.

idMappingTechniques -> (structure)

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

idMappingType -> (string)

The type of ID mapping.

providerProperties -> (structure)

An object which defines any additional configurations required by the provider service.

intermediateSourceConfiguration -> (structure)

The Amazon S3 location that temporarily stores your data while it processes. Your information won't be saved permanently.

intermediateS3Path -> (string)

The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET

providerConfiguration -> (document)

The required configuration fields to use with the provider service.

providerServiceArn -> (string)

The ARN of the provider service.

ruleBasedProperties -> (structure)

An object which defines any additional configurations required by rule-based matching.

attributeMatchingModel -> (string)

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

recordMatchingModel -> (string)

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source can be matched to the same record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET , multiple records in the source can be matched to one record in the target.

ruleDefinitionType -> (string)

The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.

rules -> (list)

The rules that can be used for ID mapping.

(structure)

An object containing RuleName , and MatchingKeys .

matchingKeys -> (list)

A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.

(string)

ruleName -> (string)

A name for the matching rule.

inputSourceConfig -> (list)

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

(structure)

An object containing InputSourceARN , SchemaName , and Type .

inputSourceARN -> (string)

An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

schemaName -> (string)

The name of the schema to be retrieved.

type -> (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 which all sourceIds will resolve to.

outputSourceConfig -> (list)

A list of IdMappingWorkflowOutputSource objects, each of which contains fields OutputS3Path and Output .

(structure)

The output source for the ID mapping workflow.

KMSArn -> (string)

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

outputS3Path -> (string)

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

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

workflowArn -> (string)

The ARN (Amazon Resource Name) that Entity Resolution generated for the IDMappingWorkflow .

workflowName -> (string)

The name of the workflow.

Table Of Contents

Feedback

User Guide

Note:

create-id-mapping-workflow¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶