AppConfig / Paginator / ListExperimentRunEvents

ListExperimentRunEvents¶

class AppConfig.Paginator.ListExperimentRunEvents¶

paginator = client.get_paginator('list_experiment_run_events')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AppConfig.Client.list_experiment_run_events().

Request Syntax

response_iterator = paginator.paginate(
    ApplicationIdentifier='string',
    ExperimentDefinitionIdentifier='string',
    Run=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous 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'
                }
            }
        },
    ],

}

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) –