GetBudget - AWS Deadline Cloud
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetBudget

Get a budget.

Request Syntax

GET /2023-10-12/farms/farmId/budgets/budgetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

budgetId

The budget ID.

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

Required: Yes

farmId

The farm ID of the farm connected to the budget.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "actions": [ 
      { 
         "description": "string",
         "thresholdPercentage": number,
         "type": "string"
      }
   ],
   "approximateDollarLimit": number,
   "budgetId": "string",
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "displayName": "string",
   "queueStoppedAt": "string",
   "schedule": { ... },
   "status": "string",
   "updatedAt": "string",
   "updatedBy": "string",
   "usages": { 
      "approximateDollarUsage": number
   },
   "usageTrackingResource": { ... }
}

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.

actions

The budget actions for the budget.

Type: Array of ResponseBudgetAction objects

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

approximateDollarLimit

The consumed usage limit for the budget.

Type: Float

Valid Range: Minimum value of 0.01.

budgetId

The budget ID.

Type: String

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

createdAt

The date and time the resource was created.

Type: Timestamp

createdBy

The user or system that created this resource.

Type: String

description

The description of the budget.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

displayName

The display name of the budget.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

queueStoppedAt

The date and time the queue stopped.

Type: Timestamp

schedule

The budget schedule.

Type: BudgetSchedule object

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

status

The status of the budget.

  • ACTIVE–Get a budget being evaluated.

  • INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.

Type: String

Valid Values: ACTIVE | INACTIVE

updatedAt

The date and time the resource was updated.

Type: Timestamp

updatedBy

The user or system that updated this resource.

Type: String

usages

The usages of the budget.

Type: ConsumedUsages object

usageTrackingResource

The resource that the budget is tracking usage for.

Type: UsageTrackingResource object

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

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: