# 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",
   "schedulingConfiguration": { ... }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [clientToken](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-clientToken"></a>
The idempotency token to update in the queue.  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [farmId](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-uri-farmId"></a>
The farm ID to update in the queue.  
Pattern: `farm-[0-9a-f]{32}`   
Required: Yes

 ** [queueId](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-uri-queueId"></a>
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](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-allowedStorageProfileIdsToAdd"></a>
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](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-allowedStorageProfileIdsToRemove"></a>
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](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-defaultBudgetAction"></a>
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_TASKS`   
Required: No

 ** [description](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-description"></a>
The description of the queue to update.  
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.  
Required: No

 ** [displayName](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-displayName"></a>
The display name of the queue to update.  
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.  
Required: No

 ** [jobAttachmentSettings](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-jobAttachmentSettings"></a>
The job attachment settings to update for the queue.  
Type: [JobAttachmentSettings](API_JobAttachmentSettings.md) object  
Required: No

 ** [jobRunAsUser](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-jobRunAsUser"></a>
Update the jobs in the queue to run as a specified POSIX user.  
Type: [JobRunAsUser](API_JobRunAsUser.md) object  
Required: No

 ** [requiredFileSystemLocationNamesToAdd](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-requiredFileSystemLocationNamesToAdd"></a>
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](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-requiredFileSystemLocationNamesToRemove"></a>
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](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-roleArn"></a>
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

 ** [schedulingConfiguration](#API_UpdateQueue_RequestSyntax) **   <a name="deadlinecloud-UpdateQueue-request-schedulingConfiguration"></a>
The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.  
When updating the scheduling configuration, the entire configuration is replaced.  
In-progress tasks run to completion before the new scheduling configuration takes effect.  
Type: [SchedulingConfiguration](API_SchedulingConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
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 Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have permission to perform the action.    
 ** context **   
Information about the resources in use when the exception was thrown.
HTTP Status Code: 403

 ** InternalServerErrorException **   
Deadline Cloud can't process your request right now. Try again later.    
 ** retryAfterSeconds **   
The number of seconds a client should wait before retrying the request.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource can't be found.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** resourceId **   
The identifier of the resource that couldn't be found.  
 ** resourceType **   
The type of the resource that couldn't be found.
HTTP Status Code: 404

 ** ThrottlingException **   
Your request exceeded a request rate quota.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** quotaCode **   
Identifies the quota that is being throttled.  
 ** retryAfterSeconds **   
The number of seconds a client should wait before retrying the request.  
 ** serviceCode **   
Identifies the service that is being throttled.
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason that the request failed validation.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/deadline-2023-10-12/UpdateQueue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/deadline-2023-10-12/UpdateQueue)