Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateBudget

Updates a budget that sets spending thresholds for rendering activity.

Request Syntax


PATCH /2023-10-12/farms/farmId/budgets/budgetId HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json

{
   "actionsToAdd": [ 
      { 
         "description": "string",
         "thresholdPercentage": number,
         "type": "string"
      }
   ],
   "actionsToRemove": [ 
      { 
         "thresholdPercentage": number,
         "type": "string"
      }
   ],
   "approximateDollarLimit": number,
   "description": "string",
   "displayName": "string",
   "schedule": { ... },
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

budgetId

The budget ID to update.

Pattern: budget-[0-9a-f]{32}

Required: Yes

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 of the budget to update.

Pattern: farm-[0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

actionsToAdd

The budget actions to add. Budget actions 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: No

actionsToRemove

The budget actions to remove from the budget.

Type: Array of BudgetActionToRemove objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

approximateDollarLimit

The dollar limit to update on the budget. Based on consumed usage.

Type: Float

Valid Range: Minimum value of 0.01.

Required: No

description

The description of the budget to update.

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 to update.

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

schedule

The schedule to update.

Type: BudgetSchedule object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

status

Updates the status of the budget.

ACTIVE–The budget is being evaluated.
INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.

Type: String

Valid Values: ACTIVE | INACTIVE

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