# get-id-mapping-workflow ## Description Returns the `IdMappingWorkflow` with a given name, if it exists. See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/entityresolution-2018-05-10/GetIdMappingWorkflow) `get-id-mapping-workflow` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type `document` must be provided as JSON. Shorthand syntax does not support document types. ## Synopsis ``` get-id-mapping-workflow --workflow-name [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--workflow-name` (string) [required] > The name of the workflow. > Constraints: > * min: `1` > * max: `255` > * pattern: `[a-zA-Z_0-9-]*` `--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 * off `--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. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced `--help` (boolean) Display help for the command/subcommand. ## Output workflowName -> (string) > The name of the workflow. > Constraints: > * min: `1` > * max: `255` > * pattern: `[a-zA-Z_0-9-]*` workflowArn -> (string) > The ARN (Amazon Resource Name) that Entity Resolution generated for the `IdMappingWorkflow` . > Constraints: > * pattern: `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})` description -> (string) > A description of the workflow. > Constraints: > * min: `0` > * max: `255` inputSourceConfig -> (list) > A list of `InputSource` objects, which have the fields `InputSourceARN` and `SchemaName` . > Constraints: > * min: `1` > * max: `20` > (structure) > > An object containing `inputSourceARN` , `schemaName` , and `type` . > > inputSourceARN -> (string) [required] > > > An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table. > > > Constraints: > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(idnamespace/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):entityresolution:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(matchingworkflow/[a-zA-Z_0-9-]{1,255})$|^arn:(aws|aws-us-gov|aws-cn):glue:[a-z]{2}-[a-z]{1,10}-[0-9]:[0-9]{12}:(table/[a-zA-Z_0-9-]{1,255}/[a-zA-Z_0-9-]{1,255})` > > schemaName -> (string) > > > The name of the schema to be retrieved. > > > Constraints: > > > * min: `1` > > > * max: `255` > > > * pattern: `[a-zA-Z_0-9-]*` > > 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. > > > Possible values: > > > * `SOURCE` > > > * `TARGET` outputSourceConfig -> (list) > A list of `OutputSource` objects, each of which contains fields `outputS3Path` and `KMSArn` . > Constraints: > * min: `1` > * max: `1` > (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. > > > Constraints: > > > * pattern: `arn:aws:kms:.*:[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](/.*)?` idMappingTechniques -> (structure) > An object which defines the ID mapping technique and any additional configurations. > idMappingType -> (string) [required] > > The type of ID mapping. > > Possible values: > > * `PROVIDER` > > * `RULE_BASED` > ruleBasedProperties -> (structure) > > An object which defines any additional configurations required by rule-based matching. > > rules -> (list) > > > The rules that can be used for ID mapping. > > > Constraints: > > > * min: `1` > > > * max: `25` > > > (structure) > > > > An object containing the `ruleName` and `matchingKeys` . > > > > ruleName -> (string) [required] > > > > > A name for the matching rule. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `255` > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > > > matchingKeys -> (list) [required] > > > > > 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. > > > > > Constraints: > > > > > * min: `0` > > > > > * max: `15` > > > > > (string) > > > > > > Constraints: > > > > > > * min: `0` > > > > > > * max: `255` > > > > > > * pattern: `[a-zA-Z_0-9- ]*` > > ruleDefinitionType -> (string) [required] > > > 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. > > > Possible values: > > > * `SOURCE` > > > * `TARGET` > > attributeMatchingModel -> (string) [required] > > > The comparison type. You can either choose `ONE_TO_ONE` or `MANY_TO_MANY` as the `attributeMatchingModel` . > > > 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. > > > 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. > > > Possible values: > > > * `ONE_TO_ONE` > > > * `MANY_TO_MANY` > > recordMatchingModel -> (string) [required] > > > 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. > > > Possible values: > > > * `ONE_SOURCE_TO_ONE_TARGET` > > > * `MANY_SOURCE_TO_ONE_TARGET` > providerProperties -> (structure) > > An object which defines any additional configurations required by the provider service. > > providerServiceArn -> (string) [required] > > > The ARN of the provider service. > > > Constraints: > > > * min: `20` > > > * max: `255` > > > * pattern: `arn:(aws|aws-us-gov|aws-cn):(entityresolution):([a-z]{2}-[a-z]{1,10}-[0-9])::providerservice/([a-zA-Z0-9_-]{1,255})/([a-zA-Z0-9_-]{1,255})` > > providerConfiguration -> (document) > > > The required configuration fields to use with 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) [required] > > > > The Amazon S3 location (bucket and prefix). For example: `s3://provider_bucket/DOC-EXAMPLE-BUCKET` > > > > Constraints: > > > > * min: `1` > > > > * max: `1024` > > > > * pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?` createdAt -> (timestamp) > The timestamp of when the workflow was created. updatedAt -> (timestamp) > The timestamp of when the workflow was last updated. incrementalRunConfig -> (structure) > The incremental run configuration for the ID mapping workflow. > incrementalRunType -> (string) > > The incremental run type for an ID mapping workflow. > > It takes only one value: `ON_DEMAND` . This setting runs the ID mapping workflow when it’s manually triggered through the `StartIdMappingJob` API. > > Possible values: > > * `ON_DEMAND` roleArn -> (string) > The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access Amazon Web Services resources on your behalf. > Constraints: > * min: `0` > * max: `512` > * pattern: `$|^arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` tags -> (map) > The tags used to organize, track, or control access for this resource. > Constraints: > * min: `0` > * max: `200` > key -> (string) > > Constraints: > > * min: `1` > > * max: `128` > value -> (string) > > Constraints: > > * min: `0` > > * max: `256`