UpdateLimit
Updates the properties of the specified limit.
Request Syntax
PATCH /2023-10-12/farms/farmId/limits/limitId HTTP/1.1
Content-type: application/json
{
"description": "string",
"displayName": "string",
"maxCount": number
}URI Request Parameters
The request uses the following URI parameters.
Request Body
The request accepts the following data in JSON format.
- description
-
The new description of the limit.
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.
Required: No
- displayName
-
The new display name of the limit.
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.
Required: No
- maxCount
-
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.
The
maxCountmust not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.Type: Integer
Valid Range: Minimum value of -1. Maximum value of 2147483647.
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:
