Skip to content

ExperimentRunEvent

Source code in docs_src/capo_appconfig/types/experiment_run_event.py
class ExperimentRunEvent(TypedDict, closed=True):
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>A description of the event.</p>"""
    associated_deployment: NotRequired["capo_appconfig.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the deployment associated with this event.</p>"""
    event_type: NotRequired[
        "capo_appconfig.types.experiment_run_event_type.ExperimentRunEventType"
    ]
    """<p>The type of event. Valid values: <code>RUN_STARTED</code>, <code>EXPOSURE_UPDATED</code>, <code>OVERRIDES_UPDATED</code>, <code>RUN_STOPPED</code>.</p>"""
    occurred_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the event occurred, in ISO 8601 format.</p>"""
    triggered_by: NotRequired["capo_appconfig.types.triggered_by.TriggeredBy"]
    """<p>The principal that triggered the event.</p>"""
    exposure_percentage: NotRequired[
        "capo_appconfig.types.nullable_percentage.NullablePercentage"
    ]
    """<p>The exposure percentage at the time of the event.</p>"""
    treatment_overrides: NotRequired[
        "capo_appconfig.types.treatment_overrides.TreatmentOverrides"
    ]
    """<p>The treatment overrides at the time of the event.</p>"""

associated_deployment instance-attribute

associated_deployment: NotRequired[Arn]

The Amazon Resource Name (ARN) of the deployment associated with this event.

description instance-attribute

description: NotRequired[Description]

A description of the event.

event_type instance-attribute

event_type: NotRequired[ExperimentRunEventType]

The type of event. Valid values: RUN_STARTED, EXPOSURE_UPDATED, OVERRIDES_UPDATED, RUN_STOPPED.

exposure_percentage instance-attribute

exposure_percentage: NotRequired[NullablePercentage]

The exposure percentage at the time of the event.

occurred_at instance-attribute

occurred_at: NotRequired[Iso8601DateTime]

The date and time the event occurred, in ISO 8601 format.

treatment_overrides instance-attribute

treatment_overrides: NotRequired[TreatmentOverrides]

The treatment overrides at the time of the event.

triggered_by instance-attribute

triggered_by: NotRequired[TriggeredBy]

The principal that triggered the event.