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

***********
ListWorkers
***********



.. py:class:: DeadlineCloud.Paginator.ListWorkers

  ::

    
    paginator = client.get_paginator('list_workers')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The farm ID connected to the workers.

      

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

      The fleet ID of the workers.

      

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

      
      ::

        {
            'workers': [
                {
                    'workerId': 'string',
                    'farmId': 'string',
                    'fleetId': 'string',
                    'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE',
                    'hostProperties': {
                        'ipAddresses': {
                            'ipV4Addresses': [
                                'string',
                            ],
                            'ipV6Addresses': [
                                'string',
                            ]
                        },
                        'hostName': 'string',
                        'ec2InstanceArn': 'string',
                        'ec2InstanceType': 'string'
                    },
                    'log': {
                        'logDriver': 'string',
                        'options': {
                            'string': 'string'
                        },
                        'parameters': {
                            'string': 'string'
                        },
                        'error': 'string'
                    },
                    'createdAt': datetime(2015, 1, 1),
                    'createdBy': 'string',
                    'updatedAt': datetime(2015, 1, 1),
                    'updatedBy': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **workers** *(list) --* 

          The workers on the list.

          
          

          - *(dict) --* 

            The summary of details for a worker.

            
            

            - **workerId** *(string) --* 

              The worker ID.

              
            

            - **farmId** *(string) --* 

              The farm ID.

              
            

            - **fleetId** *(string) --* 

              The fleet ID.

              
            

            - **status** *(string) --* 

              The status of the worker.

              
            

            - **hostProperties** *(dict) --* 

              The host properties of the worker.

              
              

              - **ipAddresses** *(dict) --* 

                The IP address of the host.

                
                

                - **ipV4Addresses** *(list) --* 

                  The IpV4 address of the network.

                  
                  

                  - *(string) --* 
              
                

                - **ipV6Addresses** *(list) --* 

                  The IpV6 address for the network and node component.

                  
                  

                  - *(string) --* 
              
            
              

              - **hostName** *(string) --* 

                The host name.

                
              

              - **ec2InstanceArn** *(string) --* 

                The ARN of the host EC2 instance.

                
              

              - **ec2InstanceType** *(string) --* 

                The instance type of the host EC2 instance.

                
          
            

            - **log** *(dict) --* 

              The log configuration for the worker.

              
              

              - **logDriver** *(string) --* 

                The log drivers for worker related logs.

                
              

              - **options** *(dict) --* 

                The options for a log driver.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **parameters** *(dict) --* 

                The parameters for the log configuration.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **error** *(string) --* 

                The log configuration error details.

                
          
            

            - **createdAt** *(datetime) --* 

              The date and time the resource was created.

              
            

            - **createdBy** *(string) --* 

              The user or system that created this resource.

              
            

            - **updatedAt** *(datetime) --* 

              The date and time the resource was updated.

              
            

            - **updatedBy** *(string) --* 

              The user or system that updated this resource.

              
        
      
        

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

          A token to resume pagination.

          
    