Skip to content

GetConfiguredAudienceModelResponse

Source code in docs_src/capo_cleanroomsml/types/get_configured_audience_model_response.py
class GetConfiguredAudienceModelResponse(TypedDict, closed=True):
    create_time: "datetime.datetime"
    """<p>The time at which the configured audience model was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The most recent time at which the configured audience model was updated.</p>"""
    configured_audience_model_arn: "capo_cleanroomsml.types.configured_audience_model_arn.ConfiguredAudienceModelArn"
    """<p>The Amazon Resource Name (ARN) of the configured audience model.</p>"""
    name: "capo_cleanroomsml.types.name_string.NameString"
    """<p>The name of the configured audience model.</p>"""
    audience_model_arn: "capo_cleanroomsml.types.audience_model_arn.AudienceModelArn"
    """<p>The Amazon Resource Name (ARN) of the audience model used for this configured audience model.</p>"""
    output_config: "capo_cleanroomsml.types.configured_audience_model_output_config.ConfiguredAudienceModelOutputConfig"
    """<p>The output configuration of the configured audience model</p>"""
    description: NotRequired[
        "capo_cleanroomsml.types.resource_description.ResourceDescription"
    ]
    """<p>The description of the configured audience model.</p>"""
    status: "capo_cleanroomsml.types.configured_audience_model_status.ConfiguredAudienceModelStatus"
    """<p>The status of the configured audience model.</p>"""
    shared_audience_metrics: "capo_cleanroomsml.types.metrics_list.MetricsList"
    """<p>Whether audience metrics are shared.</p>"""
    min_matching_seed_size: NotRequired[
        "capo_cleanroomsml.types.min_matching_seed_size.MinMatchingSeedSize"
    ]
    """<p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>"""
    audience_size_config: NotRequired[
        "capo_cleanroomsml.types.audience_size_config.AudienceSizeConfig"
    ]
    """<p>The list of output sizes of audiences that can be created using this configured audience model. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code> <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code> <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>"""
    tags: NotRequired["capo_cleanroomsml.types.tag_map.TagMap"]
    """<p>The tags that are associated to this configured audience model.</p>"""
    child_resource_tag_on_create_policy: NotRequired[
        "capo_cleanroomsml.types.tag_on_create_policy.TagOnCreatePolicy"
    ]
    """<p>Provides the <code>childResourceTagOnCreatePolicy</code> that was used for this configured audience model.</p>"""

audience_model_arn instance-attribute

audience_model_arn: AudienceModelArn

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

audience_size_config instance-attribute

audience_size_config: NotRequired[AudienceSizeConfig]

The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. 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 instance-attribute

child_resource_tag_on_create_policy: NotRequired[TagOnCreatePolicy]

Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

configured_audience_model_arn instance-attribute

configured_audience_model_arn: ConfiguredAudienceModelArn

The Amazon Resource Name (ARN) of the configured audience model.

create_time instance-attribute

create_time: datetime

The time at which the configured audience model was created.

description instance-attribute

description: NotRequired[ResourceDescription]

The description of the configured audience model.

min_matching_seed_size instance-attribute

min_matching_seed_size: NotRequired[MinMatchingSeedSize]

The minimum number of users from the seed audience that must match with users in the training data of the audience model.

name instance-attribute

name: NameString

The name of the configured audience model.

output_config instance-attribute

The output configuration of the configured audience model

shared_audience_metrics instance-attribute

shared_audience_metrics: MetricsList

Whether audience metrics are shared.

status instance-attribute

The status of the configured audience model.

tags instance-attribute

tags: NotRequired[TagMap]

The tags that are associated to this configured audience model.

update_time instance-attribute

update_time: datetime

The most recent time at which the configured audience model was updated.