AppConfig / Paginator / ListExperimentDefinitions

ListExperimentDefinitions¶

class AppConfig.Paginator.ListExperimentDefinitions¶

paginator = client.get_paginator('list_experiment_definitions')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    ApplicationIdentifier='string',
    ConfigurationProfileIdentifier='string',
    EnvironmentIdentifier='string',
    Status='ACTIVE'|'IDLE'|'ARCHIVED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

ApplicationIdentifier (string) – The application ID or name to filter results.
ConfigurationProfileIdentifier (string) – The configuration profile ID or name to filter results.
EnvironmentIdentifier (string) – The environment ID or name to filter results.
Status (string) – A filter for the experiment definition status.
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': [
        {
            'ApplicationId': 'string',
            'Id': 'string',
            'Name': 'string',
            'Hypothesis': 'string',
            'Status': 'ACTIVE'|'IDLE'|'ARCHIVED',
            'ConfigurationProfileId': 'string',
            'EnvironmentId': 'string',
            'FlagKey': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) –

The response for a list experiment definitions request.
- Items (list) –
  
  The list of experiment definitions.
  - (dict) –
    
    Summary information about an experiment definition.
    - ApplicationId (string) –
      
      The application ID.
    - Id (string) –
      
      The experiment definition ID.
    - Name (string) –
      
      The name of the experiment definition.
    - Hypothesis (string) –
      
      The hypothesis that the experiment is designed to validate.
    - Status (string) –
      
      The current status of the experiment definition.
    - ConfigurationProfileId (string) –
      
      The configuration profile ID associated with the experiment.
    - EnvironmentId (string) –
      
      The environment ID where the experiment runs.
    - FlagKey (string) –
      
      The key of the feature flag used by the experiment.
    - CreatedAt (datetime) –
      
      The date and time the experiment definition was created, in ISO 8601 format.
    - UpdatedAt (datetime) –
      
      The date and time the experiment definition was last updated, in ISO 8601 format.