CreateBudget - AWS Billing and Cost Management
Request SyntaxRequest ParametersResponse ElementsErrorsExamplesSee Also

CreateBudget

Creates a budget and, if included, notifications and subscribers.

Important

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

Request Syntax

{
   "AccountId": "string",
   "Budget": { 
      "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"
   },
   "NotificationsWithSubscribers": [ 
      { 
         "Notification": { 
            "ComparisonOperator": "string",
            "NotificationState": "string",
            "NotificationType": "string",
            "Threshold": number,
            "ThresholdType": "string"
         },
         "Subscribers": [ 
            { 
               "Address": "string",
               "SubscriptionType": "string"
            }
         ]
      }
   ],
   "ResourceTags": [ 
      { 
         "Key": "string",
         "Value": "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.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: Yes

Budget

The budget object that you want to create.

Type: Budget object

Required: Yes

NotificationsWithSubscribers

A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.

Type: Array of NotificationWithSubscribers objects

Array Members: Maximum number of 10 items.

Required: No

ResourceTags

An optional list of tags to associate with the specified budget. Each tag consists of a key and a value, and each key must be unique for the resource.

Type: Array of ResourceTag objects

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

Required: No

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 are not authorized to use this operation with the given parameters.

HTTP Status Code: 400

CreationLimitExceededException

You've exceeded the notification or subscriber limit.

HTTP Status Code: 400

DuplicateRecordException

The budget name already exists. Budget names must be unique within an account.

HTTP Status Code: 400

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

ServiceQuotaExceededException

You've reached the limit on the number of tags you can associate with a resource.

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

{
   "AccountId": "string",
   "Budget": { 
      "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"
   },
   "NotificationsWithSubscribers": [ 
      { 
         "Notification": { 
            "ComparisonOperator": "string",
            "NotificationState": "string",
            "NotificationType": "string",
            "Threshold": number,
            "ThresholdType": "string"
         },
         "Subscribers": [ 
            { 
               "Address": "string",
               "SubscriptionType": "string"
            }
         ]
      }
   ]
}

Example

The following is a sample request of the CreateBudget operation using BudgetLimit

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.CreateBudgets
{
   "AccountId": "111122223333",
   "Budget": { 
      "BudgetLimit": { 
         "Amount": "100",
         "Unit": "USD"
      },
      "BudgetName": "Example Budget",
      "BudgetType": "COST",
      "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"
   },
   "NotificationsWithSubscribers": [ 
      { 
         "Notification": { 
            "ComparisonOperator": "GREATER_THAN",
            "NotificationType": "ACTUAL",
            "Threshold": 80,
            "ThresholdType": "PERCENTAGE"
         },
         "Subscribers": [ 
            { 
               "Address": "example@example.com",
               "SubscriptionType": "EMAIL"
            }
         ]
      }
   ]
}

Example

The following is a sample request of the CreateBudget operation using PlannedBudgetLimits

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.CreateBudgets
{
   "AccountId": "111122223333",
   "Budget": { 
      "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 Budget",
      "BudgetType": "COST",
      "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"
   },
   "NotificationsWithSubscribers": [ 
      { 
         "Notification": { 
            "ComparisonOperator": "GREATER_THAN",
            "NotificationType": "ACTUAL",
            "Threshold": 80,
            "ThresholdType": "PERCENTAGE"
         },
         "Subscribers": [ 
            { 
               "Address": "example@example.com",
               "SubscriptionType": "EMAIL"
            }
         ]
      }
   ]
}

Example

The following is a sample request of the CreateBudget operation using BudgetLimit and filtering for a specific tag.

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.CreateBudgets
{
   "AccountId": "111122223333",
   "Budget": {
   "BudgetLimit": {
      "Amount": "100",
      "Unit": "USD"},
   "BudgetName": "Example Tag Budget",
   "BudgetType": "COST",
   "CostFilters": {
      "TagKeyValue" : ["user:Key$value1","user:Key$value2"]
   },
      "CostTypes": { 
         "IncludeCredit": true,
         "IncludeDiscount": true,
         "IncludeOtherSubscription": true,
         "IncludeRecurring": true,
         "IncludeRefund": true,
         "IncludeSubscription": true,
         "IncludeSupport": true,
         "IncludeTax": true,
         "IncludeUpfront": true,
         "UseBlended": false
      },
      "TimePeriod": { 
         "Start": 1477958399,
         "End": 3706473600

   "TimeUnit": "MONTHLY"
},
"NotificationsWithSubscribers": [ 
      { 
         "Notification": { 
            "ComparisonOperator": "GREATER_THAN",
            "NotificationType": "ACTUAL",
            "Threshold": 80,
            "ThresholdType": "PERCENTAGE"
         },
         "Subscribers": [ 
            { 
               "Address": "example@example.com",
               "SubscriptionType": "EMAIL"
            }
         ]
      }
   ]
}

Example

The following is a sample request of the CreateBudget operation using ResourceTags and filtering for a specific tag.

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.CreateBudgets
{
  "AccountId": "111122223333",
  "Budget": {
    "BudgetLimit": {
      "Amount": "100",
      "Unit": "USD"
    },
    "BudgetName": "Example Tag Budget",
    "BudgetType": "COST",
    "CostFilters": {
      "TagKeyValue": [
        "user:tagKey1$value1",
        "user:tagKey2$value2"
      ]
    },
    "CostTypes": {
      "IncludeCredit": true,
      "IncludeDiscount": true,
      "IncludeOtherSubscription": true,
      "IncludeRecurring": true,
      "IncludeRefund": true,
      "IncludeSubscription": true,
      "IncludeSupport": true,
      "IncludeTax": true,
      "IncludeUpfront": true,
      "UseBlended": false
    },
    "TimePeriod": {
      "Start": 1477958399,
      "End": 3706473600
    },
    "TimeUnit": "MONTHLY"
  },
  "NotificationsWithSubscribers": [
    {
      "Notification": {
        "ComparisonOperator": "GREATER_THAN",
        "NotificationType": "ACTUAL",
        "Threshold": 80,
        "ThresholdType": "PERCENTAGE"
      },
      "Subscribers": [
        {
          "Address": "example@example.com",
          "SubscriptionType": "EMAIL"
        }
      ]
    }
  ],
  "ResourceTags": [
    {
      "Key": "tagKey1",
      "Value": "value1"
    },
    {
      "Key": "tagKey2",
      "Value": "value1"
    }
  ]
}

See Also

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