File: //opt/go/pkg/mod/github.com/aws/
[email protected]/models/apis/budgets/2016-10-20/docs-2.json
{
"version": "2.0",
"service": "<p>Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature. </p> <p>Budgets provide you with a way to see the following information:</p> <ul> <li> <p>How close your plan is to your budgeted amount or to the free tier limits</p> </li> <li> <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p> </li> <li> <p>Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month</p> </li> <li> <p>How much of your budget has been used</p> </li> </ul> <p>Amazon Web Services 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:</p> <ul> <li> <p> <b>Cost budgets</b> - Plan how much you want to spend on a service.</p> </li> <li> <p> <b>Usage budgets</b> - Plan how much you want to use one or more services.</p> </li> <li> <p> <b>RI utilization budgets</b> - 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.</p> </li> <li> <p> <b>RI coverage budgets</b> - 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.</p> </li> </ul> <p>Service Endpoint</p> <p>The Amazon Web Services Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.amazonaws.com</p> </li> </ul> <p>For information about costs that are associated with the Amazon Web Services Budgets API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">Amazon Web Services Cost Management Pricing</a>.</p>",
"operations": {
"CreateBudget": "<p>Creates a budget and, if included, notifications and subscribers. </p> <important> <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples\">Examples</a> section. </p> </important>",
"CreateBudgetAction": "<p> Creates a budget action. </p>",
"CreateNotification": "<p>Creates a notification. You must create the budget before you create the associated notification.</p>",
"CreateSubscriber": "<p>Creates a subscriber. You must create the associated budget and notification before you create the subscriber.</p>",
"DeleteBudget": "<p>Deletes a budget. You can delete your budget at any time.</p> <important> <p>Deleting a budget also deletes the notifications and subscribers that are associated with that budget.</p> </important>",
"DeleteBudgetAction": "<p> Deletes a budget action. </p>",
"DeleteNotification": "<p>Deletes a notification.</p> <important> <p>Deleting a notification also deletes the subscribers that are associated with the notification.</p> </important>",
"DeleteSubscriber": "<p>Deletes a subscriber.</p> <important> <p>Deleting the last subscriber to a notification also deletes the notification.</p> </important>",
"DescribeBudget": "<p>Describes a budget.</p> <important> <p>The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples\">Examples</a> section. </p> </important>",
"DescribeBudgetAction": "<p> Describes a budget action detail. </p>",
"DescribeBudgetActionHistories": "<p> Describes a budget action history detail. </p>",
"DescribeBudgetActionsForAccount": "<p> Describes all of the budget actions for an account. </p>",
"DescribeBudgetActionsForBudget": "<p> Describes all of the budget actions for a budget. </p>",
"DescribeBudgetNotificationsForAccount": "<p> Lists the budget names and notifications that are associated with an account. </p>",
"DescribeBudgetPerformanceHistory": "<p>Describes the history for <code>DAILY</code>, <code>MONTHLY</code>, and <code>QUARTERLY</code> budgets. Budget history isn't available for <code>ANNUAL</code> budgets.</p>",
"DescribeBudgets": "<p>Lists the budgets that are associated with an account.</p> <important> <p>The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples\">Examples</a> section. </p> </important>",
"DescribeNotificationsForBudget": "<p>Lists the notifications that are associated with a budget.</p>",
"DescribeSubscribersForNotification": "<p>Lists the subscribers that are associated with a notification.</p>",
"ExecuteBudgetAction": "<p> Executes a budget action. </p>",
"ListTagsForResource": "<p>Lists tags associated with a budget or budget action resource.</p>",
"TagResource": "<p>Creates tags for a budget or budget action resource.</p>",
"UntagResource": "<p>Deletes tags associated with a budget or budget action resource.</p>",
"UpdateBudget": "<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until Amazon Web Services has new usage data to use for forecasting.</p> <important> <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples\">Examples</a> section. </p> </important>",
"UpdateBudgetAction": "<p> Updates a budget action. </p>",
"UpdateNotification": "<p>Updates a notification.</p>",
"UpdateSubscriber": "<p>Updates a subscriber.</p>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>You are not authorized to use this operation with the given parameters.</p>",
"refs": {
}
},
"AccountId": {
"base": "<p>The account ID of the user. It's a 12-digit number.</p>",
"refs": {
"CreateBudgetActionRequest$AccountId": null,
"CreateBudgetActionResponse$AccountId": null,
"CreateBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget.</p>",
"CreateNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to create a notification for.</p>",
"CreateSubscriberRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to create a subscriber for.</p>",
"DeleteBudgetActionRequest$AccountId": null,
"DeleteBudgetActionResponse$AccountId": null,
"DeleteBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to delete.</p>",
"DeleteNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notification you want to delete.</p>",
"DeleteSubscriberRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose subscriber you want to delete.</p>",
"DescribeBudgetActionHistoriesRequest$AccountId": null,
"DescribeBudgetActionRequest$AccountId": null,
"DescribeBudgetActionResponse$AccountId": null,
"DescribeBudgetActionsForAccountRequest$AccountId": null,
"DescribeBudgetActionsForBudgetRequest$AccountId": null,
"DescribeBudgetNotificationsForAccountRequest$AccountId": null,
"DescribeBudgetPerformanceHistoryRequest$AccountId": null,
"DescribeBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want a description of.</p>",
"DescribeBudgetsRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budgets that you want to describe.</p>",
"DescribeNotificationsForBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notifications you want descriptions of.</p>",
"DescribeSubscribersForNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose subscribers you want descriptions of.</p>",
"ExecuteBudgetActionRequest$AccountId": null,
"ExecuteBudgetActionResponse$AccountId": null,
"UpdateBudgetActionRequest$AccountId": null,
"UpdateBudgetActionResponse$AccountId": null,
"UpdateBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to update.</p>",
"UpdateNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notification you want to update.</p>",
"UpdateSubscriberRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose subscriber you want to update.</p>"
}
},
"Action": {
"base": "<p>A budget action resource. </p>",
"refs": {
"ActionHistoryDetails$Action": "<p>The budget action resource. </p>",
"Actions$member": null,
"DeleteBudgetActionResponse$Action": null,
"DescribeBudgetActionResponse$Action": "<p> A budget action resource. </p>",
"UpdateBudgetActionResponse$OldAction": "<p> The previous action resource information. </p>",
"UpdateBudgetActionResponse$NewAction": "<p> The updated action resource information. </p>"
}
},
"ActionHistories": {
"base": null,
"refs": {
"DescribeBudgetActionHistoriesResponse$ActionHistories": "<p> The historical record of the budget action resource. </p>"
}
},
"ActionHistory": {
"base": "<p>The historical records for a budget action. </p>",
"refs": {
"ActionHistories$member": null
}
},
"ActionHistoryDetails": {
"base": "<p>The description of the details for the event. </p>",
"refs": {
"ActionHistory$ActionHistoryDetails": "<p>The description of the details for the event. </p>"
}
},
"ActionId": {
"base": null,
"refs": {
"Action$ActionId": "<p>A system-generated universally unique identifier (UUID) for the action. </p>",
"CreateBudgetActionResponse$ActionId": "<p> A system-generated universally unique identifier (UUID) for the action. </p>",
"DeleteBudgetActionRequest$ActionId": "<p> A system-generated universally unique identifier (UUID) for the action. </p>",
"DescribeBudgetActionHistoriesRequest$ActionId": "<p> A system-generated universally unique identifier (UUID) for the action. </p>",
"DescribeBudgetActionRequest$ActionId": "<p> A system-generated universally unique identifier (UUID) for the action. </p>",
"ExecuteBudgetActionRequest$ActionId": "<p> A system-generated universally unique identifier (UUID) for the action. </p>",
"ExecuteBudgetActionResponse$ActionId": "<p> A system-generated universally unique identifier (UUID) for the action. </p>",
"UpdateBudgetActionRequest$ActionId": "<p> A system-generated universally unique identifier (UUID) for the action. </p>"
}
},
"ActionStatus": {
"base": null,
"refs": {
"Action$Status": "<p>The status of the action. </p>",
"ActionHistory$Status": "<p>The status of action at the time of the event. </p>"
}
},
"ActionSubType": {
"base": null,
"refs": {
"SsmActionDefinition$ActionSubType": "<p>The action subType. </p>"
}
},
"ActionThreshold": {
"base": "<p>The trigger threshold of the action. </p>",
"refs": {
"Action$ActionThreshold": "<p>The trigger threshold of the action. </p>",
"CreateBudgetActionRequest$ActionThreshold": null,
"UpdateBudgetActionRequest$ActionThreshold": null
}
},
"ActionType": {
"base": null,
"refs": {
"Action$ActionType": "<p>The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition. </p>",
"CreateBudgetActionRequest$ActionType": "<p> The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition. </p>"
}
},
"Actions": {
"base": null,
"refs": {
"DescribeBudgetActionsForAccountResponse$Actions": "<p> A list of the budget action resources information. </p>",
"DescribeBudgetActionsForBudgetResponse$Actions": "<p> A list of the budget action resources information. </p>"
}
},
"AdjustmentPeriod": {
"base": null,
"refs": {
"HistoricalOptions$BudgetAdjustmentPeriod": "<p>The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the <code>TimeUnit</code> granularity of the budget:</p> <ul> <li> <p>For the <code>DAILY</code> granularity, the maximum value is <code>60</code>.</p> </li> <li> <p>For the <code>MONTHLY</code> granularity, the maximum value is <code>12</code>.</p> </li> <li> <p>For the <code>QUARTERLY</code> granularity, the maximum value is <code>4</code>.</p> </li> <li> <p>For the <code>ANNUALLY</code> granularity, the maximum value is <code>1</code>.</p> </li> </ul>",
"HistoricalOptions$LookBackAvailablePeriods": "<p>The integer that describes how many budget periods in your <code>BudgetAdjustmentPeriod</code> are included in the calculation of your current <code>BudgetLimit</code>. If the first budget period in your <code>BudgetAdjustmentPeriod</code> has no cost data, then that budget period isn’t included in the average that determines your budget limit. </p> <p>For example, if you set <code>BudgetAdjustmentPeriod</code> as <code>4</code> quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, <code>LookBackAvailablePeriods</code> returns <code>3</code>. </p> <p>You can’t set your own <code>LookBackAvailablePeriods</code>. The value is automatically calculated from the <code>BudgetAdjustmentPeriod</code> and your historical cost data.</p>"
}
},
"AmazonResourceName": {
"base": null,
"refs": {
"ListTagsForResourceRequest$ResourceARN": "<p>The unique identifier for the resource.</p>",
"TagResourceRequest$ResourceARN": "<p>The unique identifier for the resource.</p>",
"UntagResourceRequest$ResourceARN": "<p>The unique identifier for the resource.</p>"
}
},
"ApprovalModel": {
"base": null,
"refs": {
"Action$ApprovalModel": "<p>This specifies if the action needs manual or automatic approval. </p>",
"CreateBudgetActionRequest$ApprovalModel": "<p> This specifies if the action needs manual or automatic approval. </p>",
"UpdateBudgetActionRequest$ApprovalModel": "<p> This specifies if the action needs manual or automatic approval. </p>"
}
},
"AutoAdjustData": {
"base": "<p>The parameters that determine the budget amount for an auto-adjusting budget.</p>",
"refs": {
"Budget$AutoAdjustData": "<p>The parameters that determine the budget amount for an auto-adjusting budget.</p>"
}
},
"AutoAdjustType": {
"base": null,
"refs": {
"AutoAdjustData$AutoAdjustType": "<p>The string that defines whether your budget auto-adjusts based on historical or forecasted data.</p>"
}
},
"Budget": {
"base": "<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code> object.</p> <p>This is the Amazon Resource Name (ARN) pattern for a budget: </p> <p> <code>arn:aws:budgets::AccountId:budget/budgetName</code> </p>",
"refs": {
"Budgets$member": null,
"CreateBudgetRequest$Budget": "<p>The budget object that you want to create.</p>",
"DescribeBudgetResponse$Budget": "<p>The description of the budget.</p>",
"UpdateBudgetRequest$NewBudget": "<p>The budget that you want to update your budget to.</p>"
}
},
"BudgetName": {
"base": "<p> A string that represents the budget name. The \":\" and \"\\\" characters, and the \"/action/\" substring, aren't allowed.</p>",
"refs": {
"Action$BudgetName": null,
"Budget$BudgetName": "<p>The name of a budget. The name must be unique within an account. The <code>:</code> and <code>\\</code> characters, and the \"/action/\" substring, aren't allowed in <code>BudgetName</code>.</p>",
"BudgetNotificationsForAccount$BudgetName": null,
"BudgetPerformanceHistory$BudgetName": null,
"CreateBudgetActionRequest$BudgetName": null,
"CreateBudgetActionResponse$BudgetName": null,
"CreateNotificationRequest$BudgetName": "<p>The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.</p>",
"CreateSubscriberRequest$BudgetName": "<p>The name of the budget that you want to subscribe to. Budget names must be unique within an account.</p>",
"DeleteBudgetActionRequest$BudgetName": null,
"DeleteBudgetActionResponse$BudgetName": null,
"DeleteBudgetRequest$BudgetName": "<p>The name of the budget that you want to delete.</p>",
"DeleteNotificationRequest$BudgetName": "<p>The name of the budget whose notification you want to delete.</p>",
"DeleteSubscriberRequest$BudgetName": "<p>The name of the budget whose subscriber you want to delete.</p>",
"DescribeBudgetActionHistoriesRequest$BudgetName": null,
"DescribeBudgetActionRequest$BudgetName": null,
"DescribeBudgetActionResponse$BudgetName": null,
"DescribeBudgetActionsForBudgetRequest$BudgetName": null,
"DescribeBudgetPerformanceHistoryRequest$BudgetName": null,
"DescribeBudgetRequest$BudgetName": "<p>The name of the budget that you want a description of.</p>",
"DescribeNotificationsForBudgetRequest$BudgetName": "<p>The name of the budget whose notifications you want descriptions of.</p>",
"DescribeSubscribersForNotificationRequest$BudgetName": "<p>The name of the budget whose subscribers you want descriptions of.</p>",
"ExecuteBudgetActionRequest$BudgetName": null,
"ExecuteBudgetActionResponse$BudgetName": null,
"UpdateBudgetActionRequest$BudgetName": null,
"UpdateBudgetActionResponse$BudgetName": null,
"UpdateNotificationRequest$BudgetName": "<p>The name of the budget whose notification you want to update.</p>",
"UpdateSubscriberRequest$BudgetName": "<p>The name of the budget whose subscriber you want to update.</p>"
}
},
"BudgetNotificationsForAccount": {
"base": "<p> The budget name and associated notifications for an account. </p>",
"refs": {
"BudgetNotificationsForAccountList$member": null
}
},
"BudgetNotificationsForAccountList": {
"base": null,
"refs": {
"DescribeBudgetNotificationsForAccountResponse$BudgetNotificationsForAccount": "<p> A list of budget names and associated notifications for an account. </p>"
}
},
"BudgetPerformanceHistory": {
"base": "<p>A history of the state of a budget at the end of the budget's specified time period.</p>",
"refs": {
"DescribeBudgetPerformanceHistoryResponse$BudgetPerformanceHistory": "<p>The history of how often the budget has gone into an <code>ALARM</code> state.</p> <p>For <code>DAILY</code> budgets, the history saves the state of the budget for the last 60 days. For <code>MONTHLY</code> budgets, the history saves the state of the budget for the current month plus the last 12 months. For <code>QUARTERLY</code> budgets, the history saves the state of the budget for the last four quarters.</p>"
}
},
"BudgetType": {
"base": "<p> The type of a budget. It must be one of the following types: </p> <p> <code>COST</code>, <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>SAVINGS_PLANS_UTILIZATION</code>, or <code>SAVINGS_PLANS_COVERAGE</code>.</p>",
"refs": {
"Budget$BudgetType": "<p>Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.</p>",
"BudgetPerformanceHistory$BudgetType": null
}
},
"BudgetedAndActualAmounts": {
"base": "<p>The amount of cost or usage that you created the budget for, compared to your actual costs or usage.</p>",
"refs": {
"BudgetedAndActualAmountsList$member": null
}
},
"BudgetedAndActualAmountsList": {
"base": null,
"refs": {
"BudgetPerformanceHistory$BudgetedAndActualAmountsList": "<p>A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.</p>"
}
},
"Budgets": {
"base": "<p> A list of budgets.</p>",
"refs": {
"DescribeBudgetsResponse$Budgets": "<p>A list of budgets.</p>"
}
},
"CalculatedSpend": {
"base": "<p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, RI units, or Savings Plans units and the <code>forecastedSpend</code> tracks how much that you're predicted to spend based on your historical usage profile.</p> <p>For example, if it's the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>",
"refs": {
"Budget$CalculatedSpend": "<p>The actual and forecasted cost or usage that the budget tracks.</p>"
}
},
"ComparisonOperator": {
"base": "<p> The comparison operator of a notification. Currently, the service supports the following operators:</p> <p> <code>GREATER_THAN</code>, <code>LESS_THAN</code>, <code>EQUAL_TO</code> </p>",
"refs": {
"Notification$ComparisonOperator": "<p>The comparison that's used for this notification.</p>"
}
},
"CostFilters": {
"base": "<p> A map that represents the cost filters that are applied to the budget.</p>",
"refs": {
"Budget$CostFilters": "<p>The cost filters, such as <code>Region</code>, <code>Service</code>, <code>LinkedAccount</code>, <code>Tag</code>, or <code>CostCategory</code>, that are applied to a budget.</p> <p>Amazon Web Services Budgets supports the following services as a <code>Service</code> filter for RI budgets:</p> <ul> <li> <p>Amazon EC2</p> </li> <li> <p>Amazon Redshift</p> </li> <li> <p>Amazon Relational Database Service</p> </li> <li> <p>Amazon ElastiCache</p> </li> <li> <p>Amazon OpenSearch Service</p> </li> </ul>",
"BudgetPerformanceHistory$CostFilters": "<p>The history of the cost filters for a budget during the specified time period.</p>"
}
},
"CostTypes": {
"base": "<p>The types of cost that are included in a <code>COST</code> budget, such as tax and subscriptions.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>SAVINGS_PLANS_UTILIZATION</code>, and <code>SAVINGS_PLANS_COVERAGE</code> budgets don't have <code>CostTypes</code>.</p>",
"refs": {
"Budget$CostTypes": "<p>The types of costs that are included in this <code>COST</code> budget.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>SAVINGS_PLANS_UTILIZATION</code>, and <code>SAVINGS_PLANS_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>",
"BudgetPerformanceHistory$CostTypes": "<p>The history of the cost types for a budget during the specified time period.</p>"
}
},
"CreateBudgetActionRequest": {
"base": null,
"refs": {
}
},
"CreateBudgetActionResponse": {
"base": null,
"refs": {
}
},
"CreateBudgetRequest": {
"base": "<p> Request of CreateBudget </p>",
"refs": {
}
},
"CreateBudgetResponse": {
"base": "<p> Response of CreateBudget </p>",
"refs": {
}
},
"CreateNotificationRequest": {
"base": "<p> Request of CreateNotification </p>",
"refs": {
}
},
"CreateNotificationResponse": {
"base": "<p> Response of CreateNotification </p>",
"refs": {
}
},
"CreateSubscriberRequest": {
"base": "<p> Request of CreateSubscriber </p>",
"refs": {
}
},
"CreateSubscriberResponse": {
"base": "<p> Response of CreateSubscriber </p>",
"refs": {
}
},
"CreationLimitExceededException": {
"base": "<p>You've exceeded the notification or subscriber limit.</p>",
"refs": {
}
},
"Definition": {
"base": "<p>Specifies all of the type-specific parameters. </p>",
"refs": {
"Action$Definition": "<p>Where you specify all of the type-specific parameters. </p>",
"CreateBudgetActionRequest$Definition": null,
"UpdateBudgetActionRequest$Definition": null
}
},
"DeleteBudgetActionRequest": {
"base": null,
"refs": {
}
},
"DeleteBudgetActionResponse": {
"base": null,
"refs": {
}
},
"DeleteBudgetRequest": {
"base": "<p> Request of DeleteBudget </p>",
"refs": {
}
},
"DeleteBudgetResponse": {
"base": "<p> Response of DeleteBudget </p>",
"refs": {
}
},
"DeleteNotificationRequest": {
"base": "<p> Request of DeleteNotification </p>",
"refs": {
}
},
"DeleteNotificationResponse": {
"base": "<p> Response of DeleteNotification </p>",
"refs": {
}
},
"DeleteSubscriberRequest": {
"base": "<p> Request of DeleteSubscriber </p>",
"refs": {
}
},
"DeleteSubscriberResponse": {
"base": "<p> Response of DeleteSubscriber </p>",
"refs": {
}
},
"DescribeBudgetActionHistoriesRequest": {
"base": null,
"refs": {
}
},
"DescribeBudgetActionHistoriesResponse": {
"base": null,
"refs": {
}
},
"DescribeBudgetActionRequest": {
"base": null,
"refs": {
}
},
"DescribeBudgetActionResponse": {
"base": null,
"refs": {
}
},
"DescribeBudgetActionsForAccountRequest": {
"base": null,
"refs": {
}
},
"DescribeBudgetActionsForAccountResponse": {
"base": null,
"refs": {
}
},
"DescribeBudgetActionsForBudgetRequest": {
"base": null,
"refs": {
}
},
"DescribeBudgetActionsForBudgetResponse": {
"base": null,
"refs": {
}
},
"DescribeBudgetNotificationsForAccountRequest": {
"base": null,
"refs": {
}
},
"DescribeBudgetNotificationsForAccountResponse": {
"base": null,
"refs": {
}
},
"DescribeBudgetPerformanceHistoryRequest": {
"base": null,
"refs": {
}
},
"DescribeBudgetPerformanceHistoryResponse": {
"base": null,
"refs": {
}
},
"DescribeBudgetRequest": {
"base": "<p> Request of DescribeBudget </p>",
"refs": {
}
},
"DescribeBudgetResponse": {
"base": "<p> Response of DescribeBudget </p>",
"refs": {
}
},
"DescribeBudgetsRequest": {
"base": "<p> Request of DescribeBudgets </p>",
"refs": {
}
},
"DescribeBudgetsResponse": {
"base": "<p> Response of DescribeBudgets </p>",
"refs": {
}
},
"DescribeNotificationsForBudgetRequest": {
"base": "<p> Request of DescribeNotificationsForBudget </p>",
"refs": {
}
},
"DescribeNotificationsForBudgetResponse": {
"base": "<p> Response of GetNotificationsForBudget </p>",
"refs": {
}
},
"DescribeSubscribersForNotificationRequest": {
"base": "<p> Request of DescribeSubscribersForNotification </p>",
"refs": {
}
},
"DescribeSubscribersForNotificationResponse": {
"base": "<p> Response of DescribeSubscribersForNotification </p>",
"refs": {
}
},
"DimensionValue": {
"base": null,
"refs": {
"DimensionValues$member": null
}
},
"DimensionValues": {
"base": null,
"refs": {
"CostFilters$value": null
}
},
"DuplicateRecordException": {
"base": "<p>The budget name already exists. Budget names must be unique within an account.</p>",
"refs": {
}
},
"EventType": {
"base": null,
"refs": {
"ActionHistory$EventType": "<p>This distinguishes between whether the events are triggered by the user or are generated by the system. </p>"
}
},
"ExecuteBudgetActionRequest": {
"base": null,
"refs": {
}
},
"ExecuteBudgetActionResponse": {
"base": null,
"refs": {
}
},
"ExecutionType": {
"base": null,
"refs": {
"ExecuteBudgetActionRequest$ExecutionType": "<p> The type of execution. </p>",
"ExecuteBudgetActionResponse$ExecutionType": "<p> The type of execution. </p>"
}
},
"ExpiredNextTokenException": {
"base": "<p>The pagination token expired.</p>",
"refs": {
}
},
"GenericString": {
"base": "<p> A generic string.</p>",
"refs": {
"ActionHistoryDetails$Message": null,
"CostFilters$key": null,
"DescribeBudgetActionHistoriesRequest$NextToken": null,
"DescribeBudgetActionHistoriesResponse$NextToken": null,
"DescribeBudgetActionsForAccountRequest$NextToken": null,
"DescribeBudgetActionsForAccountResponse$NextToken": null,
"DescribeBudgetActionsForBudgetRequest$NextToken": null,
"DescribeBudgetActionsForBudgetResponse$NextToken": null,
"DescribeBudgetNotificationsForAccountRequest$NextToken": null,
"DescribeBudgetNotificationsForAccountResponse$NextToken": null,
"DescribeBudgetPerformanceHistoryRequest$NextToken": null,
"DescribeBudgetPerformanceHistoryResponse$NextToken": null,
"DescribeBudgetsRequest$NextToken": "<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>",
"DescribeBudgetsResponse$NextToken": "<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>",
"DescribeNotificationsForBudgetRequest$NextToken": "<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>",
"DescribeNotificationsForBudgetResponse$NextToken": "<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>",
"DescribeSubscribersForNotificationRequest$NextToken": "<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>",
"DescribeSubscribersForNotificationResponse$NextToken": "<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>",
"PlannedBudgetLimits$key": null
}
},
"GenericTimestamp": {
"base": "<p> A generic time stamp. In Java, it's transformed to a <code>Date</code> object.</p>",
"refs": {
"ActionHistory$Timestamp": null,
"AutoAdjustData$LastAutoAdjustTime": "<p>The last time that your budget was auto-adjusted.</p>",
"Budget$LastUpdatedTime": "<p>The last time that you updated this budget.</p>",
"TimePeriod$Start": "<p>The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services 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 <code>DAILY</code>, and didn't set a start date, Amazon Web Services set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, Amazon Web Services set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>",
"TimePeriod$End": "<p>The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API.</p> <p>After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</p>"
}
},
"Group": {
"base": null,
"refs": {
"Groups$member": null
}
},
"Groups": {
"base": null,
"refs": {
"IamActionDefinition$Groups": "<p>A list of groups to be attached. There must be at least one group. </p>"
}
},
"HistoricalOptions": {
"base": "<p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>",
"refs": {
"AutoAdjustData$HistoricalOptions": "<p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>"
}
},
"IamActionDefinition": {
"base": "<p>The Identity and Access Management (IAM) action definition details. </p>",
"refs": {
"Definition$IamActionDefinition": "<p>The Identity and Access Management (IAM) action definition details. </p>"
}
},
"InstanceId": {
"base": null,
"refs": {
"InstanceIds$member": null
}
},
"InstanceIds": {
"base": null,
"refs": {
"SsmActionDefinition$InstanceIds": "<p>The EC2 and RDS instance IDs. </p>"
}
},
"InternalErrorException": {
"base": "<p>An error on the server occurred during the processing of your request. Try again later.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>The pagination token is invalid.</p>",
"refs": {
}
},
"InvalidParameterException": {
"base": "<p>An error on the client occurred. Typically, the cause is an invalid input value.</p>",
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"MaxResults": {
"base": "<p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
"refs": {
"DescribeBudgetActionHistoriesRequest$MaxResults": null,
"DescribeBudgetActionsForAccountRequest$MaxResults": null,
"DescribeBudgetActionsForBudgetRequest$MaxResults": null,
"DescribeBudgetPerformanceHistoryRequest$MaxResults": null,
"DescribeNotificationsForBudgetRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains.</p>",
"DescribeSubscribersForNotificationRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains.</p>"
}
},
"MaxResultsBudgetNotifications": {
"base": null,
"refs": {
"DescribeBudgetNotificationsForAccountRequest$MaxResults": "<p> An integer that represents how many budgets a paginated response contains. The default is 50. </p>"
}
},
"MaxResultsDescribeBudgets": {
"base": null,
"refs": {
"DescribeBudgetsRequest$MaxResults": "<p>An integer that represents how many budgets a paginated response contains. The default is 100.</p>"
}
},
"NotFoundException": {
"base": "<p>We can’t locate the resource that you specified.</p>",
"refs": {
}
},
"Notification": {
"base": "<p>A notification that's associated with a budget. A budget can have up to ten notifications. </p> <p>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.</p> <p>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:</p> <ul> <li> <p>A notificationType of <code>ACTUAL</code> </p> </li> <li> <p>A <code>thresholdType</code> of <code>PERCENTAGE</code> </p> </li> <li> <p>A <code>comparisonOperator</code> of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification <code>threshold</code> of <code>80</code> </p> </li> </ul>",
"refs": {
"CreateNotificationRequest$Notification": "<p>The notification that you want to create.</p>",
"CreateSubscriberRequest$Notification": "<p>The notification that you want to create a subscriber for.</p>",
"DeleteNotificationRequest$Notification": "<p>The notification that you want to delete.</p>",
"DeleteSubscriberRequest$Notification": "<p>The notification whose subscriber you want to delete.</p>",
"DescribeSubscribersForNotificationRequest$Notification": "<p>The notification whose subscribers you want to list.</p>",
"NotificationWithSubscribers$Notification": "<p>The notification that's associated with a budget.</p>",
"Notifications$member": null,
"UpdateNotificationRequest$OldNotification": "<p>The previous notification that is associated with a budget.</p>",
"UpdateNotificationRequest$NewNotification": "<p>The updated notification to be associated with a budget.</p>",
"UpdateSubscriberRequest$Notification": "<p>The notification whose subscriber you want to update.</p>"
}
},
"NotificationState": {
"base": null,
"refs": {
"Notification$NotificationState": "<p>Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you passed the set threshold for the budget.</p>"
}
},
"NotificationThreshold": {
"base": "<p> The threshold of a notification.</p>",
"refs": {
"ActionThreshold$ActionThresholdValue": null,
"Notification$Threshold": "<p>The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.</p>"
}
},
"NotificationType": {
"base": "<p> The type of a notification. It must be ACTUAL or FORECASTED.</p>",
"refs": {
"Action$NotificationType": null,
"CreateBudgetActionRequest$NotificationType": null,
"Notification$NotificationType": "<p>Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that you're forecasted to spend (<code>FORECASTED</code>).</p>",
"UpdateBudgetActionRequest$NotificationType": null
}
},
"NotificationWithSubscribers": {
"base": "<p>A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p>",
"refs": {
"NotificationWithSubscribersList$member": null
}
},
"NotificationWithSubscribersList": {
"base": "<p> A list of notifications, each with a list of subscribers.</p>",
"refs": {
"CreateBudgetRequest$NotificationsWithSubscribers": "<p>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 <code>CreateBudget</code> call, Amazon Web Services creates the notifications and subscribers for you.</p>"
}
},
"Notifications": {
"base": "<p> A list of notifications.</p>",
"refs": {
"BudgetNotificationsForAccount$Notifications": null,
"DescribeNotificationsForBudgetResponse$Notifications": "<p>A list of notifications that are associated with a budget.</p>"
}
},
"NullableBoolean": {
"base": null,
"refs": {
"CostTypes$IncludeTax": "<p>Specifies whether a budget includes taxes.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeSubscription": "<p>Specifies whether a budget includes subscriptions.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$UseBlended": "<p>Specifies whether a budget uses a blended rate.</p> <p>The default value is <code>false</code>.</p>",
"CostTypes$IncludeRefund": "<p>Specifies whether a budget includes refunds.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeCredit": "<p>Specifies whether a budget includes credits.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeUpfront": "<p>Specifies whether a budget includes upfront RI costs.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeRecurring": "<p>Specifies whether a budget includes recurring fees such as monthly RI fees.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeOtherSubscription": "<p>Specifies whether a budget includes non-RI subscription costs.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeSupport": "<p>Specifies whether a budget includes support subscription fees.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeDiscount": "<p>Specifies whether a budget includes discounts.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$UseAmortized": "<p>Specifies whether a budget uses the amortized rate.</p> <p>The default value is <code>false</code>.</p>"
}
},
"NumericValue": {
"base": "<p> A string that represents a numeric value.</p>",
"refs": {
"Spend$Amount": "<p>The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.</p>"
}
},
"PlannedBudgetLimits": {
"base": null,
"refs": {
"Budget$PlannedBudgetLimits": "<p>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</p> <p> <code>PlannedBudgetLimits</code> is available for cost or usage budget and supports both monthly and quarterly <code>TimeUnit</code>. </p> <p>For monthly budgets, provide 12 months of <code>PlannedBudgetLimits</code> values. This must start from the current month and include the next 11 months. The <code>key</code> is the start of the month, <code>UTC</code> in epoch seconds. </p> <p>For quarterly budgets, provide four quarters of <code>PlannedBudgetLimits</code> value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The <code>key</code> is the start of the quarter, <code>UTC</code> in epoch seconds. </p> <p>If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the <code>PlannedBudgetLimits</code> values only for the remaining periods.</p> <p>If the budget begins at a date in the future, provide <code>PlannedBudgetLimits</code> values from the start date of the budget. </p> <p>After all of the <code>BudgetLimit</code> values in <code>PlannedBudgetLimits</code> are used, the budget continues to use the last limit as the <code>BudgetLimit</code>. At that point, the planned budget provides the same experience as a fixed budget. </p> <p> <code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with <code>PlannedBudgetLimits</code> also contain <code>BudgetLimit</code> representing the current month or quarter limit present in <code>PlannedBudgetLimits</code>. This only applies to budgets that are created with <code>PlannedBudgetLimits</code>. Budgets that are created without <code>PlannedBudgetLimits</code> only contain <code>BudgetLimit</code>. They don't contain <code>PlannedBudgetLimits</code>.</p>"
}
},
"PolicyArn": {
"base": null,
"refs": {
"IamActionDefinition$PolicyArn": "<p>The Amazon Resource Name (ARN) of the policy to be attached. </p>"
}
},
"PolicyId": {
"base": null,
"refs": {
"ScpActionDefinition$PolicyId": "<p>The policy ID attached. </p>"
}
},
"Region": {
"base": null,
"refs": {
"SsmActionDefinition$Region": "<p>The Region to run the SSM document. </p>"
}
},
"ResourceLockedException": {
"base": "<p>The request was received and recognized by the server, but the server rejected that particular method for the requested resource.</p>",
"refs": {
}
},
"ResourceTag": {
"base": "<p>The tag structure that contains a tag key and value.</p>",
"refs": {
"ResourceTagList$member": null
}
},
"ResourceTagKey": {
"base": null,
"refs": {
"ResourceTag$Key": "<p>The key that's associated with the tag.</p>",
"ResourceTagKeyList$member": null
}
},
"ResourceTagKeyList": {
"base": null,
"refs": {
"UntagResourceRequest$ResourceTagKeys": "<p>The key that's associated with the tag.</p>"
}
},
"ResourceTagList": {
"base": null,
"refs": {
"CreateBudgetActionRequest$ResourceTags": "<p>An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource.</p>",
"CreateBudgetRequest$ResourceTags": "<p>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.</p>",
"ListTagsForResourceResponse$ResourceTags": "<p>The tags associated with the resource.</p>",
"TagResourceRequest$ResourceTags": "<p>The tags associated with the resource.</p>"
}
},
"ResourceTagValue": {
"base": null,
"refs": {
"ResourceTag$Value": "<p>The value that's associated with the tag.</p>"
}
},
"Role": {
"base": null,
"refs": {
"Roles$member": null
}
},
"RoleArn": {
"base": null,
"refs": {
"Action$ExecutionRoleArn": "<p>The role passed for action execution and reversion. Roles and actions must be in the same account. </p>",
"CreateBudgetActionRequest$ExecutionRoleArn": "<p> The role passed for action execution and reversion. Roles and actions must be in the same account. </p>",
"UpdateBudgetActionRequest$ExecutionRoleArn": "<p> The role passed for action execution and reversion. Roles and actions must be in the same account. </p>"
}
},
"Roles": {
"base": null,
"refs": {
"IamActionDefinition$Roles": "<p>A list of roles to be attached. There must be at least one role. </p>"
}
},
"ScpActionDefinition": {
"base": "<p>The service control policies (SCP) action definition details. </p>",
"refs": {
"Definition$ScpActionDefinition": "<p>The service control policies (SCPs) action definition details. </p>"
}
},
"ServiceQuotaExceededException": {
"base": "<p>You've reached the limit on the number of tags you can associate with a resource.</p>",
"refs": {
}
},
"Spend": {
"base": "<p>The amount of cost or usage that's measured for a budget.</p> <p> <i>Cost example:</i> A <code>Spend</code> for <code>3 USD</code> of costs has the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>Unit</code> of <code>USD</code> </p> </li> </ul> <p> <i>Usage example:</i> A <code>Spend</code> for <code>3 GB</code> of S3 usage has the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>Unit</code> of <code>GB</code> </p> </li> </ul>",
"refs": {
"Budget$BudgetLimit": "<p>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.</p> <p> <code>BudgetLimit</code> 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 <code>100</code>. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use <code>BudgetLimit</code> with <code>PlannedBudgetLimits</code> for <code>CreateBudget</code> and <code>UpdateBudget</code> actions. </p>",
"BudgetedAndActualAmounts$BudgetedAmount": "<p>The amount of cost or usage that you created the budget for.</p>",
"BudgetedAndActualAmounts$ActualAmount": "<p>Your actual costs or usage for a budget period.</p>",
"CalculatedSpend$ActualSpend": "<p>The amount of cost, usage, RI units, or Savings Plans units that you used.</p>",
"CalculatedSpend$ForecastedSpend": "<p>The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.</p>",
"PlannedBudgetLimits$value": null
}
},
"SsmActionDefinition": {
"base": "<p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>",
"refs": {
"Definition$SsmActionDefinition": "<p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>"
}
},
"Subscriber": {
"base": "<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.</p> <p>For example, an email subscriber has the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>[email protected]</code> </p> </li> </ul>",
"refs": {
"CreateSubscriberRequest$Subscriber": "<p>The subscriber that you want to associate with a budget notification.</p>",
"DeleteSubscriberRequest$Subscriber": "<p>The subscriber that you want to delete.</p>",
"Subscribers$member": null,
"UpdateSubscriberRequest$OldSubscriber": "<p>The previous subscriber that is associated with a budget notification.</p>",
"UpdateSubscriberRequest$NewSubscriber": "<p>The updated subscriber that is associated with a budget notification.</p>"
}
},
"SubscriberAddress": {
"base": "<p> A string that contains an email address or SNS topic for the subscriber's address.</p>",
"refs": {
"Subscriber$Address": "<p>The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.</p> <p>When you create a subscriber, the value of <code>Address</code> can't contain line breaks.</p>"
}
},
"Subscribers": {
"base": "<p> A list of subscribers.</p>",
"refs": {
"Action$Subscribers": null,
"CreateBudgetActionRequest$Subscribers": null,
"CreateNotificationRequest$Subscribers": "<p>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.</p>",
"DescribeSubscribersForNotificationResponse$Subscribers": "<p>A list of subscribers that are associated with a notification.</p>",
"NotificationWithSubscribers$Subscribers": "<p>A list of subscribers who are subscribed to this notification.</p>",
"UpdateBudgetActionRequest$Subscribers": null
}
},
"SubscriptionType": {
"base": "<p> The subscription type of the subscriber. It can be SMS or EMAIL.</p>",
"refs": {
"Subscriber$SubscriptionType": "<p>The type of notification that Amazon Web Services sends to a subscriber.</p>"
}
},
"TagResourceRequest": {
"base": null,
"refs": {
}
},
"TagResourceResponse": {
"base": null,
"refs": {
}
},
"TargetId": {
"base": null,
"refs": {
"TargetIds$member": null
}
},
"TargetIds": {
"base": null,
"refs": {
"ScpActionDefinition$TargetIds": "<p>A list of target IDs. </p>"
}
},
"ThresholdType": {
"base": "<p> The type of threshold for a notification.</p>",
"refs": {
"ActionThreshold$ActionThresholdType": null,
"Notification$ThresholdType": "<p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> thresholds, Amazon Web Services 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 <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.</p>"
}
},
"ThrottlingException": {
"base": "<p>The number of API requests has exceeded the maximum allowed API request throttling limit for the account.</p>",
"refs": {
}
},
"TimePeriod": {
"base": "<p>The period of time that's 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. </p>",
"refs": {
"Budget$TimePeriod": "<p>The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before <code>06/15/87 00:00 UTC</code>. </p> <p>If you create your budget and don't specify a start date, Amazon Web Services 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 <code>DAILY</code>, and didn't set a start date, Amazon Web Services set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, Amazon Web Services set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, Amazon Web Services set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.</p>",
"BudgetedAndActualAmounts$TimePeriod": "<p>The time period that's covered by this budget comparison.</p>",
"DescribeBudgetActionHistoriesRequest$TimePeriod": null,
"DescribeBudgetPerformanceHistoryRequest$TimePeriod": "<p>Retrieves how often the budget went into an <code>ALARM</code> state for the specified time period.</p>"
}
},
"TimeUnit": {
"base": "<p> The time unit of the budget, such as MONTHLY or QUARTERLY.</p>",
"refs": {
"Budget$TimeUnit": "<p>The length of time until a budget resets the actual and forecasted spend.</p>",
"BudgetPerformanceHistory$TimeUnit": null
}
},
"UnitValue": {
"base": "<p> A string that represents the spend unit of a budget. It can't be null or empty.</p>",
"refs": {
"Spend$Unit": "<p>The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.</p>"
}
},
"UntagResourceRequest": {
"base": null,
"refs": {
}
},
"UntagResourceResponse": {
"base": null,
"refs": {
}
},
"UpdateBudgetActionRequest": {
"base": null,
"refs": {
}
},
"UpdateBudgetActionResponse": {
"base": null,
"refs": {
}
},
"UpdateBudgetRequest": {
"base": "<p> Request of UpdateBudget </p>",
"refs": {
}
},
"UpdateBudgetResponse": {
"base": "<p> Response of UpdateBudget </p>",
"refs": {
}
},
"UpdateNotificationRequest": {
"base": "<p> Request of UpdateNotification </p>",
"refs": {
}
},
"UpdateNotificationResponse": {
"base": "<p> Response of UpdateNotification </p>",
"refs": {
}
},
"UpdateSubscriberRequest": {
"base": "<p> Request of UpdateSubscriber </p>",
"refs": {
}
},
"UpdateSubscriberResponse": {
"base": "<p> Response of UpdateSubscriber </p>",
"refs": {
}
},
"User": {
"base": null,
"refs": {
"Users$member": null
}
},
"Users": {
"base": null,
"refs": {
"IamActionDefinition$Users": "<p>A list of users to be attached. There must be at least one user. </p>"
}
},
"errorMessage": {
"base": "<p>The error message the exception carries.</p>",
"refs": {
"AccessDeniedException$Message": null,
"CreationLimitExceededException$Message": null,
"DuplicateRecordException$Message": null,
"ExpiredNextTokenException$Message": null,
"InternalErrorException$Message": null,
"InvalidNextTokenException$Message": null,
"InvalidParameterException$Message": null,
"NotFoundException$Message": null,
"ResourceLockedException$Message": null,
"ServiceQuotaExceededException$Message": null,
"ThrottlingException$Message": null
}
}
}
}