|
43 | 43 | } |
44 | 44 | }, |
45 | 45 | "Budget": { |
46 | | - "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 ARN pattern for a budget: </p> <p> <code>arn:aws:budgetservice::AccountId:budget/budgetName</code> </p>", |
| 46 | + "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 ARN pattern for a budget: </p> <p> <code>arn:aws:budgets::AccountId:budget/budgetName</code> </p>", |
47 | 47 | "refs": { |
48 | 48 | "Budgets$member": null, |
49 | 49 | "CreateBudgetRequest$Budget": "<p>The budget object that you want to create.</p>", |
|
76 | 76 | } |
77 | 77 | }, |
78 | 78 | "BudgetType": { |
79 | | - "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>, or <code>RI_COVERAGE</code>.</p>", |
| 79 | + "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>", |
80 | 80 | "refs": { |
81 | 81 | "Budget$BudgetType": "<p>Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.</p>", |
82 | 82 | "BudgetPerformanceHistory$BudgetType": null |
|
101 | 101 | } |
102 | 102 | }, |
103 | 103 | "CalculatedSpend": { |
104 | | - "base": "<p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, or RI units, and the <code>forecastedSpend</code> tracks how much you are predicted to spend if your current usage remains steady.</p> <p>For example, if it is 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>", |
| 104 | + "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 you are predicted to spend based on your historical usage profile.</p> <p>For example, if it is 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>", |
105 | 105 | "refs": { |
106 | 106 | "Budget$CalculatedSpend": "<p>The actual and forecasted cost or usage that the budget tracks.</p>" |
107 | 107 | } |
|
120 | 120 | } |
121 | 121 | }, |
122 | 122 | "CostTypes": { |
123 | | - "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>, and <code>RI_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>", |
| 123 | + "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 do not have <code>CostTypes</code>.</p>", |
124 | 124 | "refs": { |
125 | | - "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>", |
| 125 | + "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>", |
126 | 126 | "BudgetPerformanceHistory$CostTypes": "<p>The history of the cost types for a budget during the specified time period.</p>" |
127 | 127 | } |
128 | 128 | }, |
|
311 | 311 | } |
312 | 312 | }, |
313 | 313 | "Notification": { |
314 | | - "base": "<p>A notification that is associated with a budget. A budget can have up to five 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>", |
| 314 | + "base": "<p>A notification that is 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>", |
315 | 315 | "refs": { |
316 | 316 | "CreateNotificationRequest$Notification": "<p>The notification that you want to create.</p>", |
317 | 317 | "CreateSubscriberRequest$Notification": "<p>The notification that you want to create a subscriber for.</p>", |
|
334 | 334 | "NotificationThreshold": { |
335 | 335 | "base": "<p> The threshold of a notification. It must be a number between 0 and 1,000,000,000.</p>", |
336 | 336 | "refs": { |
337 | | - "Notification$Threshold": "<p>The threshold that is associated with a notification. Thresholds are always a percentage.</p>" |
| 337 | + "Notification$Threshold": "<p>The threshold that is 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>" |
338 | 338 | } |
339 | 339 | }, |
340 | 340 | "NotificationType": { |
|
395 | 395 | "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>, which 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>", |
396 | 396 | "BudgetedAndActualAmounts$BudgetedAmount": "<p>The amount of cost or usage that you created the budget for.</p>", |
397 | 397 | "BudgetedAndActualAmounts$ActualAmount": "<p>Your actual costs or usage for a budget period.</p>", |
398 | | - "CalculatedSpend$ActualSpend": "<p>The amount of cost, usage, or RI units that you have used.</p>", |
399 | | - "CalculatedSpend$ForecastedSpend": "<p>The amount of cost, usage, or RI units that you are forecasted to use.</p>", |
| 398 | + "CalculatedSpend$ActualSpend": "<p>The amount of cost, usage, RI units, or Savings Plans units that you have used.</p>", |
| 399 | + "CalculatedSpend$ForecastedSpend": "<p>The amount of cost, usage, RI units, or Savings Plans units that you are forecasted to use.</p>", |
400 | 400 | "PlannedBudgetLimits$value": null |
401 | 401 | } |
402 | 402 | }, |
|
447 | 447 | "TimeUnit": { |
448 | 448 | "base": "<p> The time unit of the budget, such as MONTHLY or QUARTERLY.</p>", |
449 | 449 | "refs": { |
450 | | - "Budget$TimeUnit": "<p>The length of time until a budget resets the actual and forecasted spend. <code>DAILY</code> is available only for <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>, <code>Savings_Plans_Utilization</code>, and <code>Savings_Plans_Coverage</code> budgets.</p>", |
| 450 | + "Budget$TimeUnit": "<p>The length of time until a budget resets the actual and forecasted spend.</p>", |
451 | 451 | "BudgetPerformanceHistory$TimeUnit": null |
452 | 452 | } |
453 | 453 | }, |
|
0 commit comments