AppConfig / Paginator / ListExperimentRuns

ListExperimentRuns

class AppConfig.Paginator.ListExperimentRuns

paginator = client.get_paginator('list_experiment_runs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationIdentifier='string',
    ExperimentDefinitionIdentifier='string',
    Status='RUNNING'|'DONE',
    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.

• Status (string) – A filter for the experiment run 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': [
        {
            'ExperimentDefinitionId': 'string',
            'Run': 123,
            'Description': 'string',
            'Status': 'RUNNING'|'DONE',
            'StartedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'EndedAt': datetime(2015, 1, 1)
        },
    ],

}

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.