FIS / Client / list_experiments

list_experiments

FIS.Client.list_experiments(**kwargs)

Lists your experiments.

See also: AWS API Documentation

Request Syntax

response = client.list_experiments(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• nextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'experiments': [
        {
            'id': 'string',
            'experimentTemplateId': 'string',
            'state': {
                'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
                'reason': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • experiments (list) –

    The experiments.

    • (dict) –

      Provides a summary of an experiment.

      • id (string) –

        The ID of the experiment.

      • experimentTemplateId (string) –

        The ID of the experiment template.

      • state (dict) –

        The state of the experiment.

        • status (string) –

          The state of the experiment.

        • reason (string) –

          The reason for the state.

      • creationTime (datetime) –

        The time that the experiment was created.

      • tags (dict) –

        The tags for the experiment.

        • (string) –

          • (string) –

  • nextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• FIS.Client.exceptions.ValidationException