Skip to content

GetAudienceGenerationJobResponse

Source code in docs_src/capo_cleanroomsml/types/get_audience_generation_job_response.py
class GetAudienceGenerationJobResponse(TypedDict, closed=True):
    create_time: "datetime.datetime"
    """<p>The time at which the audience generation job was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The most recent time at which the audience generation job was updated.</p>"""
    audience_generation_job_arn: (
        "capo_cleanroomsml.types.audience_generation_job_arn.AudienceGenerationJobArn"
    )
    """<p>The Amazon Resource Name (ARN) of the audience generation job.</p>"""
    name: "capo_cleanroomsml.types.name_string.NameString"
    """<p>The name of the audience generation job.</p>"""
    description: NotRequired[
        "capo_cleanroomsml.types.resource_description.ResourceDescription"
    ]
    """<p>The description of the audience generation job.</p>"""
    status: "capo_cleanroomsml.types.audience_generation_job_status.AudienceGenerationJobStatus"
    """<p>The status of the audience generation job.</p>"""
    status_details: NotRequired["capo_cleanroomsml.types.status_details.StatusDetails"]
    """<p>Details about the status of the audience generation job.</p>"""
    configured_audience_model_arn: "capo_cleanroomsml.types.configured_audience_model_arn.ConfiguredAudienceModelArn"
    """<p>The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.</p>"""
    seed_audience: NotRequired[
        "capo_cleanroomsml.types.audience_generation_job_data_source.AudienceGenerationJobDataSource"
    ]
    """<p>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. </p>"""
    include_seed_in_output: NotRequired["bool"]
    """<p>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 <code>TRUE</code>, 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 <code>minimumSeedSize</code> count of users are from the seed.</p>"""
    collaboration_id: NotRequired["capo_cleanroomsml.types.uuid.UUID"]
    """<p>The identifier of the collaboration that this audience generation job is associated with.</p>"""
    metrics: NotRequired[
        "capo_cleanroomsml.types.audience_quality_metrics.AudienceQualityMetrics"
    ]
    """<p>The relevance scores for different audience sizes and the recall score of the generated audience. </p>"""
    started_by: NotRequired["capo_cleanroomsml.types.account_id.AccountId"]
    """<p>The AWS account that started this audience generation job.</p>"""
    tags: NotRequired["capo_cleanroomsml.types.tag_map.TagMap"]
    """<p>The tags that are associated to this audience generation job.</p>"""
    protected_query_identifier: NotRequired["str"]
    """<p>The unique identifier of the protected query for this audience generation job.</p>"""

audience_generation_job_arn instance-attribute

audience_generation_job_arn: AudienceGenerationJobArn

The Amazon Resource Name (ARN) of the audience generation job.

collaboration_id instance-attribute

collaboration_id: NotRequired[UUID]

The identifier of the collaboration that this audience generation job is associated with.

configured_audience_model_arn instance-attribute

configured_audience_model_arn: ConfiguredAudienceModelArn

The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.

create_time instance-attribute

create_time: datetime

The time at which the audience generation job was created.

description instance-attribute

description: NotRequired[ResourceDescription]

The description of the audience generation job.

include_seed_in_output instance-attribute

include_seed_in_output: NotRequired[bool]

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.

metrics instance-attribute

metrics: NotRequired[AudienceQualityMetrics]

The relevance scores for different audience sizes and the recall score of the generated audience.

name instance-attribute

name: NameString

The name of the audience generation job.

protected_query_identifier instance-attribute

protected_query_identifier: NotRequired[str]

The unique identifier of the protected query for this audience generation job.

seed_audience instance-attribute

seed_audience: NotRequired[AudienceGenerationJobDataSource]

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.

started_by instance-attribute

started_by: NotRequired[AccountId]

The AWS account that started this audience generation job.

status instance-attribute

The status of the audience generation job.

status_details instance-attribute

status_details: NotRequired[StatusDetails]

Details about the status of the audience generation job.

tags instance-attribute

tags: NotRequired[TagMap]

The tags that are associated to this audience generation job.

update_time instance-attribute

update_time: datetime

The most recent time at which the audience generation job was updated.