DeadlineCloud / Client / list_queues

list_queues

DeadlineCloud.Client.list_queues(**kwargs)

Lists queues.

See also: AWS API Documentation

Request Syntax

response = client.list_queues(
    farmId='string',
    principalId='string',
    status='IDLE'|'SCHEDULING'|'SCHEDULING_BLOCKED',
    nextToken='string',
    maxResults=123
)

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.

• nextToken (string) – The token for the next set of results, or null to start from the beginning.

• maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

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) –

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException