:doc:`DeadlineCloud <../../deadline>` / Paginator / ListSessionsForWorker

*********************
ListSessionsForWorker
*********************



.. py:class:: DeadlineCloud.Paginator.ListSessionsForWorker

  ::

    
    paginator = client.get_paginator('list_sessions_for_worker')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DeadlineCloud.Client.list_sessions_for_worker`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListSessionsForWorker>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          farmId='string',
          fleetId='string',
          workerId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type farmId: string
    :param farmId: **[REQUIRED]** 

      The farm ID for the session.

      

    
    :type fleetId: string
    :param fleetId: **[REQUIRED]** 

      The fleet ID for the session.

      

    
    :type workerId: string
    :param workerId: **[REQUIRED]** 

      The worker ID for the session.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'sessions': [
                {
                    'sessionId': 'string',
                    'queueId': 'string',
                    'jobId': 'string',
                    'startedAt': datetime(2015, 1, 1),
                    'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
                    'endedAt': 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.

            
            

            - **sessionId** *(string) --* 

              The session ID for the session action.

              
            

            - **queueId** *(string) --* 

              The queue ID for the queue associated to the worker.

              
            

            - **jobId** *(string) --* 

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

              
            

            - **startedAt** *(datetime) --* 

              The date and time the resource started running.

              
            

            - **lifecycleStatus** *(string) --* 

              The life cycle status for the worker's session.

              
            

            - **endedAt** *(datetime) --* 

              The date and time the resource ended running.

              
            

            - **targetLifecycleStatus** *(string) --* 

              The life cycle status

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    