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

*********************
ListQueueEnvironments
*********************



.. py:class:: DeadlineCloud.Paginator.ListQueueEnvironments

  ::

    
    paginator = client.get_paginator('list_queue_environments')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          farmId='string',
          queueId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 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**

      
      ::

        {
            '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) --* 

          A token to resume pagination.

          
    