:doc:`DeadlineCloud <../../deadline>` / Client / list_workers

************
list_workers
************



.. py:method:: DeadlineCloud.Client.list_workers(**kwargs)

  

  Lists workers.

  

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


  **Request Syntax**
  ::

    response = client.list_workers(
        farmId='string',
        fleetId='string',
        nextToken='string',
        maxResults=123
    )
    
  :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 nextToken: string
  :param nextToken: 

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

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return. Use this parameter with ``NextToken`` to get results as a set of sequential pages.

    

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

    
    ::

      {
          'nextToken': 'string',
          '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'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`DeadlineCloud.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.ValidationException`

  