DeadlineCloud / Paginator / ListQueues


class DeadlineCloud.Paginator.ListQueues#
paginator = client.get_paginator('list_queues')

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

See also: AWS API Documentation

Request Syntax

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


    The farm ID of the queue.

  • principalId (string) – The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.

  • status (string) –

    The status of the queues listed.

    • ACTIVE–The queues are active.

    • SCHEDULING–The queues are scheduling.

    • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

  • 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

    'queues': [
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'displayName': 'string',
            'farmId': 'string',
            'queueId': 'string',
            'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • queues (list) –

      The queues on the list.

      • (dict) –

        The details of a queue summary.

        • blockedReason (string) –

          The reason the queue is blocked, if applicable.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • defaultBudgetAction (string) –

          The default action taken on a queue summary if a budget wasn’t configured.

        • displayName (string) –

          The display name of the queue summary to update.

        • farmId (string) –

          The farm ID.

        • queueId (string) –

          The queue ID.

        • status (string) –

          That status of the queue.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

    • NextToken (string) –

      A token to resume pagination.