AppConfig / Client / list_experiment_runs

list_experiment_runs

AppConfig.Client.list_experiment_runs(**kwargs)

Lists the experiment runs for a specified experiment definition. You can filter by status.

See also: AWS API Documentation

Request Syntax

response = client.list_experiment_runs(
    ApplicationIdentifier='string',
    ExperimentDefinitionIdentifier='string',
    MaxResults=123,
    NextToken='string',
    Status='RUNNING'|'DONE'
)

Parameters:

• ApplicationIdentifier (string) –

  [REQUIRED]

  The application ID or name.

• ExperimentDefinitionIdentifier (string) –

  [REQUIRED]

  The experiment definition ID or name.

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

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

• Status (string) – A filter for the experiment run status.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ExperimentDefinitionId': 'string',
            'Run': 123,
            'Description': 'string',
            'Status': 'RUNNING'|'DONE',
            'StartedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'EndedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response for a list experiment runs request.

  • Items (list) –

    The list of experiment runs.

    • (dict) –

      Summary information about an experiment run.

      • ExperimentDefinitionId (string) –

        The experiment definition ID.

      • Run (integer) –

        The experiment run number.

      • Description (string) –

        A description of the experiment run.

      • Status (string) –

        The current status of the experiment run.

      • StartedAt (datetime) –

        The date and time the experiment run started, in ISO 8601 format.

      • UpdatedAt (datetime) –

        The date and time the experiment run was last updated, in ISO 8601 format.

      • EndedAt (datetime) –

        The date and time the experiment run ended, in ISO 8601 format.

  • 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