DeadlineCloud / Paginator / ListSessionsForWorker


class DeadlineCloud.Paginator.ListSessionsForWorker#
paginator = client.get_paginator('list_sessions_for_worker')

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_sessions_for_worker().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • farmId (string) –


    The farm ID for the session.

  • fleetId (string) –


    The fleet ID for the session.

  • workerId (string) –


    The worker ID for the session.

  • 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:



Response Syntax

    'sessions': [
            'endedAt': datetime(2015, 1, 1),
            'jobId': 'string',
            'queueId': 'string',
            'sessionId': 'string',
            'startedAt': datetime(2015, 1, 1),
            'targetLifecycleStatus': 'ENDED'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • 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

    • NextToken (string) –

      A token to resume pagination.