configured_audience_models

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

Overview

Name	`configured_audience_models`
Type	Resource
Id	`aws.cleanroomsml.configured_audience_models`

Fields

The following fields are returned by SELECT queries:

get_configured_audience_model
list_configured_audience_models

Name	Datatype	Description
`name`	`string`	The name of the configured audience model. (pattern: <code>(?!\s$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]</code>)
`audience_model_arn`	`string`	The Amazon Resource Name (ARN) of the audience model used for this configured audience model. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-model/[-a-zA-Z0-9_/.]+</code>)
`audience_size_config`	`object`	Returns the relevance scores at these audience sizes when used in the GetAudienceGenerationJob for a specified audience generation job and configured audience model. Specifies the list of allowed audienceSize values when used in the StartAudienceExportJob for an audience generation job. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.
`child_resource_tag_on_create_policy`	`string`	Provides the childResourceTagOnCreatePolicy that was used for this configured audience model. (FROM_PARENT_RESOURCE, NONE)
`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>)
`create_time`	`string (date-time)`	The time at which the configured audience model was created.
`description`	`string`	The description of the configured audience model. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
`min_matching_seed_size`	`integer`	The minimum number of users from the seed audience that must match with users in the training data of the audience model.
`output_config`	`object`	Configuration information necessary for the configure audience model output.
`shared_audience_metrics`	`array`	Whether audience metrics are shared.
`status`	`string`	The status of the configured audience model. (ACTIVE)
`tags`	`object`	The tags that are associated to this configured audience model.
`update_time`	`string (date-time)`	The most recent time at which the configured audience model was updated.

Name	Datatype	Description
`name`	`string`	The name of the configured audience model. (pattern: <code>(?!\s$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]</code>)
`audience_model_arn`	`string`	The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model. (pattern: <code>arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:audience-model/[-a-zA-Z0-9_/.]+</code>)
`configured_audience_model_arn`	`string`	The Amazon Resource Name (ARN) of the configured audience model that you are interested in. (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 was created.
`description`	`string`	The description of the configured audience model. (pattern: <code>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
`output_config`	`object`	Configuration information necessary for the configure audience model output.
`status`	`string`	The status of the configured audience model. (ACTIVE)
`update_time`	`string (date-time)`	The most recent time at which the configured audience model was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_configured_audience_model`	`select`	`configured_audience_model_arn`, `region`		Returns information about a specified configured audience model.
`list_configured_audience_models`	`select`	`region`	`nextToken`, `maxResults`	Returns a list of the configured audience models.
`create_configured_audience_model`	`insert`	`region`, `name`, `audienceModelArn`, `outputConfig`, `sharedAudienceMetrics`		Defines the information necessary to create a configured audience model.
`update_configured_audience_model`	`update`	`configured_audience_model_arn`, `region`		Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.
`delete_configured_audience_model`	`delete`	`configured_audience_model_arn`, `region`		Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.
`start_audience_generation_job`	`exec`	`region`, `name`, `configuredAudienceModelArn`, `seedAudience`		Information necessary to start the audience generation job.

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 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.
`nextToken`	`string`	The token value retrieved from a previous call to access the next page of results.

`SELECT` examples

get_configured_audience_model
list_configured_audience_models

Returns information about a specified configured audience model.

SELECT
name,
audience_model_arn,
audience_size_config,
child_resource_tag_on_create_policy,
configured_audience_model_arn,
create_time,
description,
min_matching_seed_size,
output_config,
shared_audience_metrics,
status,
tags,
update_time
FROM aws.cleanroomsml.configured_audience_models
WHERE configured_audience_model_arn = '{{ configured_audience_model_arn }}' -- required
AND region = '{{ region }}' -- required
;

Returns a list of the configured audience models.

SELECT
name,
audience_model_arn,
configured_audience_model_arn,
create_time,
description,
output_config,
status,
update_time
FROM aws.cleanroomsml.configured_audience_models
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

`INSERT` examples

create_configured_audience_model
Manifest

Defines the information necessary to create a configured audience model.

INSERT INTO aws.cleanroomsml.configured_audience_models (
name,
audienceModelArn,
outputConfig,
description,
sharedAudienceMetrics,
minMatchingSeedSize,
audienceSizeConfig,
tags,
childResourceTagOnCreatePolicy,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ audienceModelArn }}' /* required */,
'{{ outputConfig }}' /* required */,
'{{ description }}',
'{{ sharedAudienceMetrics }}' /* required */,
{{ minMatchingSeedSize }},
'{{ audienceSizeConfig }}',
'{{ tags }}',
'{{ childResourceTagOnCreatePolicy }}',
'{{ region }}'
RETURNING
configured_audience_model_arn
;

# Description fields are for documentation purposes
- name: configured_audience_models
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configured_audience_models resource.
  - name: name
    value: "{{ name }}"
  - name: audienceModelArn
    value: "{{ audienceModelArn }}"
  - name: outputConfig
    description: |
      Configuration information necessary for the configure audience model output.
    value:
      destination:
        s3Destination:
          s3Uri: "{{ s3Uri }}"
      roleArn: "{{ roleArn }}"
  - name: description
    value: "{{ description }}"
  - name: sharedAudienceMetrics
    value:
      - "{{ sharedAudienceMetrics }}"
  - name: minMatchingSeedSize
    value: {{ minMatchingSeedSize }}
  - name: audienceSizeConfig
    description: |
      Returns the relevance scores at these audience sizes when used in the GetAudienceGenerationJob for a specified audience generation job and configured audience model. Specifies the list of allowed audienceSize values when used in the StartAudienceExportJob for an audience generation job. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.
    value:
      audienceSizeType: "{{ audienceSizeType }}"
      audienceSizeBins:
        - {{ audienceSizeBins }}
  - name: tags
    value: "{{ tags }}"
  - name: childResourceTagOnCreatePolicy
    value: "{{ childResourceTagOnCreatePolicy }}"
    valid_values: ['FROM_PARENT_RESOURCE', 'NONE']

`UPDATE` examples

update_configured_audience_model

Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

UPDATE aws.cleanroomsml.configured_audience_models
SET 
outputConfig = '{{ outputConfig }}',
audienceModelArn = '{{ audienceModelArn }}',
sharedAudienceMetrics = '{{ sharedAudienceMetrics }}',
minMatchingSeedSize = {{ minMatchingSeedSize }},
audienceSizeConfig = '{{ audienceSizeConfig }}',
description = '{{ description }}'
WHERE 
configured_audience_model_arn = '{{ configured_audience_model_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
configured_audience_model_arn;

`DELETE` examples

delete_configured_audience_model

Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

DELETE FROM aws.cleanroomsml.configured_audience_models
WHERE configured_audience_model_arn = '{{ configured_audience_model_arn }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_audience_generation_job

Information necessary to start the audience generation job.

EXEC aws.cleanroomsml.configured_audience_models.start_audience_generation_job 
@region='{{ region }}' --required 
@@json=
'{
"name": "{{ name }}", 
"configuredAudienceModelArn": "{{ configuredAudienceModelArn }}", 
"seedAudience": "{{ seedAudience }}", 
"includeSeedInOutput": {{ includeSeedInOutput }}, 
"collaborationId": "{{ collaborationId }}", 
"description": "{{ description }}", 
"tags": "{{ tags }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​