DeadlineCloud / Client / list_sessions

list_sessions#

DeadlineCloud.Client.list_sessions(**kwargs)#

Lists sessions.

See also: AWS API Documentation

Request Syntax

response = client.list_sessions(
    farmId='string',
    queueId='string',
    jobId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID for the list of sessions.

  • queueId (string) –

    [REQUIRED]

    The queue ID for the list of sessions

  • jobId (string) –

    [REQUIRED]

    The job ID for the list of sessions.

  • nextToken (string) – The token for the next set of results, or null to start from the beginning.

  • maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Return type:

dict

Returns:

Response Syntax

{
    'sessions': [
        {
            'sessionId': 'string',
            'fleetId': 'string',
            'workerId': 'string',
            'startedAt': datetime(2015, 1, 1),
            'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
            'endedAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'targetLifecycleStatus': 'ENDED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • sessions (list) –

      The sessions on the list.

      • (dict) –

        The summary of a session.

        • sessionId (string) –

          The session ID.

        • fleetId (string) –

          The fleet ID.

        • workerId (string) –

          The worker ID.

        • startedAt (datetime) –

          The date and time the resource started running.

        • lifecycleStatus (string) –

          The life cycle status for the session.

        • endedAt (datetime) –

          The date and time the resource ended running.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

        • targetLifecycleStatus (string) –

          The target life cycle status for the session.

    • nextToken (string) –

      If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions