DeadlineCloud / Client / list_sessions_for_worker

list_sessions_for_worker#

DeadlineCloud.Client.list_sessions_for_worker(**kwargs)#

Lists sessions for a worker.

See also: AWS API Documentation

Request Syntax

response = client.list_sessions_for_worker(
    farmId='string',
    fleetId='string',
    maxResults=123,
    nextToken='string',
    workerId='string'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID for the session.

  • fleetId (string) –

    [REQUIRED]

    The fleet ID for the session.

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

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

  • workerId (string) –

    [REQUIRED]

    The worker ID for the session.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      The token for the next set of results, or null to start from the beginning.

    • sessions (list) –

      The sessions in the response.

      • (dict) –

        Summarizes the session for a particular worker.

        • endedAt (datetime) –

          The date and time the resource ended running.

        • jobId (string) –

          The job ID for the job associated with the worker’s session.

        • lifecycleStatus (string) –

          The life cycle status for the worker’s session.

        • queueId (string) –

          The queue ID for the queue associated to the worker.

        • sessionId (string) –

          The session ID for the session action.

        • startedAt (datetime) –

          The date and time the resource started running.

        • targetLifecycleStatus (string) –

          The life cycle status

Exceptions