DeadlineCloud / Paginator / ListQueueEnvironments

ListQueueEnvironments

class DeadlineCloud.Paginator.ListQueueEnvironments

paginator = client.get_paginator('list_queue_environments')

paginate(**kwargs)

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID for the queue environment list.

• queueId (string) –

  [REQUIRED]

  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:

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.