EntityResolution / Client / get_id_mapping_workflow



Returns the IdMappingWorkflow with a given name, if it exists.

See also: AWS API Documentation

Request Syntax

response = client.get_id_mapping_workflow(

workflowName (string) –


The name of the workflow.

Return type:



Response Syntax

    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'idMappingTechniques': {
        'idMappingType': 'PROVIDER',
        'providerProperties': {
            'intermediateSourceConfiguration': {
                'intermediateS3Path': 'string'
            'providerConfiguration': {...}|[...]|123|123.4|'string'|True|None,
            'providerServiceArn': 'string'
    'inputSourceConfig': [
            'inputSourceARN': 'string',
            'schemaName': 'string',
            'type': 'SOURCE'|'TARGET'
    'outputSourceConfig': [
            'KMSArn': 'string',
            'outputS3Path': 'string'
    'roleArn': 'string',
    'tags': {
        'string': 'string'
    'updatedAt': datetime(2015, 1, 1),
    'workflowArn': 'string',
    'workflowName': 'string'

Response Structure

  • (dict) –

    • createdAt (datetime) –

      The timestamp of when the workflow was created.

    • 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, SchemaName, and Type.

        • inputSourceARN (string) –

          An Glue table 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 to which all sourceIds will resolve to.

    • outputSourceConfig (list) –

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

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

    • tags (dict) –

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

      • (string) –

        • (string) –

    • updatedAt (datetime) –

      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.