View on GitHub
Budgets Structure Reference
Budgets
public struct BudgetsClient object for interacting with AWS Budgets service.
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. Budgets provide you with a way to see the following information: How close your plan is to your budgeted amount or to the free tier limits Your usage-to-date, including how much you’ve used of your Reserved Instances (RIs) Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month How much of your budget has been used 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: Cost budgets - Plan how much you want to spend on a service. Usage budgets - Plan how much you want to use one or more services. RI utilization budgets - 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. RI coverage budgets - 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. Service Endpoint The AWS Budgets API provides the following endpoint: https://budgets.amazonaws.com For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the Budgets client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
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.
Declaration
Swift
public func createBudget(_ input: CreateBudgetRequest) -> EventLoopFuture<CreateBudgetResponse> -
Creates a notification. You must create the budget before you create the associated notification.
Declaration
Swift
public func createNotification(_ input: CreateNotificationRequest) -> EventLoopFuture<CreateNotificationResponse> -
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
Declaration
Swift
public func createSubscriber(_ input: CreateSubscriberRequest) -> EventLoopFuture<CreateSubscriberResponse> -
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.
Declaration
Swift
public func deleteBudget(_ input: DeleteBudgetRequest) -> EventLoopFuture<DeleteBudgetResponse> -
Deletes a notification. Deleting a notification also deletes the subscribers that are associated with the notification.
Declaration
Swift
public func deleteNotification(_ input: DeleteNotificationRequest) -> EventLoopFuture<DeleteNotificationResponse> -
Deletes a subscriber. Deleting the last subscriber to a notification also deletes the notification.
Declaration
Swift
public func deleteSubscriber(_ input: DeleteSubscriberRequest) -> EventLoopFuture<DeleteSubscriberResponse> -
Describes a budget. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Declaration
Swift
public func describeBudget(_ input: DescribeBudgetRequest) -> EventLoopFuture<DescribeBudgetResponse> -
Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn’t available for ANNUAL budgets.
Declaration
Swift
public func describeBudgetPerformanceHistory(_ input: DescribeBudgetPerformanceHistoryRequest) -> EventLoopFuture<DescribeBudgetPerformanceHistoryResponse> -
Lists the budgets that are associated with an account. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Declaration
Swift
public func describeBudgets(_ input: DescribeBudgetsRequest) -> EventLoopFuture<DescribeBudgetsResponse> -
Lists the notifications that are associated with a budget.
Declaration
Swift
public func describeNotificationsForBudget(_ input: DescribeNotificationsForBudgetRequest) -> EventLoopFuture<DescribeNotificationsForBudgetResponse> -
Lists the subscribers that are associated with a notification.
Declaration
Swift
public func describeSubscribersForNotification(_ input: DescribeSubscribersForNotificationRequest) -> EventLoopFuture<DescribeSubscribersForNotificationResponse> -
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. 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.
Declaration
Swift
public func updateBudget(_ input: UpdateBudgetRequest) -> EventLoopFuture<UpdateBudgetResponse> -
Updates a notification.
Declaration
Swift
public func updateNotification(_ input: UpdateNotificationRequest) -> EventLoopFuture<UpdateNotificationResponse> -
Updates a subscriber.
Declaration
Swift
public func updateSubscriber(_ input: UpdateSubscriberRequest) -> EventLoopFuture<UpdateSubscriberResponse>
-
Undocumented
See moreDeclaration
Swift
public enum BudgetType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ComparisonOperator : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum NotificationState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum NotificationType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SubscriptionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ThresholdType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum TimeUnit : String, CustomStringConvertible, Codable