id_namespace_associations

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

Overview

Name	id_namespace_associations
Type	Resource
Id	aws.cleanrooms.id_namespace_associations

Fields

The following fields are returned by SELECT queries:

get_id_namespace_association

Name	Datatype	Description
id	string	The unique identifier for this ID namespace association. (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 namespace association. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
arn	string	The Amazon Resource Name (ARN) of the ID namespace association. (pattern: <code>arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+</code>)
collaboration_arn	string	The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association. (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 namespace association. (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 namespace association was created.
description	string	The description of the ID namespace association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
id_mapping_config	object	The configuration settings for the ID mapping table.
input_reference_config	object	Provides the information for the ID namespace association input reference configuration.
input_reference_properties	object	The input reference properties for the ID namespace association.
membership_arn	string	The Amazon Resource Name (ARN) of the membership resource for this ID namespace association. (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 namespace association. (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 namespace association was updated.

list_id_namespace_associations

Name	Datatype	Description
id	string	The unique identifier of this ID namespace association. (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 namespace association. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
arn	string	The Amazon Resource Name (ARN) of this ID namespace association. (pattern: <code>arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/idnamespaceassociation/[\d\w-]+</code>)
collaboration_arn	string	The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association. (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 namespace association. (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 namespace association was created.
description	string	The description of the ID namespace association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
input_reference_config	object	Provides the information for the ID namespace association input reference configuration.
input_reference_properties	object	The input reference properties for this ID namespace association.
membership_arn	string	The Amazon Resource Name (ARN) of the membership resource for this ID namespace association. (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 namespace association. (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 namespace association has been updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_id_namespace_association	select	id_namespace_association_identifier, membership_identifier, region		Retrieves an ID namespace association.
list_id_namespace_associations	select	membership_identifier, region	nextToken, maxResults	Returns a list of ID namespace associations.
create_id_namespace_association	insert	membership_identifier, region, inputReferenceConfig, name		Creates an ID namespace association.
update_id_namespace_association	update	id_namespace_association_identifier, membership_identifier, region		Provides the details that are necessary to update an ID namespace association.
delete_id_namespace_association	delete	id_namespace_association_identifier, membership_identifier, region		Deletes an ID namespace association.

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_namespace_association_identifier	string	The unique identifier of the ID namespace association that you want to delete.
membership_identifier	string	The unique identifier of the membership that contains the ID namespace association that you want to delete.
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_namespace_association

Retrieves an ID namespace association.

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

list_id_namespace_associations

Returns a list of ID namespace associations.

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

INSERT examples

create_id_namespace_association

Creates an ID namespace association.

INSERT INTO aws.cleanrooms.id_namespace_associations (
inputReferenceConfig,
tags,
name,
description,
idMappingConfig,
membership_identifier,
region
)
SELECT 
'{{ inputReferenceConfig }}' /* required */,
'{{ tags }}',
'{{ name }}' /* required */,
'{{ description }}',
'{{ idMappingConfig }}',
'{{ membership_identifier }}',
'{{ region }}'
RETURNING
id_namespace_association
;

Manifest

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

UPDATE examples

update_id_namespace_association

Provides the details that are necessary to update an ID namespace association.

UPDATE aws.cleanrooms.id_namespace_associations
SET 
name = '{{ name }}',
description = '{{ description }}',
idMappingConfig = '{{ idMappingConfig }}'
WHERE 
id_namespace_association_identifier = '{{ id_namespace_association_identifier }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id_namespace_association;

DELETE examples

delete_id_namespace_association

Deletes an ID namespace association.

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