GetQueue - AWS Deadline Cloud
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetQueue

Gets a queue.

Request Syntax

GET /2023-10-12/farms/farmId/queues/queueId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID of the farm in the queue.

Pattern: farm-[0-9a-f]{32}

Required: Yes

queueId

The queue ID for the queue to retrieve.

Pattern: queue-[0-9a-f]{32}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "allowedStorageProfileIds": [ "string" ],
   "blockedReason": "string",
   "createdAt": "string",
   "createdBy": "string",
   "defaultBudgetAction": "string",
   "description": "string",
   "displayName": "string",
   "farmId": "string",
   "jobAttachmentSettings": { 
      "rootPrefix": "string",
      "s3BucketName": "string"
   },
   "jobRunAsUser": { 
      "posix": { 
         "group": "string",
         "user": "string"
      },
      "runAs": "string",
      "windows": { 
         "passwordArn": "string",
         "user": "string"
      }
   },
   "queueId": "string",
   "requiredFileSystemLocationNames": [ "string" ],
   "roleArn": "string",
   "status": "string",
   "updatedAt": "string",
   "updatedBy": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

allowedStorageProfileIds

The storage profile IDs for the queue.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Pattern: sp-[0-9a-f]{32}

blockedReason

The reason the queue was blocked.

Type: String

Valid Values: NO_BUDGET_CONFIGURED | BUDGET_THRESHOLD_REACHED

createdAt

The date and time the resource was created.

Type: Timestamp

createdBy

The user or system that created this resource.

Type: String

defaultBudgetAction

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

Type: String

Valid Values: NONE | STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS

description

The description of the queue.

Important

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

displayName

The display name of the queue.

Important

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

farmId

The farm ID for the queue.

Type: String

Pattern: farm-[0-9a-f]{32}

jobAttachmentSettings

The job attachment settings for the queue.

Type: JobAttachmentSettings object

jobRunAsUser

The jobs in the queue ran as this specified POSIX user.

Type: JobRunAsUser object

queueId

The queue ID.

Type: String

Pattern: queue-[0-9a-f]{32}

requiredFileSystemLocationNames

A list of the required file system location names in the queue.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9A-Za-z ]*

roleArn

The IAM role ARN.

Type: String

Pattern: arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+

status

The status of the queue.

  • ACTIVE–The queue is active.

  • SCHEDULING–The queue is scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

Type: String

Valid Values: IDLE | SCHEDULING | SCHEDULING_BLOCKED

updatedAt

The date and time the resource was updated.

Type: Timestamp

updatedBy

The user or system that updated this resource.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: