AppConfig / Client / list_experiment_run_events

list_experiment_run_events

AppConfig.Client.list_experiment_run_events(**kwargs)

Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run.

See also: AWS API Documentation

Request Syntax

response = client.list_experiment_run_events(
    ApplicationIdentifier='string',
    ExperimentDefinitionIdentifier='string',
    Run=123,
    MaxResults=123,
    NextToken='string'
)

Parameters:

• ApplicationIdentifier (string) –

  [REQUIRED]

  The application ID or name.

• ExperimentDefinitionIdentifier (string) –

  [REQUIRED]

  The experiment definition ID or name.

• Run (integer) –

  [REQUIRED]

  The run number.

• MaxResults (integer) – The maximum number of items to return.

• NextToken (string) – A token to start the list from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Description': 'string',
            'AssociatedDeployment': 'string',
            'EventType': 'RUN_STARTED'|'EXPOSURE_UPDATED'|'OVERRIDES_UPDATED'|'RUN_STOPPED',
            'OccurredAt': datetime(2015, 1, 1),
            'TriggeredBy': 'USER'|'APPCONFIG'|'CLOUDWATCH_ALARM'|'INTERNAL_ERROR',
            'ExposurePercentage': ...,
            'TreatmentOverrides': {
                'Inline': {
                    'string': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response for a list experiment run events request.

  • Items (list) –

    The list of experiment run events.

    • (dict) –

      Describes an event that occurred during an experiment run.

      • Description (string) –

        A description of the event.

      • AssociatedDeployment (string) –

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

      • EventType (string) –

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

      • OccurredAt (datetime) –

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

      • TriggeredBy (string) –

        The principal that triggered the event.

      • ExposurePercentage (float) –

        The exposure percentage at the time of the event.

      • TreatmentOverrides (dict) –

        The treatment overrides at the time of the event.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: Inline. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • Inline (dict) –

          A map of entity IDs to treatment keys. Each entry assigns the specified entity to the specified treatment, bypassing random assignment.

          • (string) –

            • (string) –

  • NextToken (string) –

    A token to use for the next set of results.

Exceptions

• AppConfig.Client.exceptions.ResourceNotFoundException

• AppConfig.Client.exceptions.InternalServerException

• AppConfig.Client.exceptions.BadRequestException