CreateBudget
Creates a budget to set spending thresholds for your rendering activity.
Request Syntax
POST /2023-10-12/farms/farmId/budgets HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json
{
"actions": [
{
"description": "string",
"thresholdPercentage": number,
"type": "string"
}
],
"approximateDollarLimit": number,
"description": "string",
"displayName": "string",
"schedule": { ... },
"usageTrackingResource": { ... }
}URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
The unique token which the server uses to recognize retries of the same request.
Length Constraints: Minimum length of 1. Maximum length of 64.
- farmId
-
The farm ID to include in this budget.
Pattern:
farm-[0-9a-f]{32}Required: Yes
Request Body
The request accepts the following data in JSON format.
- actions
-
The budget actions to specify what happens when the budget runs out.
Type: Array of BudgetActionToAdd objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
- approximateDollarLimit
-
The dollar limit based on consumed usage.
Type: Float
Valid Range: Minimum value of 0.01.
Required: Yes
- description
-
The description of the budget.
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 display name of the budget.
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: Yes
- schedule
-
The schedule to associate with this budget.
Type: BudgetSchedule object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- usageTrackingResource
-
The queue ID provided to this budget to track usage.
Type: UsageTrackingResource object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"budgetId": "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.
- budgetId
-
The budget ID.
Type: String
Pattern:
budget-[0-9a-f]{32}
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
- ServiceQuotaExceededException
-
You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.
HTTP Status Code: 402
- 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:
