UpdateQueue
Updates a queue.
Request Syntax
PATCH /2023-10-12/farms/farmId/queues/queueId HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json
{
"allowedStorageProfileIdsToAdd": [ "string" ],
"allowedStorageProfileIdsToRemove": [ "string" ],
"defaultBudgetAction": "string",
"description": "string",
"displayName": "string",
"jobAttachmentSettings": {
"rootPrefix": "string",
"s3BucketName": "string"
},
"jobRunAsUser": {
"posix": {
"group": "string",
"user": "string"
},
"runAs": "string",
"windows": {
"passwordArn": "string",
"user": "string"
}
},
"requiredFileSystemLocationNamesToAdd": [ "string" ],
"requiredFileSystemLocationNamesToRemove": [ "string" ],
"roleArn": "string"
}URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
The idempotency token to update in the queue.
Length Constraints: Minimum length of 1. Maximum length of 64.
- farmId
-
The farm ID to update in the queue.
Pattern:
^farm-[0-9a-f]{32}$Required: Yes
- queueId
-
The queue ID to update.
Pattern:
^queue-[0-9a-f]{32}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- allowedStorageProfileIdsToAdd
-
The storage profile IDs to add.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Pattern:
^sp-[0-9a-f]{32}$Required: No
- allowedStorageProfileIdsToRemove
-
The storage profile ID to remove.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Pattern:
^sp-[0-9a-f]{32}$Required: No
- defaultBudgetAction
-
The default action to take for a queue update if a budget isn't configured.
Type: String
Valid Values:
NONE | STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKSRequired: No
- description
-
The description of the queue to update.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Required: No
- displayName
-
The display name of the queue to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- jobAttachmentSettings
-
The job attachment settings to update for the queue.
Type: JobAttachmentSettings object
Required: No
- jobRunAsUser
-
Update the jobs in the queue to run as a specified POSIX user.
Type: JobRunAsUser object
Required: No
- requiredFileSystemLocationNamesToAdd
-
The required file system location names to add to 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 ]*$Required: No
- requiredFileSystemLocationNamesToRemove
-
The required file system location names to remove from 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 ]*$Required: No
- roleArn
-
The IAM role ARN that's used to run jobs from this queue.
Type: String
Pattern:
^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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:
