EntityResolution / Client / create_id_mapping_workflow

create_id_mapping_workflow

EntityResolution.Client.create_id_mapping_workflow(**kwargs)

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API.

See also: AWS API Documentation

Request Syntax

response = client.create_id_mapping_workflow(
    description='string',
    idMappingTechniques={
        'idMappingType': 'PROVIDER',
        'providerProperties': {
            'intermediateSourceConfiguration': {
                'intermediateS3Path': 'string'
            },
            'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
            'providerServiceArn': 'string'
        }
    },
    inputSourceConfig=[
        {
            'inputSourceARN': 'string',
            'schemaName': 'string'
        },
    ],
    outputSourceConfig=[
        {
            'KMSArn': 'string',
            'outputS3Path': 'string'
        },
    ],
    roleArn='string',
    tags={
        'string': 'string'
    },
    workflowName='string'
)

Parameters:

• description (string) – A description of the workflow.

• idMappingTechniques (dict) –

  [REQUIRED]

  An object which defines the idMappingType and the providerProperties.

  • idMappingType (string) – [REQUIRED]

    The type of ID mapping.

  • providerProperties (dict) – [REQUIRED]

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

    • intermediateSourceConfiguration (dict) –

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

      • intermediateS3Path (string) – [REQUIRED]

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

    • providerConfiguration (document) –

      The required configuration fields to use with the provider service.

    • providerServiceArn (string) – [REQUIRED]

      The ARN of the provider service.

• inputSourceConfig (list) –

  [REQUIRED]

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

  • (dict) –

    An object containing InputSourceARN and SchemaName.

    • inputSourceARN (string) – [REQUIRED]

      An Gluetable ARN for the input source table.

    • schemaName (string) – [REQUIRED]

      The name of the schema to be retrieved.

• outputSourceConfig (list) –

  [REQUIRED]

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

  • (dict) –

    The output source for the ID mapping workflow.

    • KMSArn (string) –

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

    • outputS3Path (string) – [REQUIRED]

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

• roleArn (string) –

  [REQUIRED]

  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 (dict) –

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

  • (string) –

    • (string) –

• workflowName (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'description': 'string',
    'idMappingTechniques': {
        'idMappingType': 'PROVIDER',
        'providerProperties': {
            'intermediateSourceConfiguration': {
                'intermediateS3Path': 'string'
            },
            'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
            'providerServiceArn': 'string'
        }
    },
    'inputSourceConfig': [
        {
            'inputSourceARN': 'string',
            'schemaName': 'string'
        },
    ],
    'outputSourceConfig': [
        {
            'KMSArn': 'string',
            'outputS3Path': 'string'
        },
    ],
    'roleArn': 'string',
    'workflowArn': 'string',
    'workflowName': 'string'
}

Response Structure

• (dict) –

  • description (string) –

    A description of the workflow.

  • idMappingTechniques (dict) –

    An object which defines the idMappingType and the providerProperties.

    • idMappingType (string) –

      The type of ID mapping.

    • providerProperties (dict) –

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

      • intermediateSourceConfiguration (dict) –

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

        • intermediateS3Path (string) –

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

      • providerConfiguration (document) –

        The required configuration fields to use with the provider service.

      • providerServiceArn (string) –

        The ARN of the provider service.

  • inputSourceConfig (list) –

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

    • (dict) –

      An object containing InputSourceARN and SchemaName.

      • inputSourceARN (string) –

        An Gluetable ARN for the input source table.

      • schemaName (string) –

        The name of the schema to be retrieved.

  • outputSourceConfig (list) –

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

    • (dict) –

      The output source for the ID mapping workflow.

      • KMSArn (string) –

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

      • outputS3Path (string) –

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

  • roleArn (string) –

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

  • workflowArn (string) –

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

  • workflowName (string) –

    The name of the workflow.

Exceptions

• EntityResolution.Client.exceptions.ThrottlingException

• EntityResolution.Client.exceptions.InternalServerException

• EntityResolution.Client.exceptions.AccessDeniedException

• EntityResolution.Client.exceptions.ExceedsLimitException

• EntityResolution.Client.exceptions.ConflictException

• EntityResolution.Client.exceptions.ValidationException