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

ListBudgets

A list of budgets in a farm.

Request Syntax


GET /2023-10-12/farms/farmId/budgets?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID associated with the budgets.

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

Required: Yes

maxResults

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token for the next set of results, or null to start from the beginning.

status

The status to list for the budgets.

Valid Values: ACTIVE | INACTIVE

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "budgets": [ 
      { 
         "approximateDollarLimit": number,
         "budgetId": "string",
         "createdAt": "string",
         "createdBy": "string",
         "description": "string",
         "displayName": "string",
         "status": "string",
         "updatedAt": "string",
         "updatedBy": "string",
         "usages": { 
            "approximateDollarUsage": number
         },
         "usageTrackingResource": { ... }
      }
   ],
   "nextToken": "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.

budgets

The budgets to include on the list.

Type: Array of BudgetSummary objects

nextToken

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

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.

context: Information about the resources in use when the exception was thrown.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

retryAfterSeconds: The number of seconds a client should wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

context: Information about the resources in use when the exception was thrown.
resourceId: The identifier of the resource that couldn't be found.
resourceType: The type of the resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

context: Information about the resources in use when the exception was thrown.
quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service that is being throttled.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

context: Information about the resources in use when the exception was thrown.
fieldList: A list of fields that failed validation.
reason: The reason that the request failed validation.

HTTP Status Code: 400