Gets a queue.
get/2023-10-12/farms/{farmId}/queues/{queueId}
Path parameters
farmIdstring required
The farm ID of the farm in the queue.
queueIdstring required
The queue ID for the queue to retrieve.
Response
Success
farmIdstring required
The farm ID for the queue.
queueIdstring required
The queue ID.
displayNamestring required
<p>The display name of the queue.</p> <important> <p>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.</p> </important>
status'IDLE' | 'SCHEDULING' | 'SCHEDULING_BLOCKED' required
<p>The status of the queue.</p> <ul> <li> <p> <code>ACTIVE</code>–The queue is active.</p> </li> <li> <p> <code>SCHEDULING</code>–The queue is scheduling.</p> </li> <li> <p> <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked. See the provided reason.</p> </li> </ul>
defaultBudgetAction'NONE' | 'STOP_SCHEDULING_AND_COMPLETE_TASKS' | 'STOP_SCHEDULING_AND_CANCEL_TASKS' required
The default action taken on a queue if a budget wasn't configured.
blockedReason'NO_BUDGET_CONFIGURED' | 'BUDGET_THRESHOLD_REACHED'
The reason the queue was blocked.
createdAtstring date-time required
The date and time the resource was created.
createdBystring required
The user or system that created this resource.
updatedAtstring date-time
The date and time the resource was updated.
updatedBystring
The user or system that updated this resource.
descriptionstring password
<p>The description of the queue.</p> <important> <p>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.</p> </important>
roleArnstring
The IAM role ARN.
requiredFileSystemLocationNamesFileSystemLocationName[]
A list of the required file system location names in the queue.
allowedStorageProfileIdsStorageProfileId[]
The storage profile IDs for the queue.