collaboration_id_namespace_associations
Creates, updates, deletes, gets or lists a collaboration_id_namespace_associations resource.
Overview
| Name | collaboration_id_namespace_associations |
| Type | Resource |
| Id | aws.cleanrooms.collaboration_id_namespace_associations |
Fields
The following fields are returned by SELECT queries:
- get_collaboration_id_namespace_association
- list_collaboration_id_namespace_associations
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the collaboration 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 collaboration 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 collaboration 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 the collaboration 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 the collaboration 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 collaboration ID namespace association was created. |
creator_account_id | string | The unique identifier of the Amazon Web Services account that created the collaboration ID namespace association. (pattern: <code>\d+</code>) |
description | string | The description of the collaboration 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 that are needed to create the collaboration ID namespace association. |
update_time | string (date-time) | The most recent time at which the collaboration ID namespace was updated. |
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the collaboration 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 collaboration 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 collaboration 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 collaboration 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 collaboration 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 collaboration ID namespace association was created. |
creator_account_id | string | The Amazon Web Services account that created this collaboration ID namespace association. (pattern: <code>\d+</code>) |
description | string | The description of the collaboration ID namepsace 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 that are used to create the collaboration ID namespace association. |
update_time | string (date-time) | The most recent time at which the collaboration ID namespace association was updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_collaboration_id_namespace_association | select | collaboration_identifier, id_namespace_association_identifier, region | Retrieves an ID namespace association from a specific collaboration. | |
list_collaboration_id_namespace_associations | select | collaboration_identifier, region | nextToken, maxResults | Returns a list of the ID namespace associations in a collaboration. |
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 |
|---|---|---|
collaboration_identifier | string | The unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve. |
id_namespace_association_identifier | string | The unique identifier of the ID namespace association that you want to retrieve. |
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_collaboration_id_namespace_association
- list_collaboration_id_namespace_associations
Retrieves an ID namespace association from a specific collaboration.
SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
description,
id_mapping_config,
input_reference_config,
input_reference_properties,
update_time
FROM aws.cleanrooms.collaboration_id_namespace_associations
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND id_namespace_association_identifier = '{{ id_namespace_association_identifier }}' -- required
AND region = '{{ region }}' -- required
;
Returns a list of the ID namespace associations in a collaboration.
SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
description,
input_reference_config,
input_reference_properties,
update_time
FROM aws.cleanrooms.collaboration_id_namespace_associations
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;