AWS Budgets Update: Documentation updates for Daily Cost and Usage bu…

…dgets
aws · Sep 15, 2020 · 1862759 · 1862759
1 parent 076e92b
commit 1862759
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 13 deletions.
diff --git a/.changes/next-release/feature-AWSBudgets-a954f93.json b/.changes/next-release/feature-AWSBudgets-a954f93.json
@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "AWS Budgets",
+    "description": "Documentation updates for Daily Cost and Usage budgets"
+}
diff --git a/services/budgets/src/main/resources/codegen-resources/paginators-1.json b/services/budgets/src/main/resources/codegen-resources/paginators-1.json
@@ -1,4 +1,28 @@
 {
   "pagination": {
+    "DescribeBudgetPerformanceHistory": {
+      "input_token": "NextToken",
+      "limit_key": "MaxResults",
+      "output_token": "NextToken",
+      "result_key": "BudgetPerformanceHistory"
+    },
+    "DescribeBudgets": {
+      "input_token": "NextToken",
+      "limit_key": "MaxResults",
+      "output_token": "NextToken",
+      "result_key": "Budgets"
+    },
+    "DescribeNotificationsForBudget": {
+      "input_token": "NextToken",
+      "limit_key": "MaxResults",
+      "output_token": "NextToken",
+      "result_key": "Notifications"
+    },
+    "DescribeSubscribersForNotification": {
+      "input_token": "NextToken",
+      "limit_key": "MaxResults",
+      "output_token": "NextToken",
+      "result_key": "Subscribers"
+    }
   }
-}
+}
diff --git a/services/budgets/src/main/resources/codegen-resources/service-2.json b/services/budgets/src/main/resources/codegen-resources/service-2.json
@@ -295,11 +295,11 @@
         },
         "CostTypes":{
           "shape":"CostTypes",
-          "documentation":"<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>"
+          "documentation":"<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>"
         },
         "TimeUnit":{
           "shape":"TimeUnit",
-          "documentation":"<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>"
+          "documentation":"<p>The length of time until a budget resets the actual and forecasted spend.</p>"
         },
         "TimePeriod":{
           "shape":"TimePeriod",
@@ -318,7 +318,7 @@
           "documentation":"<p>The last time that you updated this budget.</p>"
         }
       },
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "BudgetName":{
       "type":"string",
@@ -350,7 +350,7 @@
     },
     "BudgetType":{
       "type":"string",
-      "documentation":"<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>",
+      "documentation":"<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>",
       "enum":[
         "USAGE",
         "COST",
@@ -393,14 +393,14 @@
       "members":{
         "ActualSpend":{
           "shape":"Spend",
-          "documentation":"<p>The amount of cost, usage, or RI units that you have used.</p>"
+          "documentation":"<p>The amount of cost, usage, RI units, or Savings Plans units that you have used.</p>"
         },
         "ForecastedSpend":{
           "shape":"Spend",
-          "documentation":"<p>The amount of cost, usage, or RI units that you are forecasted to use.</p>"
+          "documentation":"<p>The amount of cost, usage, RI units, or Savings Plans units that you are forecasted to use.</p>"
         }
       },
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "ComparisonOperator":{
       "type":"string",
@@ -465,7 +465,7 @@
           "documentation":"<p>Specifies whether a budget uses the amortized rate.</p> <p>The default value is <code>false</code>.</p>"
         }
       },
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "CreateBudgetRequest":{
       "type":"structure",
@@ -919,7 +919,7 @@
         },
         "Threshold":{
           "shape":"NotificationThreshold",
-          "documentation":"<p>The threshold that is associated with a notification. Thresholds are always a percentage.</p>"
+          "documentation":"<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>"
         },
         "ThresholdType":{
           "shape":"ThresholdType",
@@ -930,7 +930,7 @@
           "documentation":"<p>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</p>"
         }
       },
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "NotificationState":{
       "type":"string",
@@ -942,7 +942,7 @@
     "NotificationThreshold":{
       "type":"double",
       "documentation":"<p> The threshold of a notification. It must be a number between 0 and 1,000,000,000.</p>",
-      "max":1000000000,
+      "max":40000000000,
       "min":0
     },
     "NotificationType":{
@@ -975,7 +975,7 @@
       "type":"list",
       "member":{"shape":"NotificationWithSubscribers"},
       "documentation":"<p> A list of notifications, each with a list of subscribers.</p>",
-      "max":5
+      "max":10
     },
     "Notifications":{
       "type":"list",