Class: AWS.EntityResolution

var params = {
  uniqueIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  workflowName: 'STRING_VALUE', /* required */
  inputSource: 'STRING_VALUE'
};
entityresolution.batchDeleteUniqueId(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • inputSource — (String)

    The input source for the batch delete unique ID operation.

  • uniqueIds — (Array<String>)

    The unique IDs to delete.

  • workflowName — (String)

    The name of the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • deleted — (Array<map>)

      The unique IDs that were deleted.

      • uniqueId — required — (String)

        The unique ID of the deleted item.

    • disconnectedUniqueIds — (Array<String>)

      The unique IDs that were disconnected.

    • errors — (Array<map>)

      The errors from deleting multiple unique IDs.

      • errorType — required — (String)

        The error type for the batch delete unique ID operation.

        Possible values include:
        • "SERVICE_ERROR"
        • "VALIDATION_ERROR"
      • uniqueId — required — (String)

        The unique ID that could not be deleted.

    • status — (String)

      The status of the batch delete unique ID operation.

      Possible values include:
      • "COMPLETED"
      • "ACCEPTED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  idMappingTechniques: { /* required */
    idMappingType: PROVIDER | RULE_BASED, /* required */
    providerProperties: {
      providerServiceArn: 'STRING_VALUE', /* required */
      intermediateSourceConfiguration: {
        intermediateS3Path: 'STRING_VALUE' /* required */
      },
      providerConfiguration: {
      }
    },
    ruleBasedProperties: {
      attributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY, /* required */
      recordMatchingModel: ONE_SOURCE_TO_ONE_TARGET | MANY_SOURCE_TO_ONE_TARGET, /* required */
      ruleDefinitionType: SOURCE | TARGET, /* required */
      rules: [
        {
          matchingKeys: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          ruleName: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  },
  inputSourceConfig: [ /* required */
    {
      inputSourceARN: 'STRING_VALUE', /* required */
      schemaName: 'STRING_VALUE',
      type: SOURCE | TARGET
    },
    /* more items */
  ],
  workflowName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  outputSourceConfig: [
    {
      outputS3Path: 'STRING_VALUE', /* required */
      KMSArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  roleArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
entityresolution.createIdMappingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    A description of the workflow.

  • idMappingTechniques — (map)

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

    • idMappingType — required — (String)

      The type of ID mapping.

      Possible values include:
      • "PROVIDER"
      • "RULE_BASED"
    • providerProperties — (map)

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

      • intermediateSourceConfiguration — (map)

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

        • intermediateS3Path — required — (String)

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

      • providerConfiguration — (map)

        The required configuration fields to use with the provider service.

      • providerServiceArn — required — (String)

        The ARN of the provider service.

    • ruleBasedProperties — (map)

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

      • attributeMatchingModel — required — (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.

        Possible values include:
        • "ONE_TO_ONE"
        • "MANY_TO_MANY"
      • recordMatchingModel — required — (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.

        Possible values include:
        • "ONE_SOURCE_TO_ONE_TARGET"
        • "MANY_SOURCE_TO_ONE_TARGET"
      • ruleDefinitionType — required — (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.

        Possible values include:
        • "SOURCE"
        • "TARGET"
      • rules — (Array<map>)

        The rules that can be used for ID mapping.

        • matchingKeys — required — (Array<String>)

          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.

        • ruleName — required — (String)

          A name for the matching rule.

  • inputSourceConfig — (Array<map>)

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

    • inputSourceARN — required — (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.

      Possible values include:
      • "SOURCE"
      • "TARGET"
  • outputSourceConfig — (Array<map>)

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

    • KMSArn — (String)

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

    • outputS3Path — required — (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.

  • tags — (map<String>)

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

  • workflowName — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • description — (String)

      A description of the workflow.

    • idMappingTechniques — (map)

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

      • idMappingType — required — (String)

        The type of ID mapping.

        Possible values include:
        • "PROVIDER"
        • "RULE_BASED"
      • providerProperties — (map)

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

        • intermediateSourceConfiguration — (map)

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

          • intermediateS3Path — required — (String)

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

        • providerConfiguration — (map)

          The required configuration fields to use with the provider service.

        • providerServiceArn — required — (String)

          The ARN of the provider service.

      • ruleBasedProperties — (map)

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

        • attributeMatchingModel — required — (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.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • recordMatchingModel — required — (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.

          Possible values include:
          • "ONE_SOURCE_TO_ONE_TARGET"
          • "MANY_SOURCE_TO_ONE_TARGET"
        • ruleDefinitionType — required — (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.

          Possible values include:
          • "SOURCE"
          • "TARGET"
        • rules — (Array<map>)

          The rules that can be used for ID mapping.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

    • inputSourceConfig — (Array<map>)

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

      • inputSourceARN — required — (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.

        Possible values include:
        • "SOURCE"
        • "TARGET"
    • outputSourceConfig — (Array<map>)

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

      • KMSArn — (String)

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

      • outputS3Path — required — (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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  idNamespaceName: 'STRING_VALUE', /* required */
  type: SOURCE | TARGET, /* required */
  description: 'STRING_VALUE',
  idMappingWorkflowProperties: [
    {
      idMappingType: PROVIDER | RULE_BASED, /* required */
      providerProperties: {
        providerServiceArn: 'STRING_VALUE', /* required */
        providerConfiguration: {
        }
      },
      ruleBasedProperties: {
        attributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY,
        recordMatchingModels: [
          ONE_SOURCE_TO_ONE_TARGET | MANY_SOURCE_TO_ONE_TARGET,
          /* more items */
        ],
        ruleDefinitionTypes: [
          SOURCE | TARGET,
          /* more items */
        ],
        rules: [
          {
            matchingKeys: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            ruleName: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  inputSourceConfig: [
    {
      inputSourceARN: 'STRING_VALUE', /* required */
      schemaName: 'STRING_VALUE'
    },
    /* more items */
  ],
  roleArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
entityresolution.createIdNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    The description of the ID namespace.

  • idMappingWorkflowProperties — (Array<map>)

    Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target.

    • idMappingType — required — (String)

      The type of ID mapping.

      Possible values include:
      • "PROVIDER"
      • "RULE_BASED"
    • providerProperties — (map)

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

      • providerConfiguration — (map)

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

      • providerServiceArn — required — (String)

        The Amazon Resource Name (ARN) of the provider service.

    • ruleBasedProperties — (map)

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

        Possible values include:
        • "ONE_TO_ONE"
        • "MANY_TO_MANY"
      • recordMatchingModels — (Array<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 is matched to one record in the target.

        If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.

      • ruleDefinitionTypes — (Array<String>)

        The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

      • rules — (Array<map>)

        The rules for the ID namespace.

        • matchingKeys — required — (Array<String>)

          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.

        • ruleName — required — (String)

          A name for the matching rule.

  • idNamespaceName — (String)

    The name of the ID namespace.

  • inputSourceConfig — (Array<map>)

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

    • inputSourceARN — required — (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.

  • roleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

  • tags — (map<String>)

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

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

    Possible values include:
    • "SOURCE"
    • "TARGET"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdAt — (Date)

      The timestamp of when the ID namespace was created.

    • description — (String)

      The description of the ID namespace.

    • idMappingWorkflowProperties — (Array<map>)

      Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

      • idMappingType — required — (String)

        The type of ID mapping.

        Possible values include:
        • "PROVIDER"
        • "RULE_BASED"
      • providerProperties — (map)

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

        • providerConfiguration — (map)

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

        • providerServiceArn — required — (String)

          The Amazon Resource Name (ARN) of the provider service.

      • ruleBasedProperties — (map)

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

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • recordMatchingModels — (Array<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 is matched to one record in the target.

          If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.

        • ruleDefinitionTypes — (Array<String>)

          The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

        • rules — (Array<map>)

          The rules for the ID namespace.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

    • idNamespaceArn — (String)

      The Amazon Resource Name (ARN) of the ID namespace.

    • idNamespaceName — (String)

      The name of the ID namespace.

    • inputSourceConfig — (Array<map>)

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

      • inputSourceARN — required — (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.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in inputSourceConfig on your behalf as part of the workflow run.

    • tags — (map<String>)

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

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

      Possible values include:
      • "SOURCE"
      • "TARGET"
    • updatedAt — (Date)

      The timestamp of when the ID namespace was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  inputSourceConfig: [ /* required */
    {
      inputSourceARN: 'STRING_VALUE', /* required */
      schemaName: 'STRING_VALUE', /* required */
      applyNormalization: true || false
    },
    /* more items */
  ],
  outputSourceConfig: [ /* required */
    {
      output: [ /* required */
        {
          name: 'STRING_VALUE', /* required */
          hashed: true || false
        },
        /* more items */
      ],
      outputS3Path: 'STRING_VALUE', /* required */
      KMSArn: 'STRING_VALUE',
      applyNormalization: true || false
    },
    /* more items */
  ],
  resolutionTechniques: { /* required */
    resolutionType: RULE_MATCHING | ML_MATCHING | PROVIDER, /* required */
    providerProperties: {
      providerServiceArn: 'STRING_VALUE', /* required */
      intermediateSourceConfiguration: {
        intermediateS3Path: 'STRING_VALUE' /* required */
      },
      providerConfiguration: {
      }
    },
    ruleBasedProperties: {
      attributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY, /* required */
      rules: [ /* required */
        {
          matchingKeys: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          ruleName: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      matchPurpose: IDENTIFIER_GENERATION | INDEXING
    }
  },
  roleArn: 'STRING_VALUE', /* required */
  workflowName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  incrementalRunConfig: {
    incrementalRunType: IMMEDIATE
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
entityresolution.createMatchingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    A description of the workflow.

  • incrementalRunConfig — (map)

    An object which defines an incremental run type and has only incrementalRunType as a field.

    • incrementalRunType — (String)

      The type of incremental run. It takes only one value: IMMEDIATE.

      Possible values include:
      • "IMMEDIATE"
  • inputSourceConfig — (Array<map>)

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

    • applyNormalization — (Boolean)

      Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

    • inputSourceARN — required — (String)

      An Glue table Amazon Resource Name (ARN) for the input source table.

    • schemaName — required — (String)

      The name of the schema to be retrieved.

  • outputSourceConfig — (Array<map>)

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

    • KMSArn — (String)

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

    • applyNormalization — (Boolean)

      Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

    • output — required — (Array<map>)

      A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

      • hashed — (Boolean)

        Enables the ability to hash the column values in the output.

      • name — required — (String)

        A name of a column to be written to the output. This must be an InputField name in the schema mapping.

    • outputS3Path — required — (String)

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

  • resolutionTechniques — (map)

    An object which defines the resolutionType and the ruleBasedProperties.

    • providerProperties — (map)

      The properties of the provider service.

      • intermediateSourceConfiguration — (map)

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

        • intermediateS3Path — required — (String)

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

      • providerConfiguration — (map)

        The required configuration fields to use with the provider service.

      • providerServiceArn — required — (String)

        The ARN of the provider service.

    • resolutionType — required — (String)

      The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.

      Possible values include:
      • "RULE_MATCHING"
      • "ML_MATCHING"
      • "PROVIDER"
    • ruleBasedProperties — (map)

      An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.

      • attributeMatchingModel — required — (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 and the value of BusinessEmail field of Profile B matches, 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.

        Possible values include:
        • "ONE_TO_ONE"
        • "MANY_TO_MANY"
      • matchPurpose — (String)

        An indicator of whether to generate IDs and index the data or not.

        If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.

        If you choose INDEXING, the process indexes the data without generating IDs.

        Possible values include:
        • "IDENTIFIER_GENERATION"
        • "INDEXING"
      • rules — required — (Array<map>)

        A list of Rule objects, each of which have fields RuleName and MatchingKeys.

        • matchingKeys — required — (Array<String>)

          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.

        • ruleName — required — (String)

          A name for the matching rule.

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

  • tags — (map<String>)

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

  • workflowName — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • description — (String)

      A description of the workflow.

    • incrementalRunConfig — (map)

      An object which defines an incremental run type and has only incrementalRunType as a field.

      • incrementalRunType — (String)

        The type of incremental run. It takes only one value: IMMEDIATE.

        Possible values include:
        • "IMMEDIATE"
    • inputSourceConfig — (Array<map>)

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

      • applyNormalization — (Boolean)

        Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

      • inputSourceARN — required — (String)

        An Glue table Amazon Resource Name (ARN) for the input source table.

      • schemaName — required — (String)

        The name of the schema to be retrieved.

    • outputSourceConfig — (Array<map>)

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

      • KMSArn — (String)

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

      • applyNormalization — (Boolean)

        Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

      • output — required — (Array<map>)

        A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

        • hashed — (Boolean)

          Enables the ability to hash the column values in the output.

        • name — required — (String)

          A name of a column to be written to the output. This must be an InputField name in the schema mapping.

      • outputS3Path — required — (String)

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

    • resolutionTechniques — (map)

      An object which defines the resolutionType and the ruleBasedProperties.

      • providerProperties — (map)

        The properties of the provider service.

        • intermediateSourceConfiguration — (map)

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

          • intermediateS3Path — required — (String)

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

        • providerConfiguration — (map)

          The required configuration fields to use with the provider service.

        • providerServiceArn — required — (String)

          The ARN of the provider service.

      • resolutionType — required — (String)

        The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.

        Possible values include:
        • "RULE_MATCHING"
        • "ML_MATCHING"
        • "PROVIDER"
      • ruleBasedProperties — (map)

        An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.

        • attributeMatchingModel — required — (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 and the value of BusinessEmail field of Profile B matches, 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.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • matchPurpose — (String)

          An indicator of whether to generate IDs and index the data or not.

          If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.

          If you choose INDEXING, the process indexes the data without generating IDs.

          Possible values include:
          • "IDENTIFIER_GENERATION"
          • "INDEXING"
        • rules — required — (Array<map>)

          A list of Rule objects, each of which have fields RuleName and MatchingKeys.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

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

    • workflowName — (String)

      The name of the workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  mappedInputFields: [ /* required */
    {
      fieldName: 'STRING_VALUE', /* required */
      type: NAME | NAME_FIRST | NAME_MIDDLE | NAME_LAST | ADDRESS | ADDRESS_STREET1 | ADDRESS_STREET2 | ADDRESS_STREET3 | ADDRESS_CITY | ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE | PHONE_NUMBER | PHONE_COUNTRYCODE | EMAIL_ADDRESS | UNIQUE_ID | DATE | STRING | PROVIDER_ID, /* required */
      groupName: 'STRING_VALUE',
      hashed: true || false,
      matchKey: 'STRING_VALUE',
      subType: 'STRING_VALUE'
    },
    /* more items */
  ],
  schemaName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
entityresolution.createSchemaMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    A description of the schema.

  • mappedInputFields — (Array<map>)

    A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

    • fieldName — required — (String)

      A string containing the field name.

    • groupName — (String)

      A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type.

      For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common groupName will prompt Entity Resolution to concatenate them into a single value.

    • hashed — (Boolean)

      Indicates if the column values are hashed in the schema input. If the value is set to TRUE, the column values are hashed. If the value is set to FALSE, the column values are cleartext.

    • matchKey — (String)

      A key that allows grouping of multiple input attributes into a unified matching group.

      For example, consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning a matchKey called address to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group.

      If no matchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.

    • subType — (String)

      The subtype of the attribute, selected from a list of values.

    • type — required — (String)

      The type of the attribute, selected from a list of values.

      Possible values include:
      • "NAME"
      • "NAME_FIRST"
      • "NAME_MIDDLE"
      • "NAME_LAST"
      • "ADDRESS"
      • "ADDRESS_STREET1"
      • "ADDRESS_STREET2"
      • "ADDRESS_STREET3"
      • "ADDRESS_CITY"
      • "ADDRESS_STATE"
      • "ADDRESS_COUNTRY"
      • "ADDRESS_POSTALCODE"
      • "PHONE"
      • "PHONE_NUMBER"
      • "PHONE_COUNTRYCODE"
      • "EMAIL_ADDRESS"
      • "UNIQUE_ID"
      • "DATE"
      • "STRING"
      • "PROVIDER_ID"
  • schemaName — (String)

    The name of the schema. There can't be multiple SchemaMappings with the same name.

  • tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • description — (String)

      A description of the schema.

    • mappedInputFields — (Array<map>)

      A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information that Entity Resolution uses for matching.

      • fieldName — required — (String)

        A string containing the field name.

      • groupName — (String)

        A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type.

        For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common groupName will prompt Entity Resolution to concatenate them into a single value.

      • hashed — (Boolean)

        Indicates if the column values are hashed in the schema input. If the value is set to TRUE, the column values are hashed. If the value is set to FALSE, the column values are cleartext.

      • matchKey — (String)

        A key that allows grouping of multiple input attributes into a unified matching group.

        For example, consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning a matchKey called address to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group.

        If no matchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.

      • subType — (String)

        The subtype of the attribute, selected from a list of values.

      • type — required — (String)

        The type of the attribute, selected from a list of values.

        Possible values include:
        • "NAME"
        • "NAME_FIRST"
        • "NAME_MIDDLE"
        • "NAME_LAST"
        • "ADDRESS"
        • "ADDRESS_STREET1"
        • "ADDRESS_STREET2"
        • "ADDRESS_STREET3"
        • "ADDRESS_CITY"
        • "ADDRESS_STATE"
        • "ADDRESS_COUNTRY"
        • "ADDRESS_POSTALCODE"
        • "PHONE"
        • "PHONE_NUMBER"
        • "PHONE_COUNTRYCODE"
        • "EMAIL_ADDRESS"
        • "UNIQUE_ID"
        • "DATE"
        • "STRING"
        • "PROVIDER_ID"
    • schemaArn — (String)

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

    • schemaName — (String)

      The name of the schema.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE' /* required */
};
entityresolution.deleteIdMappingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowName — (String)

    The name of the workflow to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • message — (String)

      A successful operation message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  idNamespaceName: 'STRING_VALUE' /* required */
};
entityresolution.deleteIdNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • idNamespaceName — (String)

    The name of the ID namespace.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • message — (String)

      A successful operation message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE' /* required */
};
entityresolution.deleteMatchingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowName — (String)

    The name of the workflow to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • message — (String)

      A successful operation message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE', /* required */
  statementId: 'STRING_VALUE' /* required */
};
entityresolution.deletePolicyStatement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    The ARN of the resource for which the policy need to be deleted.

  • statementId — (String)

    A statement identifier that differentiates the statement from others in the same policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The ARN of the resource for which the policy need to be deleted.

    • policy — (String)

      The resource-based policy.

    • token — (String)

      A unique identifier for the deleted policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  schemaName: 'STRING_VALUE' /* required */
};
entityresolution.deleteSchemaMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • schemaName — (String)

    The name of the schema to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • message — (String)

      A successful operation message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  jobId: 'STRING_VALUE', /* required */
  workflowName: 'STRING_VALUE' /* required */
};
entityresolution.getIdMappingJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The ID of the job.

  • workflowName — (String)

    The name of the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • endTime — (Date)

      The time at which the job has finished.

    • errorDetails — (map)

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

      • errorMessage — (String)

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

    • jobId — (String)

      The ID of the job.

    • metrics — (map)

      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.

      • recordsNotProcessed — (Integer)

        The total number of records that did not get processed.

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

      • totalRecordsProcessed — (Integer)

        The total number of records that were processed.

    • outputSourceConfig — (Array<map>)

      A list of OutputSource objects.

      • KMSArn — (String)

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

      • outputS3Path — required — (String)

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

      • roleArn — required — (String)

        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.

    • startTime — (Date)

      The time at which the job was started.

    • status — (String)

      The current status of the job.

      Possible values include:
      • "RUNNING"
      • "SUCCEEDED"
      • "FAILED"
      • "QUEUED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE' /* required */
};
entityresolution.getIdMappingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowName — (String)

    The name of the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdAt — (Date)

      The timestamp of when the workflow was created.

    • description — (String)

      A description of the workflow.

    • idMappingTechniques — (map)

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

      • idMappingType — required — (String)

        The type of ID mapping.

        Possible values include:
        • "PROVIDER"
        • "RULE_BASED"
      • providerProperties — (map)

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

        • intermediateSourceConfiguration — (map)

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

          • intermediateS3Path — required — (String)

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

        • providerConfiguration — (map)

          The required configuration fields to use with the provider service.

        • providerServiceArn — required — (String)

          The ARN of the provider service.

      • ruleBasedProperties — (map)

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

        • attributeMatchingModel — required — (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.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • recordMatchingModel — required — (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.

          Possible values include:
          • "ONE_SOURCE_TO_ONE_TARGET"
          • "MANY_SOURCE_TO_ONE_TARGET"
        • ruleDefinitionType — required — (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.

          Possible values include:
          • "SOURCE"
          • "TARGET"
        • rules — (Array<map>)

          The rules that can be used for ID mapping.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

    • inputSourceConfig — (Array<map>)

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

      • inputSourceARN — required — (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.

        Possible values include:
        • "SOURCE"
        • "TARGET"
    • outputSourceConfig — (Array<map>)

      A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

      • KMSArn — (String)

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

      • outputS3Path — required — (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 access Amazon Web Services resources on your behalf.

    • tags — (map<String>)

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

    • updatedAt — (Date)

      The timestamp of when the workflow was last updated.

    • workflowArn — (String)

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

    • workflowName — (String)

      The name of the workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  idNamespaceName: 'STRING_VALUE' /* required */
};
entityresolution.getIdNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • idNamespaceName — (String)

    The name of the ID namespace.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdAt — (Date)

      The timestamp of when the ID namespace was created.

    • description — (String)

      The description of the ID namespace.

    • idMappingWorkflowProperties — (Array<map>)

      Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

      • idMappingType — required — (String)

        The type of ID mapping.

        Possible values include:
        • "PROVIDER"
        • "RULE_BASED"
      • providerProperties — (map)

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

        • providerConfiguration — (map)

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

        • providerServiceArn — required — (String)

          The Amazon Resource Name (ARN) of the provider service.

      • ruleBasedProperties — (map)

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

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • recordMatchingModels — (Array<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 is matched to one record in the target.

          If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.

        • ruleDefinitionTypes — (Array<String>)

          The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

        • rules — (Array<map>)

          The rules for the ID namespace.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

    • idNamespaceArn — (String)

      The Amazon Resource Name (ARN) of the ID namespace.

    • idNamespaceName — (String)

      The name of the ID namespace.

    • inputSourceConfig — (Array<map>)

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

      • inputSourceARN — required — (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.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.

    • tags — (map<String>)

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

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

      Possible values include:
      • "SOURCE"
      • "TARGET"
    • updatedAt — (Date)

      The timestamp of when the ID namespace was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  record: { /* required */
    '<RecordAttributeMapKeyString>': 'STRING_VALUE',
    /* '<RecordAttributeMapKeyString>': ... */
  },
  workflowName: 'STRING_VALUE', /* required */
  applyNormalization: true || false
};
entityresolution.getMatchId(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • applyNormalization — (Boolean)

    Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

  • record — (map<String>)

    The record to fetch the Match ID for.

  • workflowName — (String)

    The name of the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • matchId — (String)

      The unique identifiers for this group of match records.

    • matchRule — (String)

      The rule the record matched on.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  jobId: 'STRING_VALUE', /* required */
  workflowName: 'STRING_VALUE' /* required */
};
entityresolution.getMatchingJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • jobId — (String)

    The ID of the job.

  • workflowName — (String)

    The name of the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • endTime — (Date)

      The time at which the job has finished.

    • errorDetails — (map)

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

      • errorMessage — (String)

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

    • jobId — (String)

      The ID of the job.

    • metrics — (map)

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

      • inputRecords — (Integer)

        The total number of input records.

      • matchIDs — (Integer)

        The total number of matchIDs generated.

      • recordsNotProcessed — (Integer)

        The total number of records that did not get processed.

      • totalRecordsProcessed — (Integer)

        The total number of records processed.

    • outputSourceConfig — (Array<map>)

      A list of OutputSource objects.

      • KMSArn — (String)

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

      • outputS3Path — required — (String)

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

      • roleArn — required — (String)

        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.

    • startTime — (Date)

      The time at which the job was started.

    • status — (String)

      The current status of the job.

      Possible values include:
      • "RUNNING"
      • "SUCCEEDED"
      • "FAILED"
      • "QUEUED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE' /* required */
};
entityresolution.getMatchingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowName — (String)

    The name of the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdAt — (Date)

      The timestamp of when the workflow was created.

    • description — (String)

      A description of the workflow.

    • incrementalRunConfig — (map)

      An object which defines an incremental run type and has only incrementalRunType as a field.

      • incrementalRunType — (String)

        The type of incremental run. It takes only one value: IMMEDIATE.

        Possible values include:
        • "IMMEDIATE"
    • inputSourceConfig — (Array<map>)

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

      • applyNormalization — (Boolean)

        Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

      • inputSourceARN — required — (String)

        An Glue table Amazon Resource Name (ARN) for the input source table.

      • schemaName — required — (String)

        The name of the schema to be retrieved.

    • outputSourceConfig — (Array<map>)

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

      • KMSArn — (String)

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

      • applyNormalization — (Boolean)

        Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

      • output — required — (Array<map>)

        A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

        • hashed — (Boolean)

          Enables the ability to hash the column values in the output.

        • name — required — (String)

          A name of a column to be written to the output. This must be an InputField name in the schema mapping.

      • outputS3Path — required — (String)

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

    • resolutionTechniques — (map)

      An object which defines the resolutionType and the ruleBasedProperties.

      • providerProperties — (map)

        The properties of the provider service.

        • intermediateSourceConfiguration — (map)

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

          • intermediateS3Path — required — (String)

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

        • providerConfiguration — (map)

          The required configuration fields to use with the provider service.

        • providerServiceArn — required — (String)

          The ARN of the provider service.

      • resolutionType — required — (String)

        The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.

        Possible values include:
        • "RULE_MATCHING"
        • "ML_MATCHING"
        • "PROVIDER"
      • ruleBasedProperties — (map)

        An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.

        • attributeMatchingModel — required — (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 and the value of BusinessEmail field of Profile B matches, 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.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • matchPurpose — (String)

          An indicator of whether to generate IDs and index the data or not.

          If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.

          If you choose INDEXING, the process indexes the data without generating IDs.

          Possible values include:
          • "IDENTIFIER_GENERATION"
          • "INDEXING"
        • rules — required — (Array<map>)

          A list of Rule objects, each of which have fields RuleName and MatchingKeys.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

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

    • tags — (map<String>)

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

    • updatedAt — (Date)

      The timestamp of when the workflow was last updated.

    • workflowArn — (String)

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

    • workflowName — (String)

      The name of the workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
entityresolution.getPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    The Amazon Resource Name (ARN) of the resource for which the policy need to be returned.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Entity Resolution resource ARN.

    • policy — (String)

      The resource-based policy.

    • token — (String)

      A unique identifier for the current revision of the policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  providerName: 'STRING_VALUE', /* required */
  providerServiceName: 'STRING_VALUE' /* required */
};
entityresolution.getProviderService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • providerName — (String)

    The name of the provider. This name is typically the company name.

  • providerServiceName — (String)

    The ARN (Amazon Resource Name) of the product that the provider service provides.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • anonymizedOutput — (Boolean)

      Specifies whether output data from the provider is anonymized. A value of TRUE means the output will be anonymized and you can't relate the data that comes back from the provider to the identifying input. A value of FALSE means the output won't be anonymized and you can relate the data that comes back from the provider to your source data.

    • providerComponentSchema — (map)

      Input schema for the provider service.

      • providerSchemaAttributes — (Array<map>)

        The provider schema attributes.

        • fieldName — required — (String)

          The field name.

        • hashing — (Boolean)

          The hashing attribute of the provider schema.

        • subType — (String)

          The sub type of the provider schema attribute.

        • type — required — (String)

          The type of the provider schema attribute.

          Possible values include:
          • "NAME"
          • "NAME_FIRST"
          • "NAME_MIDDLE"
          • "NAME_LAST"
          • "ADDRESS"
          • "ADDRESS_STREET1"
          • "ADDRESS_STREET2"
          • "ADDRESS_STREET3"
          • "ADDRESS_CITY"
          • "ADDRESS_STATE"
          • "ADDRESS_COUNTRY"
          • "ADDRESS_POSTALCODE"
          • "PHONE"
          • "PHONE_NUMBER"
          • "PHONE_COUNTRYCODE"
          • "EMAIL_ADDRESS"
          • "UNIQUE_ID"
          • "DATE"
          • "STRING"
          • "PROVIDER_ID"
      • schemas — (Array<Array<String>>)

        Input schema for the provider service.

    • providerConfigurationDefinition — (map)

      The definition of the provider configuration.

    • providerEndpointConfiguration — (map)

      The required configuration fields to use with the provider service.

      • marketplaceConfiguration — (map)

        The identifiers of the provider service, from Data Exchange.

        • assetId — required — (String)

          The asset ID on Data Exchange.

        • dataSetId — required — (String)

          The dataset ID on Data Exchange.

        • listingId — required — (String)

          The listing ID on Data Exchange.

        • revisionId — required — (String)

          The revision ID on Data Exchange.

    • providerEntityOutputDefinition — (map)

      The definition of the provider entity output.

    • providerIdNameSpaceConfiguration — (map)

      The provider configuration required for different ID namespace types.

      • description — (String)

        The description of the ID namespace.

      • providerSourceConfigurationDefinition — (map)

        Configurations required for the source ID namespace.

      • providerTargetConfigurationDefinition — (map)

        Configurations required for the target ID namespace.

    • providerIntermediateDataAccessConfiguration — (map)

      The Amazon Web Services accounts and the S3 permissions that are required by some providers to create an S3 bucket for intermediate data storage.

      • awsAccountIds — (Array<String>)

        The Amazon Web Services account that provider can use to read or write data into the customer's intermediate S3 bucket.

      • requiredBucketActions — (Array<String>)

        The S3 bucket actions that the provider requires permission for.

    • providerJobConfiguration — (map)

      Provider service job configurations.

    • providerName — (String)

      The name of the provider. This name is typically the company name.

    • providerServiceArn — (String)

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

    • providerServiceDisplayName — (String)

      The display name of the provider service.

    • providerServiceName — (String)

      The name of the product that the provider service provides.

    • providerServiceType — (String)

      The type of provider service.

      Possible values include:
      • "ASSIGNMENT"
      • "ID_MAPPING"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  schemaName: 'STRING_VALUE' /* required */
};
entityresolution.getSchemaMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • schemaName — (String)

    The name of the schema to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdAt — (Date)

      The timestamp of when the SchemaMapping was created.

    • description — (String)

      A description of the schema.

    • hasWorkflows — (Boolean)

      Specifies whether the schema mapping has been applied to a workflow.

    • mappedInputFields — (Array<map>)

      A list of MappedInputFields. Each MappedInputField corresponds to a column the source data table, and contains column name plus additional information Venice uses for matching.

      • fieldName — required — (String)

        A string containing the field name.

      • groupName — (String)

        A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type.

        For example, when working with columns such as first_name, middle_name, and last_name, assigning them a common groupName will prompt Entity Resolution to concatenate them into a single value.

      • hashed — (Boolean)

        Indicates if the column values are hashed in the schema input. If the value is set to TRUE, the column values are hashed. If the value is set to FALSE, the column values are cleartext.

      • matchKey — (String)

        A key that allows grouping of multiple input attributes into a unified matching group.

        For example, consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning a matchKey called address to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group.

        If no matchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.

      • subType — (String)

        The subtype of the attribute, selected from a list of values.

      • type — required — (String)

        The type of the attribute, selected from a list of values.

        Possible values include:
        • "NAME"
        • "NAME_FIRST"
        • "NAME_MIDDLE"
        • "NAME_LAST"
        • "ADDRESS"
        • "ADDRESS_STREET1"
        • "ADDRESS_STREET2"
        • "ADDRESS_STREET3"
        • "ADDRESS_CITY"
        • "ADDRESS_STATE"
        • "ADDRESS_COUNTRY"
        • "ADDRESS_POSTALCODE"
        • "PHONE"
        • "PHONE_NUMBER"
        • "PHONE_COUNTRYCODE"
        • "EMAIL_ADDRESS"
        • "UNIQUE_ID"
        • "DATE"
        • "STRING"
        • "PROVIDER_ID"
    • schemaArn — (String)

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

    • schemaName — (String)

      The name of the schema.

    • tags — (map<String>)

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

    • updatedAt — (Date)

      The timestamp of when the SchemaMapping was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
entityresolution.listIdMappingJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of objects returned per page.

  • nextToken — (String)

    The pagination token from the previous API call.

  • workflowName — (String)

    The name of the workflow to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobs — (Array<map>)

      A list of JobSummary objects.

      • endTime — (Date)

        The time at which the job has finished.

      • jobId — required — (String)

        The ID of the job.

      • startTime — required — (Date)

        The time at which the job was started.

      • status — required — (String)

        The current status of the job.

        Possible values include:
        • "RUNNING"
        • "SUCCEEDED"
        • "FAILED"
        • "QUEUED"
    • nextToken — (String)

      The pagination token from the previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
entityresolution.listIdMappingWorkflows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of objects returned per page.

  • nextToken — (String)

    The pagination token from the previous API call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token from the previous API call.

    • workflowSummaries — (Array<map>)

      A list of IdMappingWorkflowSummary objects.

      • createdAt — required — (Date)

        The timestamp of when the workflow was created.

      • updatedAt — required — (Date)

        The timestamp of when the workflow was last updated.

      • workflowArn — required — (String)

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

      • workflowName — required — (String)

        The name of the workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
entityresolution.listIdNamespaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of IdNamespace objects returned per page.

  • nextToken — (String)

    The pagination token from the previous API call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • idNamespaceSummaries — (Array<map>)

      A list of IdNamespaceSummaries objects.

      • createdAt — required — (Date)

        The timestamp of when the ID namespace was created.

      • description — (String)

        The description of the ID namespace.

      • idMappingWorkflowProperties — (Array<map>)

        An object which defines any additional configurations required by the ID mapping workflow.

        • idMappingType — required — (String)

          The type of ID mapping.

          Possible values include:
          • "PROVIDER"
          • "RULE_BASED"
      • idNamespaceArn — required — (String)

        The Amazon Resource Name (ARN) of the ID namespace.

      • idNamespaceName — required — (String)

        The name of the ID namespace.

      • type — required — (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 include:
        • "SOURCE"
        • "TARGET"
      • updatedAt — required — (Date)

        The timestamp of when the ID namespace was last updated.

    • nextToken — (String)

      The pagination token from the previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
entityresolution.listMatchingJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of objects returned per page.

  • nextToken — (String)

    The pagination token from the previous API call.

  • workflowName — (String)

    The name of the workflow to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobs — (Array<map>)

      A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.

      • endTime — (Date)

        The time at which the job has finished.

      • jobId — required — (String)

        The ID of the job.

      • startTime — required — (Date)

        The time at which the job was started.

      • status — required — (String)

        The current status of the job.

        Possible values include:
        • "RUNNING"
        • "SUCCEEDED"
        • "FAILED"
        • "QUEUED"
    • nextToken — (String)

      The pagination token from the previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
entityresolution.listMatchingWorkflows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of objects returned per page.

  • nextToken — (String)

    The pagination token from the previous API call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token from the previous API call.

    • workflowSummaries — (Array<map>)

      A list of MatchingWorkflowSummary objects, each of which contain the fields WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.

      • createdAt — required — (Date)

        The timestamp of when the workflow was created.

      • resolutionType — required — (String)

        The method that has been specified for data matching, either using matching provided by Entity Resolution or through a provider service.

        Possible values include:
        • "RULE_MATCHING"
        • "ML_MATCHING"
        • "PROVIDER"
      • updatedAt — required — (Date)

        The timestamp of when the workflow was last updated.

      • workflowArn — required — (String)

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

      • workflowName — required — (String)

        The name of the workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  providerName: 'STRING_VALUE'
};
entityresolution.listProviderServices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of objects returned per page.

  • nextToken — (String)

    The pagination token from the previous API call.

  • providerName — (String)

    The name of the provider. This name is typically the company name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token from the previous API call.

    • providerServiceSummaries — (Array<map>)

      A list of ProviderServices objects.

      • providerName — required — (String)

        The name of the provider. This name is typically the company name.

      • providerServiceArn — required — (String)

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

      • providerServiceDisplayName — required — (String)

        The display name of the provider service.

      • providerServiceName — required — (String)

        The name of the product that the provider service provides.

      • providerServiceType — required — (String)

        The type of provider service.

        Possible values include:
        • "ASSIGNMENT"
        • "ID_MAPPING"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
entityresolution.listSchemaMappings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    The maximum number of objects returned per page.

  • nextToken — (String)

    The pagination token from the previous API call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

      The pagination token from the previous API call.

    • schemaList — (Array<map>)

      A list of SchemaMappingSummary objects, each of which contain the fields SchemaName, SchemaArn, CreatedAt, UpdatedAt.

      • createdAt — required — (Date)

        The timestamp of when the SchemaMapping was created.

      • hasWorkflows — required — (Boolean)

        Specifies whether the schema mapping has been applied to a workflow.

      • schemaArn — required — (String)

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

      • schemaName — required — (String)

        The name of the schema.

      • updatedAt — required — (Date)

        The timestamp of when the SchemaMapping was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
entityresolution.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource for which you want to view tags.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE', /* required */
  token: 'STRING_VALUE'
};
entityresolution.putPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    The Amazon Resource Name (ARN) of the resource for which the policy needs to be updated.

  • policy — (String)

    The resource-based policy.

    If you set the value of the effect parameter in the policy to Deny for the PutPolicy operation, you must also set the value of the effect parameter to Deny for the AddPolicyStatement operation.

  • token — (String)

    A unique identifier for the current revision of the policy.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • arn — (String)

      The Entity Resolution resource ARN.

    • policy — (String)

      The resource-based policy.

    • token — (String)

      A unique identifier for the current revision of the policy.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE', /* required */
  outputSourceConfig: [
    {
      outputS3Path: 'STRING_VALUE', /* required */
      roleArn: 'STRING_VALUE', /* required */
      KMSArn: 'STRING_VALUE'
    },
    /* more items */
  ]
};
entityresolution.startIdMappingJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • outputSourceConfig — (Array<map>)

    A list of OutputSource objects.

    • KMSArn — (String)

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

    • outputS3Path — required — (String)

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

    • roleArn — required — (String)

      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.

  • workflowName — (String)

    The name of the ID mapping job to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobId — (String)

      The ID of the job.

    • outputSourceConfig — (Array<map>)

      A list of OutputSource objects.

      • KMSArn — (String)

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

      • outputS3Path — required — (String)

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

      • roleArn — required — (String)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workflowName: 'STRING_VALUE' /* required */
};
entityresolution.startMatchingJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workflowName — (String)

    The name of the matching job to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • jobId — (String)

      The ID of the job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
entityresolution.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource for which you want to view tags.

  • tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
entityresolution.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource for which you want to untag.

  • tagKeys — (Array<String>)

    The list of tag keys to remove from the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  idMappingTechniques: { /* required */
    idMappingType: PROVIDER | RULE_BASED, /* required */
    providerProperties: {
      providerServiceArn: 'STRING_VALUE', /* required */
      intermediateSourceConfiguration: {
        intermediateS3Path: 'STRING_VALUE' /* required */
      },
      providerConfiguration: {
      }
    },
    ruleBasedProperties: {
      attributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY, /* required */
      recordMatchingModel: ONE_SOURCE_TO_ONE_TARGET | MANY_SOURCE_TO_ONE_TARGET, /* required */
      ruleDefinitionType: SOURCE | TARGET, /* required */
      rules: [
        {
          matchingKeys: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          ruleName: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  },
  inputSourceConfig: [ /* required */
    {
      inputSourceARN: 'STRING_VALUE', /* required */
      schemaName: 'STRING_VALUE',
      type: SOURCE | TARGET
    },
    /* more items */
  ],
  workflowName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  outputSourceConfig: [
    {
      outputS3Path: 'STRING_VALUE', /* required */
      KMSArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  roleArn: 'STRING_VALUE'
};
entityresolution.updateIdMappingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    A description of the workflow.

  • idMappingTechniques — (map)

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

    • idMappingType — required — (String)

      The type of ID mapping.

      Possible values include:
      • "PROVIDER"
      • "RULE_BASED"
    • providerProperties — (map)

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

      • intermediateSourceConfiguration — (map)

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

        • intermediateS3Path — required — (String)

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

      • providerConfiguration — (map)

        The required configuration fields to use with the provider service.

      • providerServiceArn — required — (String)

        The ARN of the provider service.

    • ruleBasedProperties — (map)

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

      • attributeMatchingModel — required — (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.

        Possible values include:
        • "ONE_TO_ONE"
        • "MANY_TO_MANY"
      • recordMatchingModel — required — (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.

        Possible values include:
        • "ONE_SOURCE_TO_ONE_TARGET"
        • "MANY_SOURCE_TO_ONE_TARGET"
      • ruleDefinitionType — required — (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.

        Possible values include:
        • "SOURCE"
        • "TARGET"
      • rules — (Array<map>)

        The rules that can be used for ID mapping.

        • matchingKeys — required — (Array<String>)

          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.

        • ruleName — required — (String)

          A name for the matching rule.

  • inputSourceConfig — (Array<map>)

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

    • inputSourceARN — required — (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.

      Possible values include:
      • "SOURCE"
      • "TARGET"
  • outputSourceConfig — (Array<map>)

    A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

    • KMSArn — (String)

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

    • outputS3Path — required — (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 access Amazon Web Services resources on your behalf.

  • workflowName — (String)

    The name of the workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • description — (String)

      A description of the workflow.

    • idMappingTechniques — (map)

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

      • idMappingType — required — (String)

        The type of ID mapping.

        Possible values include:
        • "PROVIDER"
        • "RULE_BASED"
      • providerProperties — (map)

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

        • intermediateSourceConfiguration — (map)

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

          • intermediateS3Path — required — (String)

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

        • providerConfiguration — (map)

          The required configuration fields to use with the provider service.

        • providerServiceArn — required — (String)

          The ARN of the provider service.

      • ruleBasedProperties — (map)

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

        • attributeMatchingModel — required — (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.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • recordMatchingModel — required — (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.

          Possible values include:
          • "ONE_SOURCE_TO_ONE_TARGET"
          • "MANY_SOURCE_TO_ONE_TARGET"
        • ruleDefinitionType — required — (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.

          Possible values include:
          • "SOURCE"
          • "TARGET"
        • rules — (Array<map>)

          The rules that can be used for ID mapping.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

    • inputSourceConfig — (Array<map>)

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

      • inputSourceARN — required — (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.

        Possible values include:
        • "SOURCE"
        • "TARGET"
    • outputSourceConfig — (Array<map>)

      A list of OutputSource objects, each of which contains fields OutputS3Path and KMSArn.

      • KMSArn — (String)

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

      • outputS3Path — required — (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 access Amazon Web Services resources on your behalf.

    • workflowArn — (String)

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

    • workflowName — (String)

      The name of the workflow.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  idNamespaceName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  idMappingWorkflowProperties: [
    {
      idMappingType: PROVIDER | RULE_BASED, /* required */
      providerProperties: {
        providerServiceArn: 'STRING_VALUE', /* required */
        providerConfiguration: {
        }
      },
      ruleBasedProperties: {
        attributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY,
        recordMatchingModels: [
          ONE_SOURCE_TO_ONE_TARGET | MANY_SOURCE_TO_ONE_TARGET,
          /* more items */
        ],
        ruleDefinitionTypes: [
          SOURCE | TARGET,
          /* more items */
        ],
        rules: [
          {
            matchingKeys: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            ruleName: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  inputSourceConfig: [
    {
      inputSourceARN: 'STRING_VALUE', /* required */
      schemaName: 'STRING_VALUE'
    },
    /* more items */
  ],
  roleArn: 'STRING_VALUE'
};
entityresolution.updateIdNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    The description of the ID namespace.

  • idMappingWorkflowProperties — (Array<map>)

    Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

    • idMappingType — required — (String)

      The type of ID mapping.

      Possible values include:
      • "PROVIDER"
      • "RULE_BASED"
    • providerProperties — (map)

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

      • providerConfiguration — (map)

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

      • providerServiceArn — required — (String)

        The Amazon Resource Name (ARN) of the provider service.

    • ruleBasedProperties — (map)

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

        Possible values include:
        • "ONE_TO_ONE"
        • "MANY_TO_MANY"
      • recordMatchingModels — (Array<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 is matched to one record in the target.

        If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.

      • ruleDefinitionTypes — (Array<String>)

        The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

      • rules — (Array<map>)

        The rules for the ID namespace.

        • matchingKeys — required — (Array<String>)

          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.

        • ruleName — required — (String)

          A name for the matching rule.

  • idNamespaceName — (String)

    The name of the ID namespace.

  • inputSourceConfig — (Array<map>)

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

    • inputSourceARN — required — (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.

  • roleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • createdAt — (Date)

      The timestamp of when the ID namespace was created.

    • description — (String)

      The description of the ID namespace.

    • idMappingWorkflowProperties — (Array<map>)

      Determines the properties of IdMappingWorkflow where this IdNamespace can be used as a Source or a Target.

      • idMappingType — required — (String)

        The type of ID mapping.

        Possible values include:
        • "PROVIDER"
        • "RULE_BASED"
      • providerProperties — (map)

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

        • providerConfiguration — (map)

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

        • providerServiceArn — required — (String)

          The Amazon Resource Name (ARN) of the provider service.

      • ruleBasedProperties — (map)

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

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • recordMatchingModels — (Array<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 is matched to one record in the target.

          If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.

        • ruleDefinitionTypes — (Array<String>)

          The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

        • rules — (Array<map>)

          The rules for the ID namespace.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

    • idNamespaceArn — (String)

      The Amazon Resource Name (ARN) of the ID namespace.

    • idNamespaceName — (String)

      The name of the ID namespace.

    • inputSourceConfig — (Array<map>)

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

      • inputSourceARN — required — (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.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of a workflow run.

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

      Possible values include:
      • "SOURCE"
      • "TARGET"
    • updatedAt — (Date)

      The timestamp of when the ID namespace was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  inputSourceConfig: [ /* required */
    {
      inputSourceARN: 'STRING_VALUE', /* required */
      schemaName: 'STRING_VALUE', /* required */
      applyNormalization: true || false
    },
    /* more items */
  ],
  outputSourceConfig: [ /* required */
    {
      output: [ /* required */
        {
          name: 'STRING_VALUE', /* required */
          hashed: true || false
        },
        /* more items */
      ],
      outputS3Path: 'STRING_VALUE', /* required */
      KMSArn: 'STRING_VALUE',
      applyNormalization: true || false
    },
    /* more items */
  ],
  resolutionTechniques: { /* required */
    resolutionType: RULE_MATCHING | ML_MATCHING | PROVIDER, /* required */
    providerProperties: {
      providerServiceArn: 'STRING_VALUE', /* required */
      intermediateSourceConfiguration: {
        intermediateS3Path: 'STRING_VALUE' /* required */
      },
      providerConfiguration: {
      }
    },
    ruleBasedProperties: {
      attributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY, /* required */
      rules: [ /* required */
        {
          matchingKeys: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          ruleName: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      matchPurpose: IDENTIFIER_GENERATION | INDEXING
    }
  },
  roleArn: 'STRING_VALUE', /* required */
  workflowName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  incrementalRunConfig: {
    incrementalRunType: IMMEDIATE
  }
};
entityresolution.updateMatchingWorkflow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • description — (String)

    A description of the workflow.

  • incrementalRunConfig — (map)

    An object which defines an incremental run type and has only incrementalRunType as a field.

    • incrementalRunType — (String)

      The type of incremental run. It takes only one value: IMMEDIATE.

      Possible values include:
      • "IMMEDIATE"
  • inputSourceConfig — (Array<map>)

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

    • applyNormalization — (Boolean)

      Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

    • inputSourceARN — required — (String)

      An Glue table Amazon Resource Name (ARN) for the input source table.

    • schemaName — required — (String)

      The name of the schema to be retrieved.

  • outputSourceConfig — (Array<map>)

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

    • KMSArn — (String)

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

    • applyNormalization — (Boolean)

      Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

    • output — required — (Array<map>)

      A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

      • hashed — (Boolean)

        Enables the ability to hash the column values in the output.

      • name — required — (String)

        A name of a column to be written to the output. This must be an InputField name in the schema mapping.

    • outputS3Path — required — (String)

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

  • resolutionTechniques — (map)

    An object which defines the resolutionType and the ruleBasedProperties.

    • providerProperties — (map)

      The properties of the provider service.

      • intermediateSourceConfiguration — (map)

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

        • intermediateS3Path — required — (String)

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

      • providerConfiguration — (map)

        The required configuration fields to use with the provider service.

      • providerServiceArn — required — (String)

        The ARN of the provider service.

    • resolutionType — required — (String)

      The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.

      Possible values include:
      • "RULE_MATCHING"
      • "ML_MATCHING"
      • "PROVIDER"
    • ruleBasedProperties — (map)

      An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.

      • attributeMatchingModel — required — (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 and the value of BusinessEmail field of Profile B matches, 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.

        Possible values include:
        • "ONE_TO_ONE"
        • "MANY_TO_MANY"
      • matchPurpose — (String)

        An indicator of whether to generate IDs and index the data or not.

        If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.

        If you choose INDEXING, the process indexes the data without generating IDs.

        Possible values include:
        • "IDENTIFIER_GENERATION"
        • "INDEXING"
      • rules — required — (Array<map>)

        A list of Rule objects, each of which have fields RuleName and MatchingKeys.

        • matchingKeys — required — (Array<String>)

          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.

        • ruleName — required — (String)

          A name for the matching rule.

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

  • workflowName — (String)

    The name of the workflow to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • description — (String)

      A description of the workflow.

    • incrementalRunConfig — (map)

      An object which defines an incremental run type and has only incrementalRunType as a field.

      • incrementalRunType — (String)

        The type of incremental run. It takes only one value: IMMEDIATE.

        Possible values include:
        • "IMMEDIATE"
    • inputSourceConfig — (Array<map>)

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

      • applyNormalization — (Boolean)

        Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

      • inputSourceARN — required — (String)

        An Glue table Amazon Resource Name (ARN) for the input source table.

      • schemaName — required — (String)

        The name of the schema to be retrieved.

    • outputSourceConfig — (Array<map>)

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

      • KMSArn — (String)

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

      • applyNormalization — (Boolean)

        Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER, and the data in the input table is in a format of 1234567890, Entity Resolution will normalize this field in the output to (123)-456-7890.

      • output — required — (Array<map>)

        A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

        • hashed — (Boolean)

          Enables the ability to hash the column values in the output.

        • name — required — (String)

          A name of a column to be written to the output. This must be an InputField name in the schema mapping.

      • outputS3Path — required — (String)

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

    • resolutionTechniques — (map)

      An object which defines the resolutionType and the ruleBasedProperties

      • providerProperties — (map)

        The properties of the provider service.

        • intermediateSourceConfiguration — (map)

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

          • intermediateS3Path — required — (String)

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

        • providerConfiguration — (map)

          The required configuration fields to use with the provider service.

        • providerServiceArn — required — (String)

          The ARN of the provider service.

      • resolutionType — required — (String)

        The type of matching. There are three types of matching: RULE_MATCHING, ML_MATCHING, and PROVIDER.

        Possible values include:
        • "RULE_MATCHING"
        • "ML_MATCHING"
        • "PROVIDER"
      • ruleBasedProperties — (map)

        An object which defines the list of matching rules to run and has a field Rules, which is a list of rule objects.

        • attributeMatchingModel — required — (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 and the value of BusinessEmail field of Profile B matches, 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.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • matchPurpose — (String)

          An indicator of whether to generate IDs and index the data or not.

          If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.

          If you choose INDEXING, the process indexes the data without generating IDs.

          Possible values include:
          • "IDENTIFIER_GENERATION"
          • "INDEXING"
        • rules — required — (Array<map>)

          A list of Rule objects, each of which have fields RuleName and MatchingKeys.

          • matchingKeys — required — (Array<String>)

            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.

          • ruleName — required — (String)

            A name for the matching rule.

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

    • workflowName — (String)

      The name of the workflow.