DescribeBudgets - Amazon Billing and Cost Management
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeBudgets

Lists the budgets that are associated with an account.

Important

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

Request Syntax

{
   "AccountId": "string",
   "MaxResults": number,
   "NextToken": "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 budgets that you want to describe.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: Yes

MaxResults

An integer that represents how many budgets a paginated response contains. The default is 100.

Type: Integer

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

Required: No

NextToken

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Type: String

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

Pattern: .*

Required: No

Response Syntax

{
   "Budgets": [ 
      { 
         "AutoAdjustData": { 
            "AutoAdjustType": "string",
            "HistoricalOptions": { 
               "BudgetAdjustmentPeriod": number,
               "LookBackAvailablePeriods": number
            },
            "LastAutoAdjustTime": number
         },
         "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,
         "PlannedBudgetLimits": { 
            "string" : { 
               "Amount": "string",
               "Unit": "string"
            }
         },
         "TimePeriod": { 
            "End": number,
            "Start": number
         },
         "TimeUnit": "string"
      }
   ],
   "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

A list of budgets.

Type: Array of Budget objects

NextToken

The pagination token in the service response that indicates the next set of results that you can retrieve.

Type: String

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

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You are not authorized to use this operation with the given parameters.

HTTP Status Code: 400

ExpiredNextTokenException

The pagination token expired.

HTTP Status Code: 400

InternalErrorException

An error on the server occurred during the processing of your request. Try again later.

HTTP Status Code: 400

InvalidNextTokenException

The pagination token is invalid.

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

ThrottlingException

The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

HTTP Status Code: 400

Examples

Example

The following is the PlannedBudgetLimits syntax.

{
   "Budgets": [ 
      { 
         "BudgetLimit": { 
            "Amount": "string",
            "Unit": "string"
         },
         "PlannedBudgetLimits": {
             “string": {
            "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"
      }
   ],
   "NextToken": "string"
}

Example

This example illustrates one usage of DescribeBudgets.

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.DescribeBudgets
{
   "AccountId": "111122223333",   
   "MaxResults": 20
}

Sample Response

{
   "Budgets": [ 
      { 
      "BudgetLimit": { 
         "Amount": "100",
         "Unit": "USD"
      },
      "BudgetName": "Example Limit Fixed 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"
      },
      { 
      "BudgetLimit": { 
         "Amount": "100",
         "Unit": "USD"
      },
      "PlannedBudgetLimits":{
         "1583020800": {
            "Amount": "100",
            "Unit": "USD"
         },
         "1564617600": {
            "Amount": "200",
            "Unit": "USD"
         },
         "1569888000": {
            "Amount": "300",
            "Unit": "USD"
         },
         "1556668800": {
            "Amount": "400",
            "Unit": "USD"
         },
         "1575158400": {
            "Amount": "500",
            "Unit": "USD"
         },
         "1580515200": {
            "Amount": "200",
            "Unit": "USD"
         },
         "1567296000": {
            "Amount": "300",
            "Unit": "USD"
         },
         "1554076800": {
            "Amount": "100",
            "Unit": "USD"
         },
         "1577836800": {
            "Amount": "200",
            "Unit": "USD"
         },
         "1561939200": {
            "Amount": "100",
            "Unit": "USD"
         },
         "1572566400": {
            "Amount": "110",
            "Unit": "USD"
         },
         "1559347200": {
            "Amount": "120",
            "Unit": "USD"
         }
      },
      "BudgetName": "Example Planned Limits 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"
      }
   ],
   "NextToken": "exampleTokenString"
}

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: