Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Lists queues.

get/2023-10-12/farms/{farmId}/queues

Path parameters

farmIdstring required

The farm ID of the queue.

Query parameters

nextTokenstring

The token for the next set of results, or <code>null</code> to start from the beginning.

maxResultsinteger

The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.

principalIdstring

The principal IDs to include in the list of queues.

status'IDLE' | 'SCHEDULING' | 'SCHEDULING_BLOCKED'
<p>The status of the queues listed.</p> <ul> <li> <p> <code>ACTIVE</code>–The queues are active.</p> </li> <li> <p> <code>SCHEDULING</code>–The queues are scheduling.</p> </li> <li> <p> <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p> </li> </ul>

Response

Success

nextTokenstring

If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> 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 <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.