| Column Name | Column Data Type |
|---|
audience_generation_job_arn Required Input Column
The Amazon Resource Name (ARN) of the audience generation job. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
collaboration_id
The identifier of the collaboration that this audience generation job is associated with. | VARCHAR |
configured_audience_model_arn
The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job. | VARCHAR |
create_time
The time at which the audience generation job was created. | TIMESTAMP_S |
description
The description of the audience generation job. | VARCHAR |
include_seed_in_output
Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed. | BOOLEAN |
metrics
The relevance scores for different audience sizes and the recall score of the generated audience. | STRUCT(
"relevance_metrics" STRUCT(
"audience_size" STRUCT(
"type" VARCHAR,
"value" BIGINT
),
"score" DOUBLE
)[],
"recall_metric" DOUBLE
) |
Show child fields- metrics.recall_metric
The recall score of the generated audience. Recall is the percentage of the most similar users (by default, the most similar 20%) from a sample of the training data that are included in the seed audience by the audience generation job. Values range from 0-1, larger values indicate a better audience. A recall value approximately equal to the maximum bin size indicates that the audience model is equivalent to random selection. - metrics.relevance_metrics[]
Show child fields- metrics.relevance_metrics[].audience_size
The size of the generated audience. Must match one of the sizes in the configured audience model. Show child fields- metrics.relevance_metrics[].audience_size.type
Whether the audience size is defined in absolute terms or as a percentage. 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. - metrics.relevance_metrics[].audience_size.value
Specify an audience size value.
- metrics.relevance_metrics[].score
The relevance score of the generated audience.
|
name
The name of the audience generation job. | VARCHAR |
protected_query_identifier
The unique identifier of the protected query for this audience generation job. | VARCHAR |
seed_audience
The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job. | STRUCT(
"data_source" STRUCT(
"s3_uri" VARCHAR
),
"role_arn" VARCHAR,
"sql_parameters" STRUCT(
"query_string" VARCHAR,
"analysis_template_arn" VARCHAR,
"parameters" MAP(VARCHAR, VARCHAR)
)
) |
Show child fields- seed_audience.data_source
Defines the Amazon S3 bucket where the seed audience for the generating audience is stored. A valid data source is a JSON line file in the following format: {"user_id": "111111"} {"user_id": "222222"} ... Show child fields- seed_audience.data_source.s3_uri
The Amazon S3 location URI.
- seed_audience.role_arn
The ARN of the IAM role that can read the Amazon S3 bucket where the seed audience is stored. - seed_audience.sql_parameters
The protected SQL query parameters. Show child fields- seed_audience.sql_parameters.analysis_template_arn
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration. - seed_audience.sql_parameters.parameters
The protected query SQL parameters. - seed_audience.sql_parameters.query_string
The query string to be submitted.
|
started_by
The AWS account that started this audience generation job. | VARCHAR |
status
The status of the audience generation job. | VARCHAR |
status_details
Details about the status of the audience generation job. | STRUCT(
"status_code" VARCHAR,
"message" VARCHAR
) |
Show child fields- status_details.message
The error message that was returned. The message is intended for human consumption and can change at any time. Use the statusCode for programmatic error handling. - status_details.status_code
The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.
|
tags
The tags that are associated to this audience generation job. | MAP(VARCHAR, VARCHAR) |
update_time
The most recent time at which the audience generation job was updated. | TIMESTAMP_S |