configured_audience_model_policies
Creates, updates, deletes, gets or lists a configured_audience_model_policies resource.
Overview
| Name | configured_audience_model_policies |
| Type | Resource |
| Id | aws.cleanroomsml.configured_audience_model_policies |
Fields
The following fields are returned by SELECT queries:
- get_configured_audience_model_policy
| Name | Datatype | Description |
|---|---|---|
configured_audience_model_arn | string | The Amazon Resource Name (ARN) of the configured audience model. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:configured-audience-model/[-a-zA-Z0-9_/.]+</code>) |
configured_audience_model_policy | string | The configured audience model policy. This is a JSON IAM resource policy. |
policy_hash | string | A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy. (pattern: <code>[0-9a-f]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_configured_audience_model_policy | select | configured_audience_model_arn, region | Returns information about a configured audience model policy. | |
put_configured_audience_model_policy | replace | configured_audience_model_arn, region, configuredAudienceModelPolicy | Create or update the resource policy for a configured audience model. | |
delete_configured_audience_model_policy | delete | configured_audience_model_arn, region | Deletes the specified configured audience model policy. |
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 |
|---|---|---|
configured_audience_model_arn | string | The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_configured_audience_model_policy
Returns information about a configured audience model policy.
SELECT
configured_audience_model_arn,
configured_audience_model_policy,
policy_hash
FROM aws.cleanroomsml.configured_audience_model_policies
WHERE configured_audience_model_arn = '{{ configured_audience_model_arn }}' -- required
AND region = '{{ region }}' -- required
;
REPLACE examples
- put_configured_audience_model_policy
Create or update the resource policy for a configured audience model.
REPLACE aws.cleanroomsml.configured_audience_model_policies
SET
configuredAudienceModelPolicy = '{{ configuredAudienceModelPolicy }}',
previousPolicyHash = '{{ previousPolicyHash }}',
policyExistenceCondition = '{{ policyExistenceCondition }}'
WHERE
configured_audience_model_arn = '{{ configured_audience_model_arn }}' --required
AND region = '{{ region }}' --required
AND configuredAudienceModelPolicy = '{{ configuredAudienceModelPolicy }}' --required
RETURNING
configured_audience_model_policy,
policy_hash;
DELETE examples
- delete_configured_audience_model_policy
Deletes the specified configured audience model policy.
DELETE FROM aws.cleanroomsml.configured_audience_model_policies
WHERE configured_audience_model_arn = '{{ configured_audience_model_arn }}' --required
AND region = '{{ region }}' --required
;