Skip to main content

configured_audience_model_associations

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

Overview​

Nameconfigured_audience_model_associations
TypeResource
Idaws.cleanrooms.configured_audience_model_associations

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringA unique 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>)
namestringThe name of the configured audience model association. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
arnstringThe 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_arnstringThe Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
collaboration_idstringA unique identifier of the collaboration that contains this 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>)
configured_audience_model_arnstringThe Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+</code>)
create_timestring (date-time)The time at which the configured audience model association was created.
descriptionstringThe description of the configured audience model association. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
manage_resource_policiesbooleanWhen TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.
membership_arnstringThe Amazon Resource Name (ARN) of the membership that contains this configured audience model association. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_idstringA unique identifier for the membership that contains this 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>)
update_timestring (date-time)The most recent time at which the configured audience model association was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_configured_audience_model_associationselectconfigured_audience_model_association_identifier, membership_identifier, regionReturns information about a configured audience model association.
list_configured_audience_model_associationsselectmembership_identifier, regionnextToken, maxResultsLists information about requested configured audience model associations.
create_configured_audience_model_associationinsertmembership_identifier, region, configuredAudienceModelArn, configuredAudienceModelAssociationName, manageResourcePoliciesProvides the details necessary to create a configured audience model association.
update_configured_audience_model_associationupdateconfigured_audience_model_association_identifier, membership_identifier, regionProvides the details necessary to update a configured audience model association.
delete_configured_audience_model_associationdeleteconfigured_audience_model_association_identifier, membership_identifier, regionProvides the information necessary to delete a configured audience model 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.

NameDatatypeDescription
configured_audience_model_association_identifierstringA unique identifier of the configured audience model association that you want to delete.
membership_identifierstringA unique identifier of the membership that contains the audience model association that you want to delete.
regionstringAWS region (default: us-east-1)
maxResultsintegerThe 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.
nextTokenstringThe pagination token that's used to fetch the next set of results.

SELECT examples​

Returns information about a configured audience model association.

SELECT
id,
name,
arn,
collaboration_arn,
collaboration_id,
configured_audience_model_arn,
create_time,
description,
manage_resource_policies,
membership_arn,
membership_id,
update_time
FROM aws.cleanrooms.configured_audience_model_associations
WHERE configured_audience_model_association_identifier = '{{ configured_audience_model_association_identifier }}' -- required
AND membership_identifier = '{{ membership_identifier }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Provides the details necessary to create a configured audience model association.

INSERT INTO aws.cleanrooms.configured_audience_model_associations (
configuredAudienceModelArn,
configuredAudienceModelAssociationName,
manageResourcePolicies,
tags,
description,
membership_identifier,
region
)
SELECT 
'{{ configuredAudienceModelArn }}' /* required */,
'{{ configuredAudienceModelAssociationName }}' /* required */,
{{ manageResourcePolicies }} /* required */,
'{{ tags }}',
'{{ description }}',
'{{ membership_identifier }}',
'{{ region }}'
RETURNING
configured_audience_model_association
;

UPDATE examples​

Provides the details necessary to update a configured audience model association.

UPDATE aws.cleanrooms.configured_audience_model_associations
SET 
description = '{{ description }}',
name = '{{ name }}'
WHERE 
configured_audience_model_association_identifier = '{{ configured_audience_model_association_identifier }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
configured_audience_model_association;

DELETE examples​

Provides the information necessary to delete a configured audience model association.

DELETE FROM aws.cleanrooms.configured_audience_model_associations
WHERE configured_audience_model_association_identifier = '{{ configured_audience_model_association_identifier }}' --required
AND membership_identifier = '{{ membership_identifier }}' --required
AND region = '{{ region }}' --required
;
Last updated on