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

***********************
list_queue_environments
***********************



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

  

  Lists queue environments.

  

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


  **Request Syntax**
  ::

    response = client.list_queue_environments(
        farmId='string',
        queueId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type farmId: string
  :param farmId: **[REQUIRED]** 

    The farm ID for the queue environment list.

    

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

    The queue ID for the queue environment list.

    

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

    
    ::

      {
          'environments': [
              {
                  'queueEnvironmentId': 'string',
                  'name': 'string',
                  'priority': 123
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **environments** *(list) --* 

        The environments to include in the queue environments list.

        
        

        - *(dict) --* 

          The summary of a queue environment.

          
          

          - **queueEnvironmentId** *(string) --* 

            The queue environment ID.

            
          

          - **name** *(string) --* 

            The name of the queue environment.

            
          

          - **priority** *(integer) --* 

            The queue environment's priority.

            
      
    
      

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

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

  