Skip to content

CreateExperimentDefinitionRequest

Source code in docs_src/capo_appconfig/types/create_experiment_definition_request.py
class CreateExperimentDefinitionRequest(TypedDict, closed=True):
    application_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The application ID or name.</p>"""
    name: "capo_appconfig.types.name_with_reserved_aws_prefix.NameWithReservedAwsPrefix"
    """<p>A name for the experiment definition.</p>"""
    configuration_profile_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The configuration profile ID or name that stores the feature flag.</p>"""
    environment_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The environment ID or name where the experiment will run.</p>"""
    flag_key: "capo_appconfig.types.flag_key.FlagKey"
    """<p>The key of the existing feature flag to use with the experiment.</p>"""
    treatments: "capo_appconfig.types.treatment_input_list.TreatmentInputList"
    """<p>A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.</p>"""
    control: "capo_appconfig.types.treatment_input.TreatmentInput"
    """<p>The control treatment that represents the baseline experience for comparison.</p>"""
    audience_rule: "capo_appconfig.types.rule.Rule"
    """<p>A rule that defines which users are eligible to be assigned to treatments during the experiment.</p>"""
    hypothesis: NotRequired["capo_appconfig.types.description.Description"]
    """<p>A description of the goal or hypothesis the experiment is designed to validate.</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>Information about the conditions under which you would launch the winning treatment.</p>"""
    tags: NotRequired["capo_appconfig.types.tag_map.TagMap"]
    """<p>The tags to assign to the experiment definition. Tags help organize and categorize your AppConfig resources.</p>"""

application_identifier instance-attribute

application_identifier: Identifier

The application ID or name.

audience_description instance-attribute

audience_description: NotRequired[Description]

A description of the intended audience for the experiment.

audience_rule instance-attribute

audience_rule: Rule

A rule that defines which users are eligible to be assigned to treatments during the experiment.

configuration_profile_identifier instance-attribute

configuration_profile_identifier: Identifier

The configuration profile ID or name that stores the feature flag.

control instance-attribute

control: TreatmentInput

The control treatment that represents the baseline experience for comparison.

environment_identifier instance-attribute

environment_identifier: Identifier

The environment ID or name where the experiment will run.

flag_key instance-attribute

flag_key: FlagKey

The key of the existing feature flag to use with the experiment.

hypothesis instance-attribute

hypothesis: NotRequired[Description]

A description of the goal or hypothesis the experiment is designed to validate.

launch_criteria instance-attribute

launch_criteria: NotRequired[Description]

Information about the conditions under which you would launch the winning treatment.

name instance-attribute

A name for the experiment definition.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to assign to the experiment definition. Tags help organize and categorize your AppConfig resources.

treatments instance-attribute

treatments: TreatmentInputList

A list of treatments to evaluate during the experiment. Each treatment defines a distinct variation compared to the control.