AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class Budget

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

This is the ARN pattern for a budget:

arn:aws:budgetservice::AccountId:budget/budgetName

Class BudgetedAndActualAmounts

The amount of cost or usage that you created the budget for, compared to your actual costs or usage.

Class BudgetPerformanceHistory

A history of the state of a budget at the end of the budget's specified time period.

Class CalculatedSpend

The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, or RI units, and the forecastedSpend tracks how much you are predicted to spend if your current usage remains steady.

For example, if it is the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.

Class CostTypes

The types of cost that are included in a COST budget, such as tax and subscriptions.

USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes.

Class CreateBudgetRequest

Container for the parameters to the CreateBudget operation. Creates a budget and, if included, notifications and subscribers.

Class CreateBudgetResponse

Response of CreateBudget

Class CreateNotificationRequest

Container for the parameters to the CreateNotification operation. Creates a notification. You must create the budget before you create the associated notification.

Class CreateNotificationResponse

Response of CreateNotification

Class CreateSubscriberRequest

Container for the parameters to the CreateSubscriber operation. Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

Class CreateSubscriberResponse

Response of CreateSubscriber

Class CreationLimitExceededException

Budgets exception

Class DeleteBudgetRequest

Container for the parameters to the DeleteBudget operation. Deletes a budget. You can delete your budget at any time.

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

Class DeleteBudgetResponse

Response of DeleteBudget

Class DeleteNotificationRequest

Container for the parameters to the DeleteNotification operation. Deletes a notification.

Deleting a notification also deletes the subscribers that are associated with the notification.

Class DeleteNotificationResponse

Response of DeleteNotification

Class DeleteSubscriberRequest

Container for the parameters to the DeleteSubscriber operation. Deletes a subscriber.

Deleting the last subscriber to a notification also deletes the notification.

Class DeleteSubscriberResponse

Response of DeleteSubscriber

Class DescribeBudgetPerformanceHistoryRequest

Container for the parameters to the DescribeBudgetPerformanceHistory operation. Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

Class DescribeBudgetPerformanceHistoryResponse

This is the response object from the DescribeBudgetPerformanceHistory operation.

Class DescribeBudgetRequest

Container for the parameters to the DescribeBudget operation. Describes a budget.

Class DescribeBudgetResponse

Response of DescribeBudget

Class DescribeBudgetsRequest

Container for the parameters to the DescribeBudgets operation. Lists the budgets that are associated with an account.

Class DescribeBudgetsResponse

Response of DescribeBudgets

Class DescribeNotificationsForBudgetRequest

Container for the parameters to the DescribeNotificationsForBudget operation. Lists the notifications that are associated with a budget.

Class DescribeNotificationsForBudgetResponse

Response of GetNotificationsForBudget

Class DescribeSubscribersForNotificationRequest

Container for the parameters to the DescribeSubscribersForNotification operation. Lists the subscribers that are associated with a notification.

Class DescribeSubscribersForNotificationResponse

Response of DescribeSubscribersForNotification

Class DuplicateRecordException

Budgets exception

Class ExpiredNextTokenException

Budgets exception

Class InternalErrorException

Budgets exception

Class InvalidNextTokenException

Budgets exception

Class InvalidParameterException

Budgets exception

Class NotFoundException

Budgets exception

Class Notification

A notification that is associated with a budget. A budget can have up to five notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

  • A notificationType of ACTUAL

  • A thresholdType of PERCENTAGE

  • A comparisonOperator of GREATER_THAN

  • A notification threshold of 80

Class NotificationWithSubscribers

A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

Class Spend

The amount of cost or usage that is measured for a budget.

For example, a Spend for 3 GB of S3 usage would have the following parameters:

  • An Amount of 3

  • A unit of GB

Class Subscriber

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber would have the following parameters:

  • A subscriptionType of EMAIL

  • An address of example@example.com

Class TimePeriod

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.

Class UpdateBudgetRequest

Container for the parameters to the UpdateBudget operation. Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.

Class UpdateBudgetResponse

Response of UpdateBudget

Class UpdateNotificationRequest

Container for the parameters to the UpdateNotification operation. Updates a notification.

Class UpdateNotificationResponse

Response of UpdateNotification

Class UpdateSubscriberRequest

Container for the parameters to the UpdateSubscriber operation. Updates a subscriber.

Class UpdateSubscriberResponse

Response of UpdateSubscriber