codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of budgets Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-10-20",
"endpointPrefix":"budgets",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"AWSBudgets",
"serviceFullName":"AWS Budgets",
"serviceId":"Budgets",
"signatureVersion":"v4",
"targetPrefix":"AWSBudgetServiceGateway",
"uid":"budgets-2016-10-20"
},
"operations":{
"CreateBudget":{
"name":"CreateBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateBudgetRequest"},
"output":{"shape":"CreateBudgetResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InternalErrorException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Creates a budget and, if included, notifications and subscribers.
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.
"
},
"CreateNotification":{
"name":"CreateNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateNotificationRequest"},
"output":{"shape":"CreateNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Creates a notification. You must create the budget before you create the associated notification.
"
},
"CreateSubscriber":{
"name":"CreateSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSubscriberRequest"},
"output":{"shape":"CreateSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"},
{"shape":"NotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
"
},
"DeleteBudget":{
"name":"DeleteBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteBudgetRequest"},
"output":{"shape":"DeleteBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Deletes a budget. You can delete your budget at any time.
Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
"
},
"DeleteNotification":{
"name":"DeleteNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteNotificationRequest"},
"output":{"shape":"DeleteNotificationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
"
},
"DeleteSubscriber":{
"name":"DeleteSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSubscriberRequest"},
"output":{"shape":"DeleteSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
"
},
"DescribeBudget":{
"name":"DescribeBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBudgetRequest"},
"output":{"shape":"DescribeBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Describes a budget.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
"
},
"DescribeBudgetPerformanceHistory":{
"name":"DescribeBudgetPerformanceHistory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBudgetPerformanceHistoryRequest"},
"output":{"shape":"DescribeBudgetPerformanceHistoryResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.
"
},
"DescribeBudgets":{
"name":"DescribeBudgets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBudgetsRequest"},
"output":{"shape":"DescribeBudgetsResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
"
},
"DescribeNotificationsForBudget":{
"name":"DescribeNotificationsForBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeNotificationsForBudgetRequest"},
"output":{"shape":"DescribeNotificationsForBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Lists the notifications that are associated with a budget.
"
},
"DescribeSubscribersForNotification":{
"name":"DescribeSubscribersForNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSubscribersForNotificationRequest"},
"output":{"shape":"DescribeSubscribersForNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Lists the subscribers that are associated with a notification.
"
},
"UpdateBudget":{
"name":"UpdateBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateBudgetRequest"},
"output":{"shape":"UpdateBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.
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.
"
},
"UpdateNotification":{
"name":"UpdateNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateNotificationRequest"},
"output":{"shape":"UpdateNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Updates a notification.
"
},
"UpdateSubscriber":{
"name":"UpdateSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSubscriberRequest"},
"output":{"shape":"UpdateSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"},
{"shape":"AccessDeniedException"}
],
"documentation":"Updates a subscriber.
"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"You are not authorized to use this operation with the given parameters.
",
"exception":true
},
"AccountId":{
"type":"string",
"documentation":"The account ID of the user. It should be a 12-digit number.
",
"max":12,
"min":12,
"pattern":"\\d{12}"
},
"Budget":{
"type":"structure",
"required":[
"BudgetName",
"TimeUnit",
"BudgetType"
],
"members":{
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of a budget. The name must be unique within an account. The : and \\ characters aren't allowed in BudgetName.
"
},
"BudgetLimit":{
"shape":"Spend",
"documentation":"The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.
BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
"
},
"PlannedBudgetLimits":{
"shape":"PlannedBudgetLimits",
"documentation":"A map containing multiple BudgetLimit, including current or future limits.
PlannedBudgetLimits is available for cost or usage budget and supports monthly and quarterly TimeUnit.
For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.
For quarterly budgets, provide 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.
If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.
After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.
DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
"
},
"CostFilters":{
"shape":"CostFilters",
"documentation":"The cost filters, such as service or tag, that are applied to a budget.
AWS Budgets supports the following services as a filter for RI budgets:
-
Amazon Elastic Compute Cloud - Compute
-
Amazon Redshift
-
Amazon Relational Database Service
-
Amazon ElastiCache
-
Amazon Elasticsearch Service
"
},
"CostTypes":{
"shape":"CostTypes",
"documentation":"The types of costs that are included in this COST budget.
USAGE, RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets do not have CostTypes.
"
},
"TimeUnit":{
"shape":"TimeUnit",
"documentation":"The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets.
"
},
"TimePeriod":{
"shape":"TimePeriod",
"documentation":"The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.
If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
You can change either date with the UpdateBudget operation.
After the end date, AWS deletes the budget and all associated notifications and subscribers.
"
},
"CalculatedSpend":{
"shape":"CalculatedSpend",
"documentation":"The actual and forecasted cost or usage that the budget tracks.
"
},
"BudgetType":{
"shape":"BudgetType",
"documentation":"Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
"
},
"LastUpdatedTime":{
"shape":"GenericTimestamp",
"documentation":"The last time that you updated this budget.
"
}
},
"documentation":"Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.
This is the ARN pattern for a budget:
arn:aws:budgetservice::AccountId:budget/budgetName
"
},
"BudgetName":{
"type":"string",
"documentation":" A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.
",
"max":100,
"min":1,
"pattern":"[^:\\\\]+"
},
"BudgetPerformanceHistory":{
"type":"structure",
"members":{
"BudgetName":{"shape":"BudgetName"},
"BudgetType":{"shape":"BudgetType"},
"CostFilters":{
"shape":"CostFilters",
"documentation":"The history of the cost filters for a budget during the specified time period.
"
},
"CostTypes":{
"shape":"CostTypes",
"documentation":"The history of the cost types for a budget during the specified time period.
"
},
"TimeUnit":{"shape":"TimeUnit"},
"BudgetedAndActualAmountsList":{
"shape":"BudgetedAndActualAmountsList",
"documentation":"A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.
"
}
},
"documentation":"A history of the state of a budget at the end of the budget's specified time period.
"
},
"BudgetType":{
"type":"string",
"documentation":" The type of a budget. It must be one of the following types:
COST, USAGE, RI_UTILIZATION, or RI_COVERAGE.
",
"enum":[
"USAGE",
"COST",
"RI_UTILIZATION",
"RI_COVERAGE",
"SAVINGS_PLANS_UTILIZATION",
"SAVINGS_PLANS_COVERAGE"
]
},
"BudgetedAndActualAmounts":{
"type":"structure",
"members":{
"BudgetedAmount":{
"shape":"Spend",
"documentation":"The amount of cost or usage that you created the budget for.
"
},
"ActualAmount":{
"shape":"Spend",
"documentation":"Your actual costs or usage for a budget period.
"
},
"TimePeriod":{
"shape":"TimePeriod",
"documentation":"The time period covered by this budget comparison.
"
}
},
"documentation":"The amount of cost or usage that you created the budget for, compared to your actual costs or usage.
"
},
"BudgetedAndActualAmountsList":{
"type":"list",
"member":{"shape":"BudgetedAndActualAmounts"}
},
"Budgets":{
"type":"list",
"member":{"shape":"Budget"},
"documentation":" A list of budgets.
"
},
"CalculatedSpend":{
"type":"structure",
"required":["ActualSpend"],
"members":{
"ActualSpend":{
"shape":"Spend",
"documentation":"The amount of cost, usage, or RI units that you have used.
"
},
"ForecastedSpend":{
"shape":"Spend",
"documentation":"The amount of cost, usage, or RI units that you are forecasted to use.
"
}
},
"documentation":"The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, or RI units, and the forecastedSpend tracks how much you are predicted to spend if your current usage remains steady.
For example, if it is the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.
"
},
"ComparisonOperator":{
"type":"string",
"documentation":" The comparison operator of a notification. Currently the service supports the following operators:
GREATER_THAN, LESS_THAN, EQUAL_TO
",
"enum":[
"GREATER_THAN",
"LESS_THAN",
"EQUAL_TO"
]
},
"CostFilters":{
"type":"map",
"key":{"shape":"GenericString"},
"value":{"shape":"DimensionValues"},
"documentation":" A map that represents the cost filters that are applied to the budget.
"
},
"CostTypes":{
"type":"structure",
"members":{
"IncludeTax":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes taxes.
The default value is true.
"
},
"IncludeSubscription":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes subscriptions.
The default value is true.
"
},
"UseBlended":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget uses a blended rate.
The default value is false.
"
},
"IncludeRefund":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes refunds.
The default value is true.
"
},
"IncludeCredit":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes credits.
The default value is true.
"
},
"IncludeUpfront":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes upfront RI costs.
The default value is true.
"
},
"IncludeRecurring":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes recurring fees such as monthly RI fees.
The default value is true.
"
},
"IncludeOtherSubscription":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes non-RI subscription costs.
The default value is true.
"
},
"IncludeSupport":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes support subscription fees.
The default value is true.
"
},
"IncludeDiscount":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget includes discounts.
The default value is true.
"
},
"UseAmortized":{
"shape":"NullableBoolean",
"documentation":"Specifies whether a budget uses the amortized rate.
The default value is false.
"
}
},
"documentation":"The types of cost that are included in a COST budget, such as tax and subscriptions.
USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes.
"
},
"CreateBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"Budget"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget.
"
},
"Budget":{
"shape":"Budget",
"documentation":"The budget object that you want to create.
"
},
"NotificationsWithSubscribers":{
"shape":"NotificationWithSubscribersList",
"documentation":"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.
"
}
},
"documentation":" Request of CreateBudget
"
},
"CreateBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of CreateBudget
"
},
"CreateNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscribers"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget that you want to create a notification for.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.
"
},
"Notification":{
"shape":"Notification",
"documentation":"The notification that you want to create.
"
},
"Subscribers":{
"shape":"Subscribers",
"documentation":"A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.
"
}
},
"documentation":" Request of CreateNotification
"
},
"CreateNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of CreateNotification
"
},
"CreateSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscriber"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget that you want to create a subscriber for.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget that you want to subscribe to. Budget names must be unique within an account.
"
},
"Notification":{
"shape":"Notification",
"documentation":"The notification that you want to create a subscriber for.
"
},
"Subscriber":{
"shape":"Subscriber",
"documentation":"The subscriber that you want to associate with a budget notification.
"
}
},
"documentation":" Request of CreateSubscriber
"
},
"CreateSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of CreateSubscriber
"
},
"CreationLimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"You've exceeded the notification or subscriber limit.
",
"exception":true
},
"DeleteBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget that you want to delete.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget that you want to delete.
"
}
},
"documentation":" Request of DeleteBudget
"
},
"DeleteBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of DeleteBudget
"
},
"DeleteNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget whose notification you want to delete.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget whose notification you want to delete.
"
},
"Notification":{
"shape":"Notification",
"documentation":"The notification that you want to delete.
"
}
},
"documentation":" Request of DeleteNotification
"
},
"DeleteNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of DeleteNotification
"
},
"DeleteSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscriber"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget whose subscriber you want to delete.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget whose subscriber you want to delete.
"
},
"Notification":{
"shape":"Notification",
"documentation":"The notification whose subscriber you want to delete.
"
},
"Subscriber":{
"shape":"Subscriber",
"documentation":"The subscriber that you want to delete.
"
}
},
"documentation":" Request of DeleteSubscriber
"
},
"DeleteSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of DeleteSubscriber
"
},
"DescribeBudgetPerformanceHistoryRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"TimePeriod":{
"shape":"TimePeriod",
"documentation":"Retrieves how often the budget went into an ALARM state for the specified time period.
"
},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
}
},
"DescribeBudgetPerformanceHistoryResponse":{
"type":"structure",
"members":{
"BudgetPerformanceHistory":{
"shape":"BudgetPerformanceHistory",
"documentation":"The history of how often the budget has gone into an ALARM state.
For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.
"
},
"NextToken":{"shape":"GenericString"}
}
},
"DescribeBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget that you want a description of.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget that you want a description of.
"
}
},
"documentation":" Request of DescribeBudget
"
},
"DescribeBudgetResponse":{
"type":"structure",
"members":{
"Budget":{
"shape":"Budget",
"documentation":"The description of the budget.
"
}
},
"documentation":" Response of DescribeBudget
"
},
"DescribeBudgetsRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budgets that you want descriptions of.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"An optional integer that represents how many entries a paginated response contains. The maximum is 100.
"
},
"NextToken":{
"shape":"GenericString",
"documentation":"The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
"
}
},
"documentation":" Request of DescribeBudgets
"
},
"DescribeBudgetsResponse":{
"type":"structure",
"members":{
"Budgets":{
"shape":"Budgets",
"documentation":"A list of budgets.
"
},
"NextToken":{
"shape":"GenericString",
"documentation":"The pagination token in the service response that indicates the next set of results that you can retrieve.
"
}
},
"documentation":" Response of DescribeBudgets
"
},
"DescribeNotificationsForBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget whose notifications you want descriptions of.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget whose notifications you want descriptions of.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"An optional integer that represents how many entries a paginated response contains. The maximum is 100.
"
},
"NextToken":{
"shape":"GenericString",
"documentation":"The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
"
}
},
"documentation":" Request of DescribeNotificationsForBudget
"
},
"DescribeNotificationsForBudgetResponse":{
"type":"structure",
"members":{
"Notifications":{
"shape":"Notifications",
"documentation":"A list of notifications that are associated with a budget.
"
},
"NextToken":{
"shape":"GenericString",
"documentation":"The pagination token in the service response that indicates the next set of results that you can retrieve.
"
}
},
"documentation":" Response of GetNotificationsForBudget
"
},
"DescribeSubscribersForNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget whose subscribers you want descriptions of.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget whose subscribers you want descriptions of.
"
},
"Notification":{
"shape":"Notification",
"documentation":"The notification whose subscribers you want to list.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"An optional integer that represents how many entries a paginated response contains. The maximum is 100.
"
},
"NextToken":{
"shape":"GenericString",
"documentation":"The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
"
}
},
"documentation":" Request of DescribeSubscribersForNotification
"
},
"DescribeSubscribersForNotificationResponse":{
"type":"structure",
"members":{
"Subscribers":{
"shape":"Subscribers",
"documentation":"A list of subscribers that are associated with a notification.
"
},
"NextToken":{
"shape":"GenericString",
"documentation":"The pagination token in the service response that indicates the next set of results that you can retrieve.
"
}
},
"documentation":" Response of DescribeSubscribersForNotification
"
},
"DimensionValues":{
"type":"list",
"member":{"shape":"GenericString"}
},
"DuplicateRecordException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"The budget name already exists. Budget names must be unique within an account.
",
"exception":true
},
"ExpiredNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"The pagination token expired.
",
"exception":true
},
"GenericString":{
"type":"string",
"documentation":" A generic string.
",
"max":2147483647,
"min":0,
"pattern":".*"
},
"GenericTimestamp":{
"type":"timestamp",
"documentation":" A generic time stamp. In Java, it is transformed to a Date object.
"
},
"InternalErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"An error on the server occurred during the processing of your request. Try again later.
",
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"The pagination token is invalid.
",
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"An error on the client occurred. Typically, the cause is an invalid input value.
",
"exception":true
},
"MaxResults":{
"type":"integer",
"documentation":" An integer that represents how many entries a paginated response contains. The maximum is 100.
",
"box":true,
"max":100,
"min":1
},
"NotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"We can’t locate the resource that you specified.
",
"exception":true
},
"Notification":{
"type":"structure",
"required":[
"NotificationType",
"ComparisonOperator",
"Threshold"
],
"members":{
"NotificationType":{
"shape":"NotificationType",
"documentation":"Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
"
},
"ComparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"The comparison that is used for this notification.
"
},
"Threshold":{
"shape":"NotificationThreshold",
"documentation":"The threshold that is associated with a notification. Thresholds are always a percentage.
"
},
"ThresholdType":{
"shape":"ThresholdType",
"documentation":"The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.
"
},
"NotificationState":{
"shape":"NotificationState",
"documentation":"Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.
"
}
},
"documentation":"A notification that is associated with a budget. A budget can have up to five notifications.
Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:
-
A notificationType of ACTUAL
-
A thresholdType of PERCENTAGE
-
A comparisonOperator of GREATER_THAN
-
A notification threshold of 80
"
},
"NotificationState":{
"type":"string",
"enum":[
"OK",
"ALARM"
]
},
"NotificationThreshold":{
"type":"double",
"documentation":" The threshold of a notification. It must be a number between 0 and 1,000,000,000.
",
"max":1000000000,
"min":0
},
"NotificationType":{
"type":"string",
"documentation":" The type of a notification. It must be ACTUAL or FORECASTED.
",
"enum":[
"ACTUAL",
"FORECASTED"
]
},
"NotificationWithSubscribers":{
"type":"structure",
"required":[
"Notification",
"Subscribers"
],
"members":{
"Notification":{
"shape":"Notification",
"documentation":"The notification that is associated with a budget.
"
},
"Subscribers":{
"shape":"Subscribers",
"documentation":"A list of subscribers who are subscribed to this notification.
"
}
},
"documentation":"A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
"
},
"NotificationWithSubscribersList":{
"type":"list",
"member":{"shape":"NotificationWithSubscribers"},
"documentation":" A list of notifications, each with a list of subscribers.
",
"max":5
},
"Notifications":{
"type":"list",
"member":{"shape":"Notification"},
"documentation":" A list of notifications.
"
},
"NullableBoolean":{
"type":"boolean",
"box":true
},
"NumericValue":{
"type":"string",
"documentation":" A string that represents a numeric value.
",
"max":2147483647,
"min":1,
"pattern":"([0-9]*\\.)?[0-9]+"
},
"PlannedBudgetLimits":{
"type":"map",
"key":{"shape":"GenericString"},
"value":{"shape":"Spend"}
},
"Spend":{
"type":"structure",
"required":[
"Amount",
"Unit"
],
"members":{
"Amount":{
"shape":"NumericValue",
"documentation":"The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.
"
},
"Unit":{
"shape":"UnitValue",
"documentation":"The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.
"
}
},
"documentation":"The amount of cost or usage that is measured for a budget.
For example, a Spend for 3 GB of S3 usage would have the following parameters:
-
An Amount of 3
-
A unit of GB
"
},
"Subscriber":{
"type":"structure",
"required":[
"SubscriptionType",
"Address"
],
"members":{
"SubscriptionType":{
"shape":"SubscriptionType",
"documentation":"The type of notification that AWS sends to a subscriber.
"
},
"Address":{
"shape":"SubscriberAddress",
"documentation":"The address that AWS sends budget notifications to, either an SNS topic or an email.
When you create a subscriber, the value of Address can't contain line breaks.
"
}
},
"documentation":"The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
For example, an email subscriber would have the following parameters:
-
A subscriptionType of EMAIL
-
An address of [email protected]
"
},
"SubscriberAddress":{
"type":"string",
"documentation":" A string that contains an email address or SNS topic for the subscriber's address.
",
"max":2147483647,
"min":1,
"pattern":"(.*[\\n\\r\\t\\f\\ ]?)*",
"sensitive":true
},
"Subscribers":{
"type":"list",
"member":{"shape":"Subscriber"},
"documentation":" A list of subscribers.
",
"max":11,
"min":1
},
"SubscriptionType":{
"type":"string",
"documentation":" The subscription type of the subscriber. It can be SMS or EMAIL.
",
"enum":[
"SNS",
"EMAIL"
]
},
"ThresholdType":{
"type":"string",
"documentation":" The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.
",
"enum":[
"PERCENTAGE",
"ABSOLUTE_VALUE"
]
},
"TimePeriod":{
"type":"structure",
"members":{
"Start":{
"shape":"GenericTimestamp",
"documentation":"The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget operation.
"
},
"End":{
"shape":"GenericTimestamp",
"documentation":"The end date for a budget. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget operation.
"
}
},
"documentation":"The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
"
},
"TimeUnit":{
"type":"string",
"documentation":" The time unit of the budget, such as MONTHLY or QUARTERLY.
",
"enum":[
"DAILY",
"MONTHLY",
"QUARTERLY",
"ANNUALLY"
]
},
"UnitValue":{
"type":"string",
"documentation":" A string that represents the spend unit of a budget. It can't be null or empty.
",
"max":2147483647,
"min":1,
"pattern":".*"
},
"UpdateBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"NewBudget"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget that you want to update.
"
},
"NewBudget":{
"shape":"Budget",
"documentation":"The budget that you want to update your budget to.
"
}
},
"documentation":" Request of UpdateBudget
"
},
"UpdateBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of UpdateBudget
"
},
"UpdateNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"OldNotification",
"NewNotification"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget whose notification you want to update.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget whose notification you want to update.
"
},
"OldNotification":{
"shape":"Notification",
"documentation":"The previous notification that is associated with a budget.
"
},
"NewNotification":{
"shape":"Notification",
"documentation":"The updated notification to be associated with a budget.
"
}
},
"documentation":" Request of UpdateNotification
"
},
"UpdateNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of UpdateNotification
"
},
"UpdateSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"OldSubscriber",
"NewSubscriber"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The accountId that is associated with the budget whose subscriber you want to update.
"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"The name of the budget whose subscriber you want to update.
"
},
"Notification":{
"shape":"Notification",
"documentation":"The notification whose subscriber you want to update.
"
},
"OldSubscriber":{
"shape":"Subscriber",
"documentation":"The previous subscriber that is associated with a budget notification.
"
},
"NewSubscriber":{
"shape":"Subscriber",
"documentation":"The updated subscriber that is associated with a budget notification.
"
}
},
"documentation":" Request of UpdateSubscriber
"
},
"UpdateSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":" Response of UpdateSubscriber
"
},
"errorMessage":{
"type":"string",
"documentation":"The error message the exception carries.
"
}
},
"documentation":"The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets.
Budgets provide you with a way to see the following information:
-
How close your plan is to your budgeted amount or to the free tier limits
-
Your usage-to-date, including how much you've used of your Reserved Instances (RIs)
-
Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month
-
How much of your budget has been used
AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:
-
Cost budgets - Plan how much you want to spend on a service.
-
Usage budgets - Plan how much you want to use one or more services.
-
RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.
-
RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.
Service Endpoint
The AWS Budgets API provides the following endpoint:
-
https://budgets.amazonaws.com
For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing.
"
}