id_mapping_tables

Creates, updates, deletes, gets or lists an id_mapping_tables resource.

Overview

Name	id_mapping_tables
Type	Resource
Id	aws.cleanrooms.id_mapping_tables

Fields

The following fields are returned by SELECT queries:

get_id_mapping_table

Name	Datatype	Description
id	string	The unique identifier of the ID mapping table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	The name of the ID mapping table. (pattern: <code>[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?</code>)
arn	string	The Amazon Resource Name (ARN) of the ID mapping table. (pattern: <code>arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idmappingtable/[\d\w-]+</code>)
child_resources	array	The child resources that depend on this ID mapping table.
collaboration_arn	string	The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
collaboration_id	string	The unique identifier of the collaboration that contains this ID mapping table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time at which the ID mapping table was created.
description	string	The description of the ID mapping table. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
input_reference_config	object	Provides the input reference configuration for the ID mapping table.
input_reference_properties	object	The input reference properties for the ID mapping table.
kms_key_arn	string	The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. (pattern: <code>arn:aws:kms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:key/[a-zA-Z0-9-]+</code>)
membership_arn	string	The Amazon Resource Name (ARN) of the membership resource for the ID mapping table. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The unique identifier of the membership resource for the ID mapping table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_time	string (date-time)	The most recent time at which the ID mapping table was updated.

list_id_mapping_tables

Name	Datatype	Description
id	string	The unique identifier of this ID mapping table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	The name of this ID mapping table. (pattern: <code>[a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?</code>)
arn	string	The Amazon Resource Name (ARN) of this ID mapping table. (pattern: <code>arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idmappingtable/[\d\w-]+</code>)
collaboration_arn	string	The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
collaboration_id	string	The unique identifier of the collaboration that contains this ID mapping table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
create_time	string (date-time)	The time at which this ID mapping table was created.
description	string	The description of this ID mapping table. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
input_reference_config	object	Provides the input reference configuration for the ID mapping table.
membership_arn	string	The Amazon Resource Name (ARN) of the membership resource for this ID mapping table. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The unique identifier of the membership resource for this ID mapping table. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_time	string (date-time)	The most recent time at which this ID mapping table was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_id_mapping_table	select	id_mapping_table_identifier, membership_identifier, region		Retrieves an ID mapping table.
list_id_mapping_tables	select	membership_identifier, region	nextToken, maxResults	Returns a list of ID mapping tables.
create_id_mapping_table	insert	membership_identifier, region, name, inputReferenceConfig		Creates an ID mapping table.
update_id_mapping_table	update	id_mapping_table_identifier, membership_identifier, region		Provides the details that are necessary to update an ID mapping table.
delete_id_mapping_table	delete	id_mapping_table_identifier, membership_identifier, region		Deletes an ID mapping table.
populate_id_mapping_table	exec	id_mapping_table_identifier, membership_identifier, region		Defines the information that's necessary to populate an ID mapping table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id_mapping_table_identifier	string	The unique identifier of the ID mapping table that you want to populate.
membership_identifier	string	The unique identifier of the membership that contains the ID mapping table that you want to populate.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

get_id_mapping_table

Retrieves an ID mapping table.

SELECT
id,
name,
arn,
child_resources,
collaboration_arn,
collaboration_id,
create_time,
description,
input_reference_config,
input_reference_properties,
kms_key_arn,
membership_arn,
membership_id,
update_time
FROM aws.cleanrooms.id_mapping_tables
WHERE id_mapping_table_identifier = '{{ id_mapping_table_identifier }}' -- required
AND membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_id_mapping_tables

Returns a list of ID mapping tables.

SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
create_time,
description,
input_reference_config,
membership_arn,
membership_id,
update_time
FROM aws.cleanrooms.id_mapping_tables
WHERE membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_id_mapping_table

Creates an ID mapping table.

INSERT INTO aws.cleanrooms.id_mapping_tables (
name,
description,
inputReferenceConfig,
tags,
kmsKeyArn,
membership_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ inputReferenceConfig }}' /* required */,
'{{ tags }}',
'{{ kmsKeyArn }}',
'{{ membership_identifier }}',
'{{ region }}'
RETURNING
id_mapping_table
;

Manifest

# Description fields are for documentation purposes
- name: id_mapping_tables
props:
  - name: membership_identifier
    value: "{{ membership_identifier }}"
    description: Required parameter for the id_mapping_tables resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the id_mapping_tables resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: inputReferenceConfig
    description: |
      Provides the input reference configuration for the ID mapping table.
    value:
      inputReferenceArn: "{{ inputReferenceArn }}"
      manageResourcePolicies: {{ manageResourcePolicies }}
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags assigned to a resource
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"

UPDATE examples

update_id_mapping_table

Provides the details that are necessary to update an ID mapping table.

UPDATE aws.cleanrooms.id_mapping_tables
SET 
description = '{{ description }}',
kmsKeyArn = '{{ kmsKeyArn }}'
WHERE 
id_mapping_table_identifier = '{{ id_mapping_table_identifier }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id_mapping_table;

DELETE examples

delete_id_mapping_table

Deletes an ID mapping table.

DELETE FROM aws.cleanrooms.id_mapping_tables
WHERE id_mapping_table_identifier = '{{ id_mapping_table_identifier }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

populate_id_mapping_table

Defines the information that's necessary to populate an ID mapping table.

EXEC aws.cleanrooms.id_mapping_tables.populate_id_mapping_table 
@id_mapping_table_identifier='{{ id_mapping_table_identifier }}' --required, 
@membership_identifier='{{ membership_identifier }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"jobType": "{{ jobType }}"
}'
;