ExperimentDefinition ¶

class ExperimentDefinition(TypedDict, closed=True):
    application_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The application ID.</p>"""
    id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The experiment definition ID.</p>"""
    name: NotRequired["capo_appconfig.types.name.Name"]
    """<p>The name of the experiment definition.</p>"""
    hypothesis: NotRequired["capo_appconfig.types.description.Description"]
    """<p>The hypothesis that the experiment is designed to validate.</p>"""
    status: NotRequired[
        "capo_appconfig.types.experiment_definition_status.ExperimentDefinitionStatus"
    ]
    """<p>The current status of the experiment definition. Valid values: <code>ACTIVE</code>, <code>IDLE</code>, <code>ARCHIVED</code>.</p>"""
    configuration_profile_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The configuration profile ID associated with the experiment.</p>"""
    environment_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The environment ID where the experiment runs.</p>"""
    flag_key: NotRequired["capo_appconfig.types.flag_key.FlagKey"]
    """<p>The key of the feature flag used by the experiment.</p>"""
    audience_rule: NotRequired["capo_appconfig.types.rule.Rule"]
    """<p>The rule that defines which users are eligible to be assigned to treatments.</p>"""
    audience_description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>A description of the intended audience for the experiment.</p>"""
    launch_criteria: NotRequired["capo_appconfig.types.description.Description"]
    """<p>The conditions under which the winning treatment should be launched.</p>"""
    treatments: NotRequired["capo_appconfig.types.treatment_list.TreatmentList"]
    """<p>The list of treatments defined for the experiment.</p>"""
    control: NotRequired["capo_appconfig.types.treatment.Treatment"]
    """<p>The control treatment used as the baseline for comparison.</p>"""
    created_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the experiment definition was created, in ISO 8601 format.</p>"""
    updated_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the experiment definition was last updated, in ISO 8601 format.</p>"""
    kms_key_identifier: NotRequired[
        "capo_appconfig.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.</p>"""