DeadlineCloud / Paginator / ListQueues

ListQueues

class DeadlineCloud.Paginator.ListQueues

paginator = client.get_paginator('list_queues')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    farmId='string',
    principalId='string',
    status='IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the queue.

• principalId (string) – The principal IDs to include in the list of queues.

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

dict

Returns:

Response Syntax

{
    'queues': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'displayName': 'string',
            'status': 'IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED',
            'defaultBudgetAction': 'NONE'|'STOP_SCHEDULING_AND_COMPLETE_TASKS'|'STOP_SCHEDULING_AND_CANCEL_TASKS',
            'blockedReason': 'NO_BUDGET_CONFIGURED'|'BUDGET_THRESHOLD_REACHED',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            '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.

      • farmId (string) –

        The farm ID.

      • queueId (string) –

        The queue ID.

      • displayName (string) –

        The display name of the queue summary to update.

        Warning

        This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      • status (string) –

        That status of the queue.

      • defaultBudgetAction (string) –

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

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

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