DeadlineCloud / Paginator / ListQueueEnvironments


class DeadlineCloud.Paginator.ListQueueEnvironments#
paginator = client.get_paginator('list_queue_environments')

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_queue_environments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • farmId (string) –


    The farm ID for the queue environment list.

  • queueId (string) –


    The queue ID for the queue environment list.

  • PaginationConfig (dict) –

    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.

Return type:



Response Syntax

    'environments': [
            'name': 'string',
            'priority': 123,
            'queueEnvironmentId': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • environments (list) –

      The environments to include in the queue environments list.

      • (dict) –

        The summary of a queue environment.

        • name (string) –

          The name of the queue environment.

        • priority (integer) –

          The queue environment’s priority.

        • queueEnvironmentId (string) –

          The queue environment ID.

    • NextToken (string) –

      A token to resume pagination.