EntityResolution / Client / update_id_mapping_workflow

update_id_mapping_workflow#

EntityResolution.Client.update_id_mapping_workflow(**kwargs)#

Updates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed.

Request Syntax

response = client.update_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',
            'type': 'SOURCE'|'TARGET'
        },
    ],
    outputSourceConfig=[
        {
            'KMSArn': 'string',
            'outputS3Path': 'string'
        },
    ],
    roleArn='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) –
  
  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, SchemaName, and Type.
  - inputSourceARN (string) – [REQUIRED]
    
    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) – [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 access Amazon Web Services resources on your behalf.
workflowName (string) –
[REQUIRED]

The name of the workflow.

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',
            'type': 'SOURCE'|'TARGET'
        },
    ],
    '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, 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.
- 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.

Exceptions

EntityResolution.Client.exceptions.ThrottlingException
EntityResolution.Client.exceptions.InternalServerException
EntityResolution.Client.exceptions.ResourceNotFoundException
EntityResolution.Client.exceptions.AccessDeniedException
EntityResolution.Client.exceptions.ValidationException