DeviceFarm / Client / list_test_grid_sessions

list_test_grid_sessions

DeviceFarm.Client.list_test_grid_sessions(**kwargs)

Retrieves a list of sessions for a TestGridProject.

See also: AWS API Documentation

Request Syntax

response = client.list_test_grid_sessions(
    projectArn='string',
    status='ACTIVE'|'CLOSED'|'ERRORED',
    creationTimeAfter=datetime(2015, 1, 1),
    creationTimeBefore=datetime(2015, 1, 1),
    endTimeAfter=datetime(2015, 1, 1),
    endTimeBefore=datetime(2015, 1, 1),
    maxResult=123,
    nextToken='string'
)

Parameters:

• projectArn (string) –

  [REQUIRED]

  ARN of a TestGridProject.

• status (string) – Return only sessions in this state.

• creationTimeAfter (datetime) – Return only sessions created after this time.

• creationTimeBefore (datetime) – Return only sessions created before this time.

• endTimeAfter (datetime) – Return only sessions that ended after this time.

• endTimeBefore (datetime) – Return only sessions that ended before this time.

• maxResult (integer) – Return only this many results at a time.

• nextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'testGridSessions': [
        {
            'arn': 'string',
            'status': 'ACTIVE'|'CLOSED'|'ERRORED',
            'created': datetime(2015, 1, 1),
            'ended': datetime(2015, 1, 1),
            'billingMinutes': 123.0,
            'seleniumProperties': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • testGridSessions (list) –

    The sessions that match the criteria in a ListTestGridSessionsRequest.

    • (dict) –

      A TestGridSession is a single instance of a browser launched from the URL provided by a call to CreateTestGridUrl.

      • arn (string) –

        The ARN of the session.

      • status (string) –

        The state of the session.

      • created (datetime) –

        The time that the session was started.

      • ended (datetime) –

        The time the session ended.

      • billingMinutes (float) –

        The number of billed minutes that were used for this session.

      • seleniumProperties (string) –

        A JSON object of options and parameters passed to the Selenium WebDriver.

  • nextToken (string) –

    Pagination token.

Exceptions

• DeviceFarm.Client.exceptions.NotFoundException

• DeviceFarm.Client.exceptions.ArgumentException

• DeviceFarm.Client.exceptions.InternalServiceException