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 AccessDeniedException

You are not authorized to use this operation with the given parameters.

Class Action

A budget action resource.

Class ActionHistory

The historical records for a budget action.

Class ActionHistoryDetails

The description of the details for the event.

Class ActionThreshold

The trigger threshold of the action.

Class AutoAdjustData

The parameters that determine the budget amount for an auto-adjusting budget.

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 Amazon Resource Name (ARN) pattern for a budget:

arn:aws:budgets::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 BudgetNotificationsForAccount

The budget name and associated notifications for an account.

Class BudgetPerformanceHistory

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

Class BudgetsPaginatorFactory

Paginators for the Budgets service

Class CalculatedSpend

The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much that you're predicted to spend based on your historical usage profile.

For example, if it's 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, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets don't have CostTypes.

Class CreateBudgetActionRequest

Container for the parameters to the CreateBudgetAction operation. Creates a budget action.

Class CreateBudgetActionResponse

This is the response object from the CreateBudgetAction operation.

Class CreateBudgetRequest

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

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

You've exceeded the notification or subscriber limit.

Class Definition

Specifies all of the type-specific parameters.

Class DeleteBudgetActionRequest

Container for the parameters to the DeleteBudgetAction operation. Deletes a budget action.

Class DeleteBudgetActionResponse

This is the response object from the DeleteBudgetAction operation.

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 DescribeBudgetActionHistoriesRequest

Container for the parameters to the DescribeBudgetActionHistories operation. Describes a budget action history detail.

Class DescribeBudgetActionHistoriesResponse

This is the response object from the DescribeBudgetActionHistories operation.

Class DescribeBudgetActionRequest

Container for the parameters to the DescribeBudgetAction operation. Describes a budget action detail.

Class DescribeBudgetActionResponse

This is the response object from the DescribeBudgetAction operation.

Class DescribeBudgetActionsForAccountRequest

Container for the parameters to the DescribeBudgetActionsForAccount operation. Describes all of the budget actions for an account.

Class DescribeBudgetActionsForAccountResponse

This is the response object from the DescribeBudgetActionsForAccount operation.

Class DescribeBudgetActionsForBudgetRequest

Container for the parameters to the DescribeBudgetActionsForBudget operation. Describes all of the budget actions for a budget.

Class DescribeBudgetActionsForBudgetResponse

This is the response object from the DescribeBudgetActionsForBudget operation.

Class DescribeBudgetNotificationsForAccountRequest

Container for the parameters to the DescribeBudgetNotificationsForAccount operation. Lists the budget names and notifications that are associated with an account.

Class DescribeBudgetNotificationsForAccountResponse

This is the response object from the DescribeBudgetNotificationsForAccount operation.

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.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

Class DescribeBudgetResponse

Response of DescribeBudget

Class DescribeBudgetsRequest

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

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

The budget name already exists. Budget names must be unique within an account.

Class ExecuteBudgetActionRequest

Container for the parameters to the ExecuteBudgetAction operation. Executes a budget action.

Class ExecuteBudgetActionResponse

This is the response object from the ExecuteBudgetAction operation.

Class ExpiredNextTokenException

The pagination token expired.

Class HistoricalOptions

The parameters that define or describe the historical data that your auto-adjusting budget is based on.

Class IamActionDefinition

The Identity and Access Management (IAM) action definition details.

Class InternalErrorException

An error on the server occurred during the processing of your request. Try again later.

Class InvalidNextTokenException

The pagination token is invalid.

Class InvalidParameterException

An error on the client occurred. Typically, the cause is an invalid input value.

Class NotFoundException

We can’t locate the resource that you specified.

Class Notification

A notification that's associated with a budget. A budget can have up to ten 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 ResourceLockedException

The request was received and recognized by the server, but the server rejected that particular method for the requested resource.

Class ScpActionDefinition

The service control policies (SCP) action definition details.

Class Spend

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

Cost example: A Spend for 3 USD of costs has the following parameters:

  • An Amount of 3

  • A Unit of USD

Usage example: A Spend for 3 GB of S3 usage has the following parameters:

  • An Amount of 3

  • A Unit of GB

Class SsmActionDefinition

The Amazon Web Services Systems Manager (SSM) action definition details.

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 has the following parameters:

  • A subscriptionType of EMAIL

  • An address of example@example.com

Class ThrottlingException

The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

Class TimePeriod

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.

Class UpdateBudgetActionRequest

Container for the parameters to the UpdateBudgetAction operation. Updates a budget action.

Class UpdateBudgetActionResponse

This is the response object from the UpdateBudgetAction operation.

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 Amazon Web Services has new usage data to use for forecasting.

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

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

Interfaces

NameDescription
Interface IBudgetsPaginatorFactory

Paginators for the Budgets service

Interface IDescribeBudgetActionHistoriesPaginator

Paginator for the DescribeBudgetActionHistories operation

Interface IDescribeBudgetActionsForAccountPaginator

Paginator for the DescribeBudgetActionsForAccount operation

Interface IDescribeBudgetActionsForBudgetPaginator

Paginator for the DescribeBudgetActionsForBudget operation

Interface IDescribeBudgetNotificationsForAccountPaginator

Paginator for the DescribeBudgetNotificationsForAccount operation

Interface IDescribeBudgetPerformanceHistoryPaginator

Paginator for the DescribeBudgetPerformanceHistory operation

Interface IDescribeBudgetsPaginator

Paginator for the DescribeBudgets operation

Interface IDescribeNotificationsForBudgetPaginator

Paginator for the DescribeNotificationsForBudget operation

Interface IDescribeSubscribersForNotificationPaginator

Paginator for the DescribeSubscribersForNotification operation