DescribeBudget
Describes a budget.
Request Syntax
{ "AccountId": "
string
", "BudgetName": "string
" }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AccountId
-
The
accountId
that is associated with the budget that you want a description of.Type: String
Length Constraints: Fixed length of 12.
Pattern:
\d{12}
Required: Yes
- BudgetName
-
The name of the budget that you want a description of.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[^:\\]+
Required: Yes
Response Syntax
{ "Budget": { "BudgetLimit": { "Amount": "string", "Unit": "string" }, "BudgetName": "string", "BudgetType": "string", "CalculatedSpend": { "ActualSpend": { "Amount": "string", "Unit": "string" }, "ForecastedSpend": { "Amount": "string", "Unit": "string" } }, "CostFilters": { "string" : [ "string" ] }, "CostTypes": { "IncludeCredit": boolean, "IncludeDiscount": boolean, "IncludeOtherSubscription": boolean, "IncludeRecurring": boolean, "IncludeRefund": boolean, "IncludeSubscription": boolean, "IncludeSupport": boolean, "IncludeTax": boolean, "IncludeUpfront": boolean, "UseAmortized": boolean, "UseBlended": boolean }, "LastUpdatedTime": number, "TimePeriod": { "End": number, "Start": number }, "TimeUnit": "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
An error on the server occurred during the processing of your request. Try again later.
HTTP Status Code: 400
- InvalidParameterException
-
An error on the client occurred. Typically, the cause is an invalid input value.
HTTP Status Code: 400
- NotFoundException
-
We can’t locate the resource that you specified.
HTTP Status Code: 400
Example
The following is a sample request and response of the DescribeBudget
operation.
Sample Request
POST / HTTP/1.1 Host: awsbudgets.<region>.<domain> x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AWSBudgetServiceGateway.DescribeBudget { "AccountId": "111122223333", "BudgetName": "Example Budget" }
Sample Response
{ "Budget": { "BudgetLimit": { "Amount": "100", "Unit": "USD" }, "BudgetName": "Example Budget", "BudgetType": "COST", "CalculatedSpend": { "ActualSpend": { "Amount": "50", "Unit": "USD" }, "ForecastedSpend": { "Amount": "100", "Unit": "USD" } }, "CostFilters": { "AZ" : [ "us-east-1" ] }, "CostTypes": { "IncludeCredit": true, "IncludeDiscount": true, "IncludeOtherSubscription": true, "IncludeRecurring": true, "IncludeRefund": true, "IncludeSubscription": true, "IncludeSupport": true, "IncludeTax": true, "IncludeUpfront": true, "UseBlended": false }, "TimePeriod": { "Start": 1477353600, "End": 1477958399 }, "TimeUnit": "MONTHLY" } }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: