collaboration_configured_audience_model_associations

Creates, updates, deletes, gets or lists a collaboration_configured_audience_model_associations resource.

Overview

Name	collaboration_configured_audience_model_associations
Type	Resource
Id	aws.cleanrooms.collaboration_configured_audience_model_associations

Fields

The following fields are returned by SELECT queries:

get_collaboration_configured_audience_model_association

Name	Datatype	Description
id	string	The identifier of the configured audience model 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 configured audience model association. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
arn	string	The Amazon Resource Name (ARN) of the configured audience model association. (pattern: <code>arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/configuredaudiencemodelassociation/[\d\w-]+</code>)
collaboration_arn	string	The unique ARN for the configured audience model's associated collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
collaboration_id	string	A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
configured_audience_model_arn	string	The Amazon Resource Name (ARN) of the configure audience model. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+</code>)
create_time	string (date-time)	The time at which the configured audience model association was created.
creator_account_id	string	The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID. (pattern: <code>\d+</code>)
description	string	The description of the configured audience model association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
update_time	string (date-time)	The most recent time at which the configured audience model association was updated.

list_collaboration_configured_audience_model_associations

Name	Datatype	Description
id	string	The identifier of the configured audience model 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 configured audience model association. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
arn	string	The Amazon Resource Name (ARN) of the configured audience model association. (pattern: <code>arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/configuredaudiencemodelassociation/[\d\w-]+</code>)
collaboration_arn	string	The unique ARN for the configured audience model's associated collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
collaboration_id	string	A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID. (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 configured audience model association was created.
creator_account_id	string	The identifier used to reference members of the collaboration. Only supports Amazon Web Services account ID. (pattern: <code>\d+</code>)
description	string	The description of the configured audience model association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
update_time	string (date-time)	The most recent time at which the configured audience model association was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_collaboration_configured_audience_model_association	select	collaboration_identifier, configured_audience_model_association_identifier, region		Retrieves a configured audience model association within a collaboration.
list_collaboration_configured_audience_model_associations	select	collaboration_identifier, region	nextToken, maxResults	Lists configured audience model associations within 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	A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
configured_audience_model_association_identifier	string	A unique identifier for the configured audience model association that you want to retrieve.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

get_collaboration_configured_audience_model_association

Retrieves a configured audience model association within a collaboration.

SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
configured_audience_model_arn,
create_time,
creator_account_id,
description,
update_time
FROM aws.cleanrooms.collaboration_configured_audience_model_associations
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND configured_audience_model_association_identifier = '{{ configured_audience_model_association_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_collaboration_configured_audience_model_associations

Lists configured audience model associations within a collaboration.

SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
create_time,
creator_account_id,
description,
update_time
FROM aws.cleanrooms.collaboration_configured_audience_model_associations
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;