Skip to content

StartExperimentRunRequest

Source code in docs_src/capo_appconfig/types/start_experiment_run_request.py
class StartExperimentRunRequest(TypedDict, closed=True):
    application_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The application ID or name.</p>"""
    experiment_definition_identifier: "capo_appconfig.types.identifier.Identifier"
    """<p>The experiment definition ID or name.</p>"""
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>A description of this experiment run.</p>"""
    exposure_percentage: NotRequired[
        "capo_appconfig.types.nullable_percentage.NullablePercentage"
    ]
    """<p>The percentage of the target audience to expose to treatments. Set to 0 to validate the experiment before exposing production users.</p>"""
    treatment_overrides: NotRequired[
        "capo_appconfig.types.treatment_overrides.TreatmentOverrides"
    ]
    """<p>Treatment assignment overrides that assign specific entity IDs to treatments directly, bypassing random assignment.</p>"""
    tags: NotRequired["capo_appconfig.types.tag_map.TagMap"]
    """<p>The tags to assign to the experiment run.</p>"""
    deployment_parameters: NotRequired[
        "capo_appconfig.types.deployment_parameters.DeploymentParameters"
    ]
    """<p>The deployment parameters for the experiment run, including a KMS key identifier for encryption.</p>"""

application_identifier instance-attribute

application_identifier: Identifier

The application ID or name.

deployment_parameters instance-attribute

deployment_parameters: NotRequired[DeploymentParameters]

The deployment parameters for the experiment run, including a KMS key identifier for encryption.

description instance-attribute

description: NotRequired[Description]

A description of this experiment run.

experiment_definition_identifier instance-attribute

experiment_definition_identifier: Identifier

The experiment definition ID or name.

exposure_percentage instance-attribute

exposure_percentage: NotRequired[NullablePercentage]

The percentage of the target audience to expose to treatments. Set to 0 to validate the experiment before exposing production users.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to assign to the experiment run.

treatment_overrides instance-attribute

treatment_overrides: NotRequired[TreatmentOverrides]

Treatment assignment overrides that assign specific entity IDs to treatments directly, bypassing random assignment.