CleanRoomsService / Client / create_id_mapping_table

create_id_mapping_table¶

CleanRoomsService.Client.create_id_mapping_table(**kwargs)¶

Creates an ID mapping table.

Request Syntax

response = client.create_id_mapping_table(
    membershipIdentifier='string',
    name='string',
    description='string',
    inputReferenceConfig={
        'inputReferenceArn': 'string',
        'manageResourcePolicies': True|False
    },
    tags={
        'string': 'string'
    },
    kmsKeyArn='string'
)

Parameters:

membershipIdentifier (string) –
[REQUIRED]

The unique identifier of the membership that contains the ID mapping table.
name (string) –
[REQUIRED]

A name for the ID mapping table.
description (string) – A description of the ID mapping table.
inputReferenceConfig (dict) –
[REQUIRED]

The input reference configuration needed to create the ID mapping table.
- inputReferenceArn (string) – [REQUIRED]
  
  The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
- manageResourcePolicies (boolean) – [REQUIRED]
  
  When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
  
  When FALSE, the resource owner manages permissions for the ID mapping table resource.
tags (dict) –
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- (string) –
  - (string) –
kmsKeyArn (string) – The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.

Return type:

dict

Returns:

Response Syntax

{
    'idMappingTable': {
        'id': 'string',
        'arn': 'string',
        'inputReferenceConfig': {
            'inputReferenceArn': 'string',
            'manageResourcePolicies': True|False
        },
        'membershipId': 'string',
        'membershipArn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'description': 'string',
        'name': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'inputReferenceProperties': {
            'idMappingTableInputSource': [
                {
                    'idNamespaceAssociationId': 'string',
                    'type': 'SOURCE'|'TARGET'
                },
            ]
        },
        'kmsKeyArn': 'string'
    }
}

Response Structure

(dict) –
- idMappingTable (dict) –
  
  The ID mapping table that was created.
  - id (string) –
    
    The unique identifier of the ID mapping table.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the ID mapping table.
  - inputReferenceConfig (dict) –
    
    The input reference configuration for the ID mapping table.
    - inputReferenceArn (string) –
      
      The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
    - manageResourcePolicies (boolean) –
      
      When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
      
      When FALSE, the resource owner manages permissions for the ID mapping table resource.
  - membershipId (string) –
    
    The unique identifier of the membership resource for the ID mapping table.
  - membershipArn (string) –
    
    The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
  - collaborationId (string) –
    
    The unique identifier of the collaboration that contains this ID mapping table.
  - collaborationArn (string) –
    
    The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
  - description (string) –
    
    The description of the ID mapping table.
  - name (string) –
    
    The name of the ID mapping table.
  - createTime (datetime) –
    
    The time at which the ID mapping table was created.
  - updateTime (datetime) –
    
    The most recent time at which the ID mapping table was updated.
  - inputReferenceProperties (dict) –
    
    The input reference properties for the ID mapping table.
    - idMappingTableInputSource (list) –
      
      The input source of the ID mapping table.
      - (dict) –
        
        The input source of the ID mapping table.
        
        idNamespaceAssociationId (string) –
        
        The unique identifier of the ID namespace association.
        
        type (string) –
        
        The type of the input source of the ID mapping table.
  - kmsKeyArn (string) –
    
    The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.

Exceptions

CleanRoomsService.Client.exceptions.ConflictException
CleanRoomsService.Client.exceptions.ServiceQuotaExceededException
CleanRoomsService.Client.exceptions.ResourceNotFoundException
CleanRoomsService.Client.exceptions.InternalServerException
CleanRoomsService.Client.exceptions.ValidationException
CleanRoomsService.Client.exceptions.ThrottlingException
CleanRoomsService.Client.exceptions.AccessDeniedException