Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
executable file 491 lines (490 sloc) 32.5 KB
{
"version": "2.0",
"service": "<p>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. </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 AWS, 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>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:</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 AWS 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 AWS Budgets API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>",
"operations": {
"CreateBudget": "<p>Creates a budget and, if included, notifications and subscribers. </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>",
"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>",
"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>",
"DescribeNotificationsForBudget": "<p>Lists the notifications that are associated with a budget.</p>",
"DescribeSubscribersForNotification": "<p>Lists the subscribers that are associated with a notification.</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 AWS has new usage data to use for forecasting.</p>",
"UpdateNotification": "<p>Updates a notification.</p>",
"UpdateSubscriber": "<p>Updates a subscriber.</p>"
},
"shapes": {
"AccountId": {
"base": "<p>The account ID of the user. It should be a 12-digit number.</p>",
"refs": {
"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>",
"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>",
"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 descriptions of.</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>",
"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>"
}
},
"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 ARN pattern for a budget: </p> <p> <code>arn:aws:budgetservice::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 aren't allowed.</p>",
"refs": {
"Budget$BudgetName": "<p>The name of a budget. The name must be unique within accounts. The <code>:</code> and <code>\\</code> characters aren't allowed in <code>BudgetName</code>.</p>",
"BudgetPerformanceHistory$BudgetName": null,
"CreateNotificationRequest$BudgetName": "<p>The name of the budget that you want AWS 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>",
"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>",
"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>",
"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>"
}
},
"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>, or <code>RI_COVERAGE</code>.</p>",
"refs": {
"Budget$BudgetType": "<p>Whether this budget tracks monetary costs, usage, RI utilization, or RI 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, 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, 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>",
"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 is 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 service or region, that are applied to a budget.</p> <p>AWS Budgets supports the following services as a filter for RI budgets:</p> <ul> <li> <p>Amazon Elastic Compute Cloud - Compute</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 Elasticsearch 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>, and <code>RI_COVERAGE</code> budgets do not 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>, and <code>RI_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>"
}
},
"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": {
}
},
"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": {
}
},
"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": {
}
},
"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": {
}
},
"ExpiredNextTokenException": {
"base": "<p>The pagination token expired.</p>",
"refs": {
}
},
"GenericString": {
"base": "<p> A generic string.</p>",
"refs": {
"CostFilters$key": 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>",
"DimensionValues$member": null
}
},
"GenericTimestamp": {
"base": "<p> A generic time stamp. In Java, it is transformed to a <code>Date</code> object.</p>",
"refs": {
"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, 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 <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS 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, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</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": {
}
},
"MaxResults": {
"base": "<p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
"refs": {
"DescribeBudgetPerformanceHistoryRequest$MaxResults": null,
"DescribeBudgetsRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
"DescribeNotificationsForBudgetRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
"DescribeSubscribersForNotificationRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>"
}
},
"NotFoundException": {
"base": "<p>We can’t locate the resource that you specified.</p>",
"refs": {
}
},
"Notification": {
"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>",
"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 is 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>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>"
}
},
"NotificationThreshold": {
"base": "<p> The threshold of a notification. It must be a number between 0 and 1,000,000,000.</p>",
"refs": {
"Notification$Threshold": "<p>The threshold that is associated with a notification. Thresholds are always a percentage.</p>"
}
},
"NotificationType": {
"base": "<p> The type of a notification. It must be ACTUAL or FORECASTED.</p>",
"refs": {
"Notification$NotificationType": "<p>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</p>"
}
},
"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, AWS creates the notifications and subscribers for you.</p>"
}
},
"Notifications": {
"base": "<p> A list of notifications.</p>",
"refs": {
"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 is associated with a budget forecast, actual spend, or budget threshold.</p>"
}
},
"Spend": {
"base": "<p>The amount of cost or usage that is measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage would have 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, or RI 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 utilization or coverage budgets. RI utilization or coverage budgets default to <code>100</code>, which is the only valid value for RI utilization or coverage budgets.</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, or RI units that you have used.</p>",
"CalculatedSpend$ForecastedSpend": "<p>The amount of cost, usage, or RI units that you are forecasted to use.</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 would have 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>example@example.com</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 AWS sends budget notifications to, either an SNS topic or an email.</p>"
}
},
"Subscribers": {
"base": "<p> A list of subscribers.</p>",
"refs": {
"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>"
}
},
"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 AWS sends to a subscriber.</p>"
}
},
"ThresholdType": {
"base": "<p> The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.</p>",
"refs": {
"Notification$ThresholdType": "<p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</p>"
}
},
"TimePeriod": {
"base": "<p>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. </p>",
"refs": {
"Budget$TimePeriod": "<p>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 <code>06/15/87 00:00 UTC</code>. </p> <p>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 <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS 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, AWS deletes the budget and all associated notifications and subscribers.</p>",
"BudgetedAndActualAmounts$TimePeriod": "<p>The time period covered by this budget comparison.</p>",
"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. <code>DAILY</code> is available only for <code>RI_UTILIZATION</code> and <code>RI_COVERAGE</code> budgets.</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 is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
}
},
"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": {
}
},
"errorMessage": {
"base": "<p>The error message the exception carries.</p>",
"refs": {
"CreationLimitExceededException$Message": null,
"DuplicateRecordException$Message": null,
"ExpiredNextTokenException$Message": null,
"InternalErrorException$Message": null,
"InvalidNextTokenException$Message": null,
"InvalidParameterException$Message": null,
"NotFoundException$Message": null
}
}
}
}
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.