GetLimit
Gets information about a specific limit.
Request Syntax
GET /2023-10-12/farms/farmId/limits/limitId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"amountRequirementName": "string",
"createdAt": "string",
"createdBy": "string",
"currentCount": number,
"description": "string",
"displayName": "string",
"farmId": "string",
"limitId": "string",
"maxCount": number,
"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.
- amountRequirementName
-
The value that you specify as the
namein theamountsfield of thehostRequirementsin a step of a job template to declare the limit requirement.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- createdAt
-
The Unix timestamp of the date and time that the limit was created.
Type: Timestamp
- createdBy
-
The user identifier of the person that created the limit.
Type: String
- currentCount
-
The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 2147483647.
- description
-
The description of the limit that helps identify what the limit is used for.
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 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.
- farmId
-
The unique identifier of the farm that contains the limit.
Type: String
Pattern:
farm-[0-9a-f]{32} - limitId
-
The unique identifier of the limit.
Type: String
Pattern:
limit-[0-9a-f]{32} - 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.
The
maxValuemust 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.
- updatedAt
-
The Unix timestamp of the date and time that the limit was last updated.
Type: Timestamp
- updatedBy
-
The user identifier of the person that last updated the limit.
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:
