AppConfig / Client / list_experiment_definitions

list_experiment_definitions¶

AppConfig.Client.list_experiment_definitions(**kwargs)¶

Lists the experiment definitions for an account. You can filter results by application, configuration profile, environment, or status.

Request Syntax

response = client.list_experiment_definitions(
    ApplicationIdentifier='string',
    ConfigurationProfileIdentifier='string',
    EnvironmentIdentifier='string',
    Status='ACTIVE'|'IDLE'|'ARCHIVED',
    MaxResults=123,
    NextToken='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.
MaxResults (integer) – The maximum number of items to return for this call.
NextToken (string) – A token to start the list from a previously truncated 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)
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) –
  
  A token to use for the next set of results.

Exceptions

AppConfig.Client.exceptions.ResourceNotFoundException
AppConfig.Client.exceptions.BadRequestException
AppConfig.Client.exceptions.InternalServerException