Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateBudget
- CreateBudgetAction
- CreateNotification
- CreateSubscriber
- DeleteBudget
- DeleteBudgetAction
- DeleteNotification
- DeleteSubscriber
- DescribeBudget
- DescribeBudgetAction
- DescribeBudgetActionHistories (Paginated)
- DescribeBudgetActionsForAccount (Paginated)
- DescribeBudgetActionsForBudget (Paginated)
- DescribeBudgetNotificationsForAccount (Paginated)
- DescribeBudgetPerformanceHistory (Paginated)
- DescribeBudgets (Paginated)
- DescribeNotificationsForBudget (Paginated)
- DescribeSubscribersForNotification (Paginated)
- ExecuteBudgetAction
- UpdateBudget
- UpdateBudgetAction
- UpdateNotification
- UpdateSubscriber
- Types
- ActionStatus
- ActionSubType
- ActionType
- ApprovalModel
- AutoAdjustType
- BudgetType
- ComparisonOperator
- EventType
- ExecutionType
- NotificationState
- NotificationType
- SubscriptionType
- ThresholdType
- TimeUnit
- Action
- ActionHistory
- ActionHistoryDetails
- ActionThreshold
- AutoAdjustData
- Budget
- BudgetNotificationsForAccount
- BudgetPerformanceHistory
- BudgetedAndActualAmounts
- CalculatedSpend
- CostTypes
- Definition
- HistoricalOptions
- IamActionDefinition
- Notification
- NotificationWithSubscribers
- ScpActionDefinition
- Spend
- SsmActionDefinition
- Subscriber
- TimePeriod
Derived from API version 2016-10-20
of the AWS service descriptions, licensed under Apache 2.0.
Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.
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 Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
- How much of your budget has been used
Amazon Web Services 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 Amazon Web Services Budgets API provides the following endpoint:
- https://budgets.amazonaws.com
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _CreationLimitExceededException :: AsError a => Fold a ServiceError
- _DuplicateRecordException :: AsError a => Fold a ServiceError
- _ExpiredNextTokenException :: AsError a => Fold a ServiceError
- _InternalErrorException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ResourceLockedException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- data CreateBudget = CreateBudget' (Maybe [NotificationWithSubscribers]) Text Budget
- newCreateBudget :: Text -> Budget -> CreateBudget
- data CreateBudgetResponse = CreateBudgetResponse' Int
- newCreateBudgetResponse :: Int -> CreateBudgetResponse
- data CreateBudgetAction = CreateBudgetAction' Text Text NotificationType ActionType ActionThreshold Definition Text ApprovalModel (NonEmpty Subscriber)
- newCreateBudgetAction :: Text -> Text -> NotificationType -> ActionType -> ActionThreshold -> Definition -> Text -> ApprovalModel -> NonEmpty Subscriber -> CreateBudgetAction
- data CreateBudgetActionResponse = CreateBudgetActionResponse' Int Text Text Text
- newCreateBudgetActionResponse :: Int -> Text -> Text -> Text -> CreateBudgetActionResponse
- data CreateNotification = CreateNotification' Text Text Notification (NonEmpty Subscriber)
- newCreateNotification :: Text -> Text -> Notification -> NonEmpty Subscriber -> CreateNotification
- data CreateNotificationResponse = CreateNotificationResponse' Int
- newCreateNotificationResponse :: Int -> CreateNotificationResponse
- data CreateSubscriber = CreateSubscriber' Text Text Notification Subscriber
- newCreateSubscriber :: Text -> Text -> Notification -> Subscriber -> CreateSubscriber
- data CreateSubscriberResponse = CreateSubscriberResponse' Int
- newCreateSubscriberResponse :: Int -> CreateSubscriberResponse
- data DeleteBudget = DeleteBudget' Text Text
- newDeleteBudget :: Text -> Text -> DeleteBudget
- data DeleteBudgetResponse = DeleteBudgetResponse' Int
- newDeleteBudgetResponse :: Int -> DeleteBudgetResponse
- data DeleteBudgetAction = DeleteBudgetAction' Text Text Text
- newDeleteBudgetAction :: Text -> Text -> Text -> DeleteBudgetAction
- data DeleteBudgetActionResponse = DeleteBudgetActionResponse' Int Text Text Action
- newDeleteBudgetActionResponse :: Int -> Text -> Text -> Action -> DeleteBudgetActionResponse
- data DeleteNotification = DeleteNotification' Text Text Notification
- newDeleteNotification :: Text -> Text -> Notification -> DeleteNotification
- data DeleteNotificationResponse = DeleteNotificationResponse' Int
- newDeleteNotificationResponse :: Int -> DeleteNotificationResponse
- data DeleteSubscriber = DeleteSubscriber' Text Text Notification Subscriber
- newDeleteSubscriber :: Text -> Text -> Notification -> Subscriber -> DeleteSubscriber
- data DeleteSubscriberResponse = DeleteSubscriberResponse' Int
- newDeleteSubscriberResponse :: Int -> DeleteSubscriberResponse
- data DescribeBudget = DescribeBudget' Text Text
- newDescribeBudget :: Text -> Text -> DescribeBudget
- data DescribeBudgetResponse = DescribeBudgetResponse' (Maybe Budget) Int
- newDescribeBudgetResponse :: Int -> DescribeBudgetResponse
- data DescribeBudgetAction = DescribeBudgetAction' Text Text Text
- newDescribeBudgetAction :: Text -> Text -> Text -> DescribeBudgetAction
- data DescribeBudgetActionResponse = DescribeBudgetActionResponse' Int Text Text Action
- newDescribeBudgetActionResponse :: Int -> Text -> Text -> Action -> DescribeBudgetActionResponse
- data DescribeBudgetActionHistories = DescribeBudgetActionHistories' (Maybe Natural) (Maybe Text) (Maybe TimePeriod) Text Text Text
- newDescribeBudgetActionHistories :: Text -> Text -> Text -> DescribeBudgetActionHistories
- data DescribeBudgetActionHistoriesResponse = DescribeBudgetActionHistoriesResponse' (Maybe Text) Int [ActionHistory]
- newDescribeBudgetActionHistoriesResponse :: Int -> DescribeBudgetActionHistoriesResponse
- data DescribeBudgetActionsForAccount = DescribeBudgetActionsForAccount' (Maybe Natural) (Maybe Text) Text
- newDescribeBudgetActionsForAccount :: Text -> DescribeBudgetActionsForAccount
- data DescribeBudgetActionsForAccountResponse = DescribeBudgetActionsForAccountResponse' (Maybe Text) Int [Action]
- newDescribeBudgetActionsForAccountResponse :: Int -> DescribeBudgetActionsForAccountResponse
- data DescribeBudgetActionsForBudget = DescribeBudgetActionsForBudget' (Maybe Natural) (Maybe Text) Text Text
- newDescribeBudgetActionsForBudget :: Text -> Text -> DescribeBudgetActionsForBudget
- data DescribeBudgetActionsForBudgetResponse = DescribeBudgetActionsForBudgetResponse' (Maybe Text) Int [Action]
- newDescribeBudgetActionsForBudgetResponse :: Int -> DescribeBudgetActionsForBudgetResponse
- data DescribeBudgetNotificationsForAccount = DescribeBudgetNotificationsForAccount' (Maybe Natural) (Maybe Text) Text
- newDescribeBudgetNotificationsForAccount :: Text -> DescribeBudgetNotificationsForAccount
- data DescribeBudgetNotificationsForAccountResponse = DescribeBudgetNotificationsForAccountResponse' (Maybe [BudgetNotificationsForAccount]) (Maybe Text) Int
- newDescribeBudgetNotificationsForAccountResponse :: Int -> DescribeBudgetNotificationsForAccountResponse
- data DescribeBudgetPerformanceHistory = DescribeBudgetPerformanceHistory' (Maybe Natural) (Maybe Text) (Maybe TimePeriod) Text Text
- newDescribeBudgetPerformanceHistory :: Text -> Text -> DescribeBudgetPerformanceHistory
- data DescribeBudgetPerformanceHistoryResponse = DescribeBudgetPerformanceHistoryResponse' (Maybe BudgetPerformanceHistory) (Maybe Text) Int
- newDescribeBudgetPerformanceHistoryResponse :: Int -> DescribeBudgetPerformanceHistoryResponse
- data DescribeBudgets = DescribeBudgets' (Maybe Natural) (Maybe Text) Text
- newDescribeBudgets :: Text -> DescribeBudgets
- data DescribeBudgetsResponse = DescribeBudgetsResponse' (Maybe [Budget]) (Maybe Text) Int
- newDescribeBudgetsResponse :: Int -> DescribeBudgetsResponse
- data DescribeNotificationsForBudget = DescribeNotificationsForBudget' (Maybe Natural) (Maybe Text) Text Text
- newDescribeNotificationsForBudget :: Text -> Text -> DescribeNotificationsForBudget
- data DescribeNotificationsForBudgetResponse = DescribeNotificationsForBudgetResponse' (Maybe Text) (Maybe [Notification]) Int
- newDescribeNotificationsForBudgetResponse :: Int -> DescribeNotificationsForBudgetResponse
- data DescribeSubscribersForNotification = DescribeSubscribersForNotification' (Maybe Natural) (Maybe Text) Text Text Notification
- newDescribeSubscribersForNotification :: Text -> Text -> Notification -> DescribeSubscribersForNotification
- data DescribeSubscribersForNotificationResponse = DescribeSubscribersForNotificationResponse' (Maybe Text) (Maybe (NonEmpty Subscriber)) Int
- newDescribeSubscribersForNotificationResponse :: Int -> DescribeSubscribersForNotificationResponse
- data ExecuteBudgetAction = ExecuteBudgetAction' Text Text Text ExecutionType
- newExecuteBudgetAction :: Text -> Text -> Text -> ExecutionType -> ExecuteBudgetAction
- data ExecuteBudgetActionResponse = ExecuteBudgetActionResponse' Int Text Text Text ExecutionType
- newExecuteBudgetActionResponse :: Int -> Text -> Text -> Text -> ExecutionType -> ExecuteBudgetActionResponse
- data UpdateBudget = UpdateBudget' Text Budget
- newUpdateBudget :: Text -> Budget -> UpdateBudget
- data UpdateBudgetResponse = UpdateBudgetResponse' Int
- newUpdateBudgetResponse :: Int -> UpdateBudgetResponse
- data UpdateBudgetAction = UpdateBudgetAction' (Maybe ActionThreshold) (Maybe ApprovalModel) (Maybe Definition) (Maybe Text) (Maybe NotificationType) (Maybe (NonEmpty Subscriber)) Text Text Text
- newUpdateBudgetAction :: Text -> Text -> Text -> UpdateBudgetAction
- data UpdateBudgetActionResponse = UpdateBudgetActionResponse' Int Text Text Action Action
- newUpdateBudgetActionResponse :: Int -> Text -> Text -> Action -> Action -> UpdateBudgetActionResponse
- data UpdateNotification = UpdateNotification' Text Text Notification Notification
- newUpdateNotification :: Text -> Text -> Notification -> Notification -> UpdateNotification
- data UpdateNotificationResponse = UpdateNotificationResponse' Int
- newUpdateNotificationResponse :: Int -> UpdateNotificationResponse
- data UpdateSubscriber = UpdateSubscriber' Text Text Notification Subscriber Subscriber
- newUpdateSubscriber :: Text -> Text -> Notification -> Subscriber -> Subscriber -> UpdateSubscriber
- data UpdateSubscriberResponse = UpdateSubscriberResponse' Int
- newUpdateSubscriberResponse :: Int -> UpdateSubscriberResponse
- newtype ActionStatus where
- ActionStatus' { }
- pattern ActionStatus_EXECUTION_FAILURE :: ActionStatus
- pattern ActionStatus_EXECUTION_IN_PROGRESS :: ActionStatus
- pattern ActionStatus_EXECUTION_SUCCESS :: ActionStatus
- pattern ActionStatus_PENDING :: ActionStatus
- pattern ActionStatus_RESET_FAILURE :: ActionStatus
- pattern ActionStatus_RESET_IN_PROGRESS :: ActionStatus
- pattern ActionStatus_REVERSE_FAILURE :: ActionStatus
- pattern ActionStatus_REVERSE_IN_PROGRESS :: ActionStatus
- pattern ActionStatus_REVERSE_SUCCESS :: ActionStatus
- pattern ActionStatus_STANDBY :: ActionStatus
- newtype ActionSubType where
- ActionSubType' { }
- pattern ActionSubType_STOP_EC2_INSTANCES :: ActionSubType
- pattern ActionSubType_STOP_RDS_INSTANCES :: ActionSubType
- newtype ActionType where
- ActionType' { }
- pattern ActionType_APPLY_IAM_POLICY :: ActionType
- pattern ActionType_APPLY_SCP_POLICY :: ActionType
- pattern ActionType_RUN_SSM_DOCUMENTS :: ActionType
- newtype ApprovalModel where
- ApprovalModel' { }
- pattern ApprovalModel_AUTOMATIC :: ApprovalModel
- pattern ApprovalModel_MANUAL :: ApprovalModel
- newtype AutoAdjustType where
- AutoAdjustType' { }
- pattern AutoAdjustType_FORECAST :: AutoAdjustType
- pattern AutoAdjustType_HISTORICAL :: AutoAdjustType
- newtype BudgetType where
- BudgetType' { }
- pattern BudgetType_COST :: BudgetType
- pattern BudgetType_RI_COVERAGE :: BudgetType
- pattern BudgetType_RI_UTILIZATION :: BudgetType
- pattern BudgetType_SAVINGS_PLANS_COVERAGE :: BudgetType
- pattern BudgetType_SAVINGS_PLANS_UTILIZATION :: BudgetType
- pattern BudgetType_USAGE :: BudgetType
- newtype ComparisonOperator where
- newtype EventType where
- EventType' { }
- pattern EventType_CREATE_ACTION :: EventType
- pattern EventType_DELETE_ACTION :: EventType
- pattern EventType_EXECUTE_ACTION :: EventType
- pattern EventType_SYSTEM :: EventType
- pattern EventType_UPDATE_ACTION :: EventType
- newtype ExecutionType where
- ExecutionType' { }
- pattern ExecutionType_APPROVE_BUDGET_ACTION :: ExecutionType
- pattern ExecutionType_RESET_BUDGET_ACTION :: ExecutionType
- pattern ExecutionType_RETRY_BUDGET_ACTION :: ExecutionType
- pattern ExecutionType_REVERSE_BUDGET_ACTION :: ExecutionType
- newtype NotificationState where
- NotificationState' { }
- pattern NotificationState_ALARM :: NotificationState
- pattern NotificationState_OK :: NotificationState
- newtype NotificationType where
- NotificationType' { }
- pattern NotificationType_ACTUAL :: NotificationType
- pattern NotificationType_FORECASTED :: NotificationType
- newtype SubscriptionType where
- SubscriptionType' { }
- pattern SubscriptionType_EMAIL :: SubscriptionType
- pattern SubscriptionType_SNS :: SubscriptionType
- newtype ThresholdType where
- ThresholdType' { }
- pattern ThresholdType_ABSOLUTE_VALUE :: ThresholdType
- pattern ThresholdType_PERCENTAGE :: ThresholdType
- newtype TimeUnit where
- TimeUnit' {
- fromTimeUnit :: Text
- pattern TimeUnit_ANNUALLY :: TimeUnit
- pattern TimeUnit_DAILY :: TimeUnit
- pattern TimeUnit_MONTHLY :: TimeUnit
- pattern TimeUnit_QUARTERLY :: TimeUnit
- TimeUnit' {
- data Action = Action' Text Text NotificationType ActionType ActionThreshold Definition Text ApprovalModel ActionStatus (NonEmpty Subscriber)
- newAction :: Text -> Text -> NotificationType -> ActionType -> ActionThreshold -> Definition -> Text -> ApprovalModel -> ActionStatus -> NonEmpty Subscriber -> Action
- data ActionHistory = ActionHistory' POSIX ActionStatus EventType ActionHistoryDetails
- newActionHistory :: UTCTime -> ActionStatus -> EventType -> ActionHistoryDetails -> ActionHistory
- data ActionHistoryDetails = ActionHistoryDetails' Text Action
- newActionHistoryDetails :: Text -> Action -> ActionHistoryDetails
- data ActionThreshold = ActionThreshold' Double ThresholdType
- newActionThreshold :: Double -> ThresholdType -> ActionThreshold
- data AutoAdjustData = AutoAdjustData' (Maybe HistoricalOptions) (Maybe POSIX) AutoAdjustType
- newAutoAdjustData :: AutoAdjustType -> AutoAdjustData
- data Budget = Budget' (Maybe AutoAdjustData) (Maybe Spend) (Maybe CalculatedSpend) (Maybe (HashMap Text [Text])) (Maybe CostTypes) (Maybe POSIX) (Maybe (HashMap Text Spend)) (Maybe TimePeriod) Text TimeUnit BudgetType
- newBudget :: Text -> TimeUnit -> BudgetType -> Budget
- data BudgetNotificationsForAccount = BudgetNotificationsForAccount' (Maybe Text) (Maybe [Notification])
- newBudgetNotificationsForAccount :: BudgetNotificationsForAccount
- data BudgetPerformanceHistory = BudgetPerformanceHistory' (Maybe Text) (Maybe BudgetType) (Maybe [BudgetedAndActualAmounts]) (Maybe (HashMap Text [Text])) (Maybe CostTypes) (Maybe TimeUnit)
- newBudgetPerformanceHistory :: BudgetPerformanceHistory
- data BudgetedAndActualAmounts = BudgetedAndActualAmounts' (Maybe Spend) (Maybe Spend) (Maybe TimePeriod)
- newBudgetedAndActualAmounts :: BudgetedAndActualAmounts
- data CalculatedSpend = CalculatedSpend' (Maybe Spend) Spend
- newCalculatedSpend :: Spend -> CalculatedSpend
- data CostTypes = CostTypes' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newCostTypes :: CostTypes
- data Definition = Definition' (Maybe IamActionDefinition) (Maybe ScpActionDefinition) (Maybe SsmActionDefinition)
- newDefinition :: Definition
- data HistoricalOptions = HistoricalOptions' (Maybe Natural) Natural
- newHistoricalOptions :: Natural -> HistoricalOptions
- data IamActionDefinition = IamActionDefinition' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text
- newIamActionDefinition :: Text -> IamActionDefinition
- data Notification = Notification' (Maybe NotificationState) (Maybe ThresholdType) NotificationType ComparisonOperator Double
- newNotification :: NotificationType -> ComparisonOperator -> Double -> Notification
- data NotificationWithSubscribers = NotificationWithSubscribers' Notification (NonEmpty Subscriber)
- newNotificationWithSubscribers :: Notification -> NonEmpty Subscriber -> NotificationWithSubscribers
- data ScpActionDefinition = ScpActionDefinition' Text (NonEmpty Text)
- newScpActionDefinition :: Text -> NonEmpty Text -> ScpActionDefinition
- data Spend = Spend' Text Text
- newSpend :: Text -> Text -> Spend
- data SsmActionDefinition = SsmActionDefinition' ActionSubType Text (NonEmpty Text)
- newSsmActionDefinition :: ActionSubType -> Text -> NonEmpty Text -> SsmActionDefinition
- data Subscriber = Subscriber' SubscriptionType (Sensitive Text)
- newSubscriber :: SubscriptionType -> Text -> Subscriber
- data TimePeriod = TimePeriod' (Maybe POSIX) (Maybe POSIX)
- newTimePeriod :: TimePeriod
Service Configuration
defaultService :: Service Source #
API version 2016-10-20
of the Amazon Budgets SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Budgets
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You are not authorized to use this operation with the given parameters.
CreationLimitExceededException
_CreationLimitExceededException :: AsError a => Fold a ServiceError Source #
You've exceeded the notification or subscriber limit.
DuplicateRecordException
_DuplicateRecordException :: AsError a => Fold a ServiceError Source #
The budget name already exists. Budget names must be unique within an account.
ExpiredNextTokenException
_ExpiredNextTokenException :: AsError a => Fold a ServiceError Source #
The pagination token expired.
InternalErrorException
_InternalErrorException :: AsError a => Fold a ServiceError Source #
An error on the server occurred during the processing of your request. Try again later.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The pagination token is invalid.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
An error on the client occurred. Typically, the cause is an invalid input value.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
We can’t locate the resource that you specified.
ResourceLockedException
_ResourceLockedException :: AsError a => Fold a ServiceError Source #
The request was received and recognized by the server, but the server rejected that particular method for the requested resource.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateBudget
data CreateBudget Source #
Request of CreateBudget
See: newCreateBudget
smart constructor.
Instances
Create a value of CreateBudget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notificationsWithSubscribers:CreateBudget'
, createBudget_notificationsWithSubscribers
- 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 CreateBudget
call, Amazon Web Services creates
the notifications and subscribers for you.
$sel:accountId:CreateBudget'
, createBudget_accountId
- The accountId
that is associated with the budget.
$sel:budget:CreateBudget'
, createBudget_budget
- The budget object that you want to create.
data CreateBudgetResponse Source #
Response of CreateBudget
See: newCreateBudgetResponse
smart constructor.
Instances
newCreateBudgetResponse Source #
Create a value of CreateBudgetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBudgetResponse'
, createBudgetResponse_httpStatus
- The response's http status code.
CreateBudgetAction
data CreateBudgetAction Source #
See: newCreateBudgetAction
smart constructor.
CreateBudgetAction' Text Text NotificationType ActionType ActionThreshold Definition Text ApprovalModel (NonEmpty Subscriber) |
Instances
newCreateBudgetAction Source #
:: Text | |
-> Text | |
-> NotificationType | |
-> ActionType | |
-> ActionThreshold | |
-> Definition | |
-> Text | |
-> ApprovalModel | |
-> NonEmpty Subscriber | |
-> CreateBudgetAction |
Create a value of CreateBudgetAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBudgetAction
, createBudgetAction_accountId
- Undocumented member.
CreateBudgetAction
, createBudgetAction_budgetName
- Undocumented member.
CreateBudgetAction
, createBudgetAction_notificationType
- Undocumented member.
CreateBudgetAction
, createBudgetAction_actionType
- The type of action. This defines the type of tasks that can be carried
out by this action. This field also determines the format for
definition.
CreateBudgetAction
, createBudgetAction_actionThreshold
- Undocumented member.
CreateBudgetAction
, createBudgetAction_definition
- Undocumented member.
CreateBudgetAction
, createBudgetAction_executionRoleArn
- The role passed for action execution and reversion. Roles and actions
must be in the same account.
CreateBudgetAction
, createBudgetAction_approvalModel
- This specifies if the action needs manual or automatic approval.
CreateBudgetAction
, createBudgetAction_subscribers
- Undocumented member.
data CreateBudgetActionResponse Source #
See: newCreateBudgetActionResponse
smart constructor.
Instances
newCreateBudgetActionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> CreateBudgetActionResponse |
Create a value of CreateBudgetActionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBudgetActionResponse'
, createBudgetActionResponse_httpStatus
- The response's http status code.
CreateBudgetAction
, createBudgetActionResponse_accountId
- Undocumented member.
CreateBudgetAction
, createBudgetActionResponse_budgetName
- Undocumented member.
CreateBudgetActionResponse
, createBudgetActionResponse_actionId
- A system-generated universally unique identifier (UUID) for the action.
CreateNotification
data CreateNotification Source #
Request of CreateNotification
See: newCreateNotification
smart constructor.
Instances
newCreateNotification Source #
:: Text | |
-> Text | |
-> Notification | |
-> NonEmpty Subscriber | |
-> CreateNotification |
Create a value of CreateNotification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:CreateNotification'
, createNotification_accountId
- The accountId
that is associated with the budget that you want to
create a notification for.
CreateNotification
, createNotification_budgetName
- The name of the budget that you want Amazon Web Services to notify you
about. Budget names must be unique within an account.
CreateNotification
, createNotification_notification
- The notification that you want to create.
CreateNotification
, createNotification_subscribers
- 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.
data CreateNotificationResponse Source #
Response of CreateNotification
See: newCreateNotificationResponse
smart constructor.
Instances
newCreateNotificationResponse Source #
Create a value of CreateNotificationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateNotificationResponse'
, createNotificationResponse_httpStatus
- The response's http status code.
CreateSubscriber
data CreateSubscriber Source #
Request of CreateSubscriber
See: newCreateSubscriber
smart constructor.
Instances
:: Text | |
-> Text | |
-> Notification | |
-> Subscriber | |
-> CreateSubscriber |
Create a value of CreateSubscriber
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:CreateSubscriber'
, createSubscriber_accountId
- The accountId
that is associated with the budget that you want to
create a subscriber for.
CreateSubscriber
, createSubscriber_budgetName
- The name of the budget that you want to subscribe to. Budget names must
be unique within an account.
CreateSubscriber
, createSubscriber_notification
- The notification that you want to create a subscriber for.
$sel:subscriber:CreateSubscriber'
, createSubscriber_subscriber
- The subscriber that you want to associate with a budget notification.
data CreateSubscriberResponse Source #
Response of CreateSubscriber
See: newCreateSubscriberResponse
smart constructor.
Instances
newCreateSubscriberResponse Source #
Create a value of CreateSubscriberResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateSubscriberResponse'
, createSubscriberResponse_httpStatus
- The response's http status code.
DeleteBudget
data DeleteBudget Source #
Request of DeleteBudget
See: newDeleteBudget
smart constructor.
Instances
Create a value of DeleteBudget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:DeleteBudget'
, deleteBudget_accountId
- The accountId
that is associated with the budget that you want to
delete.
DeleteBudget
, deleteBudget_budgetName
- The name of the budget that you want to delete.
data DeleteBudgetResponse Source #
Response of DeleteBudget
See: newDeleteBudgetResponse
smart constructor.
Instances
newDeleteBudgetResponse Source #
Create a value of DeleteBudgetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteBudgetResponse'
, deleteBudgetResponse_httpStatus
- The response's http status code.
DeleteBudgetAction
data DeleteBudgetAction Source #
See: newDeleteBudgetAction
smart constructor.
Instances
newDeleteBudgetAction Source #
Create a value of DeleteBudgetAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBudgetAction
, deleteBudgetAction_accountId
- Undocumented member.
DeleteBudgetAction
, deleteBudgetAction_budgetName
- Undocumented member.
DeleteBudgetAction
, deleteBudgetAction_actionId
- A system-generated universally unique identifier (UUID) for the action.
data DeleteBudgetActionResponse Source #
See: newDeleteBudgetActionResponse
smart constructor.
Instances
newDeleteBudgetActionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Action | |
-> DeleteBudgetActionResponse |
Create a value of DeleteBudgetActionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteBudgetActionResponse'
, deleteBudgetActionResponse_httpStatus
- The response's http status code.
DeleteBudgetAction
, deleteBudgetActionResponse_accountId
- Undocumented member.
DeleteBudgetAction
, deleteBudgetActionResponse_budgetName
- Undocumented member.
DeleteBudgetActionResponse
, deleteBudgetActionResponse_action
- Undocumented member.
DeleteNotification
data DeleteNotification Source #
Request of DeleteNotification
See: newDeleteNotification
smart constructor.
Instances
newDeleteNotification Source #
:: Text | |
-> Text | |
-> Notification | |
-> DeleteNotification |
Create a value of DeleteNotification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:DeleteNotification'
, deleteNotification_accountId
- The accountId
that is associated with the budget whose notification
you want to delete.
DeleteNotification
, deleteNotification_budgetName
- The name of the budget whose notification you want to delete.
DeleteNotification
, deleteNotification_notification
- The notification that you want to delete.
data DeleteNotificationResponse Source #
Response of DeleteNotification
See: newDeleteNotificationResponse
smart constructor.
Instances
newDeleteNotificationResponse Source #
Create a value of DeleteNotificationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteNotificationResponse'
, deleteNotificationResponse_httpStatus
- The response's http status code.
DeleteSubscriber
data DeleteSubscriber Source #
Request of DeleteSubscriber
See: newDeleteSubscriber
smart constructor.
Instances
:: Text | |
-> Text | |
-> Notification | |
-> Subscriber | |
-> DeleteSubscriber |
Create a value of DeleteSubscriber
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:DeleteSubscriber'
, deleteSubscriber_accountId
- The accountId
that is associated with the budget whose subscriber you
want to delete.
DeleteSubscriber
, deleteSubscriber_budgetName
- The name of the budget whose subscriber you want to delete.
DeleteSubscriber
, deleteSubscriber_notification
- The notification whose subscriber you want to delete.
$sel:subscriber:DeleteSubscriber'
, deleteSubscriber_subscriber
- The subscriber that you want to delete.
data DeleteSubscriberResponse Source #
Response of DeleteSubscriber
See: newDeleteSubscriberResponse
smart constructor.
Instances
newDeleteSubscriberResponse Source #
Create a value of DeleteSubscriberResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteSubscriberResponse'
, deleteSubscriberResponse_httpStatus
- The response's http status code.
DescribeBudget
data DescribeBudget Source #
Request of DescribeBudget
See: newDescribeBudget
smart constructor.
Instances
Create a value of DescribeBudget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:DescribeBudget'
, describeBudget_accountId
- The accountId
that is associated with the budget that you want a
description of.
DescribeBudget
, describeBudget_budgetName
- The name of the budget that you want a description of.
data DescribeBudgetResponse Source #
Response of DescribeBudget
See: newDescribeBudgetResponse
smart constructor.
Instances
newDescribeBudgetResponse Source #
Create a value of DescribeBudgetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:budget:DescribeBudgetResponse'
, describeBudgetResponse_budget
- The description of the budget.
$sel:httpStatus:DescribeBudgetResponse'
, describeBudgetResponse_httpStatus
- The response's http status code.
DescribeBudgetAction
data DescribeBudgetAction Source #
See: newDescribeBudgetAction
smart constructor.
Instances
newDescribeBudgetAction Source #
:: Text | |
-> Text | |
-> Text | |
-> DescribeBudgetAction |
Create a value of DescribeBudgetAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBudgetAction
, describeBudgetAction_accountId
- Undocumented member.
DescribeBudgetAction
, describeBudgetAction_budgetName
- Undocumented member.
DescribeBudgetAction
, describeBudgetAction_actionId
- A system-generated universally unique identifier (UUID) for the action.
data DescribeBudgetActionResponse Source #
See: newDescribeBudgetActionResponse
smart constructor.
Instances
newDescribeBudgetActionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Action | |
-> DescribeBudgetActionResponse |
Create a value of DescribeBudgetActionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeBudgetActionResponse'
, describeBudgetActionResponse_httpStatus
- The response's http status code.
DescribeBudgetAction
, describeBudgetActionResponse_accountId
- Undocumented member.
DescribeBudgetAction
, describeBudgetActionResponse_budgetName
- Undocumented member.
DescribeBudgetActionResponse
, describeBudgetActionResponse_action
- A budget action resource.
DescribeBudgetActionHistories (Paginated)
data DescribeBudgetActionHistories Source #
See: newDescribeBudgetActionHistories
smart constructor.
Instances
newDescribeBudgetActionHistories Source #
:: Text | |
-> Text | |
-> Text | |
-> DescribeBudgetActionHistories |
Create a value of DescribeBudgetActionHistories
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeBudgetActionHistories'
, describeBudgetActionHistories_maxResults
- Undocumented member.
DescribeBudgetActionHistories
, describeBudgetActionHistories_nextToken
- Undocumented member.
DescribeBudgetActionHistories
, describeBudgetActionHistories_timePeriod
- Undocumented member.
$sel:accountId:DescribeBudgetActionHistories'
, describeBudgetActionHistories_accountId
- Undocumented member.
DescribeBudgetActionHistories
, describeBudgetActionHistories_budgetName
- Undocumented member.
DescribeBudgetActionHistories
, describeBudgetActionHistories_actionId
- A system-generated universally unique identifier (UUID) for the action.
data DescribeBudgetActionHistoriesResponse Source #
See: newDescribeBudgetActionHistoriesResponse
smart constructor.
Instances
newDescribeBudgetActionHistoriesResponse Source #
Create a value of DescribeBudgetActionHistoriesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBudgetActionHistories
, describeBudgetActionHistoriesResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeBudgetActionHistoriesResponse'
, describeBudgetActionHistoriesResponse_httpStatus
- The response's http status code.
$sel:actionHistories:DescribeBudgetActionHistoriesResponse'
, describeBudgetActionHistoriesResponse_actionHistories
- The historical record of the budget action resource.
DescribeBudgetActionsForAccount (Paginated)
data DescribeBudgetActionsForAccount Source #
See: newDescribeBudgetActionsForAccount
smart constructor.
Instances
newDescribeBudgetActionsForAccount Source #
Create a value of DescribeBudgetActionsForAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeBudgetActionsForAccount'
, describeBudgetActionsForAccount_maxResults
- Undocumented member.
DescribeBudgetActionsForAccount
, describeBudgetActionsForAccount_nextToken
- Undocumented member.
$sel:accountId:DescribeBudgetActionsForAccount'
, describeBudgetActionsForAccount_accountId
- Undocumented member.
data DescribeBudgetActionsForAccountResponse Source #
See: newDescribeBudgetActionsForAccountResponse
smart constructor.
Instances
newDescribeBudgetActionsForAccountResponse Source #
Create a value of DescribeBudgetActionsForAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBudgetActionsForAccount
, describeBudgetActionsForAccountResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeBudgetActionsForAccountResponse'
, describeBudgetActionsForAccountResponse_httpStatus
- The response's http status code.
$sel:actions:DescribeBudgetActionsForAccountResponse'
, describeBudgetActionsForAccountResponse_actions
- A list of the budget action resources information.
DescribeBudgetActionsForBudget (Paginated)
data DescribeBudgetActionsForBudget Source #
See: newDescribeBudgetActionsForBudget
smart constructor.
Instances
newDescribeBudgetActionsForBudget Source #
Create a value of DescribeBudgetActionsForBudget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeBudgetActionsForBudget'
, describeBudgetActionsForBudget_maxResults
- Undocumented member.
DescribeBudgetActionsForBudget
, describeBudgetActionsForBudget_nextToken
- Undocumented member.
$sel:accountId:DescribeBudgetActionsForBudget'
, describeBudgetActionsForBudget_accountId
- Undocumented member.
DescribeBudgetActionsForBudget
, describeBudgetActionsForBudget_budgetName
- Undocumented member.
data DescribeBudgetActionsForBudgetResponse Source #
See: newDescribeBudgetActionsForBudgetResponse
smart constructor.
Instances
newDescribeBudgetActionsForBudgetResponse Source #
Create a value of DescribeBudgetActionsForBudgetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBudgetActionsForBudget
, describeBudgetActionsForBudgetResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeBudgetActionsForBudgetResponse'
, describeBudgetActionsForBudgetResponse_httpStatus
- The response's http status code.
$sel:actions:DescribeBudgetActionsForBudgetResponse'
, describeBudgetActionsForBudgetResponse_actions
- A list of the budget action resources information.
DescribeBudgetNotificationsForAccount (Paginated)
data DescribeBudgetNotificationsForAccount Source #
See: newDescribeBudgetNotificationsForAccount
smart constructor.
Instances
newDescribeBudgetNotificationsForAccount Source #
Create a value of DescribeBudgetNotificationsForAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeBudgetNotificationsForAccount'
, describeBudgetNotificationsForAccount_maxResults
- An integer that shows how many budget name entries a paginated response
contains.
DescribeBudgetNotificationsForAccount
, describeBudgetNotificationsForAccount_nextToken
- Undocumented member.
$sel:accountId:DescribeBudgetNotificationsForAccount'
, describeBudgetNotificationsForAccount_accountId
- Undocumented member.
data DescribeBudgetNotificationsForAccountResponse Source #
See: newDescribeBudgetNotificationsForAccountResponse
smart constructor.
DescribeBudgetNotificationsForAccountResponse' (Maybe [BudgetNotificationsForAccount]) (Maybe Text) Int |
Instances
newDescribeBudgetNotificationsForAccountResponse Source #
:: Int |
|
-> DescribeBudgetNotificationsForAccountResponse |
Create a value of DescribeBudgetNotificationsForAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:budgetNotificationsForAccount:DescribeBudgetNotificationsForAccountResponse'
, describeBudgetNotificationsForAccountResponse_budgetNotificationsForAccount
- A list of budget names and associated notifications for an account.
DescribeBudgetNotificationsForAccount
, describeBudgetNotificationsForAccountResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeBudgetNotificationsForAccountResponse'
, describeBudgetNotificationsForAccountResponse_httpStatus
- The response's http status code.
DescribeBudgetPerformanceHistory (Paginated)
data DescribeBudgetPerformanceHistory Source #
See: newDescribeBudgetPerformanceHistory
smart constructor.
Instances
newDescribeBudgetPerformanceHistory Source #
Create a value of DescribeBudgetPerformanceHistory
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeBudgetPerformanceHistory'
, describeBudgetPerformanceHistory_maxResults
- Undocumented member.
DescribeBudgetPerformanceHistory
, describeBudgetPerformanceHistory_nextToken
- Undocumented member.
DescribeBudgetPerformanceHistory
, describeBudgetPerformanceHistory_timePeriod
- Retrieves how often the budget went into an ALARM
state for the
specified time period.
$sel:accountId:DescribeBudgetPerformanceHistory'
, describeBudgetPerformanceHistory_accountId
- Undocumented member.
DescribeBudgetPerformanceHistory
, describeBudgetPerformanceHistory_budgetName
- Undocumented member.
data DescribeBudgetPerformanceHistoryResponse Source #
See: newDescribeBudgetPerformanceHistoryResponse
smart constructor.
Instances
newDescribeBudgetPerformanceHistoryResponse Source #
Create a value of DescribeBudgetPerformanceHistoryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:budgetPerformanceHistory:DescribeBudgetPerformanceHistoryResponse'
, describeBudgetPerformanceHistoryResponse_budgetPerformanceHistory
- The history of how often the budget has gone into an ALARM
state.
For DAILY
budgets, the history saves the state of the budget for the
last 60 days. For MONTHLY
budgets, the history saves the state of the
budget for the current month plus the last 12 months. For QUARTERLY
budgets, the history saves the state of the budget for the last four
quarters.
DescribeBudgetPerformanceHistory
, describeBudgetPerformanceHistoryResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeBudgetPerformanceHistoryResponse'
, describeBudgetPerformanceHistoryResponse_httpStatus
- The response's http status code.
DescribeBudgets (Paginated)
data DescribeBudgets Source #
Request of DescribeBudgets
See: newDescribeBudgets
smart constructor.
Instances
Create a value of DescribeBudgets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeBudgets'
, describeBudgets_maxResults
- An optional integer that represents how many entries a paginated
response contains. The maximum is 100.
DescribeBudgets
, describeBudgets_nextToken
- The pagination token that you include in your request to indicate the
next set of results that you want to retrieve.
$sel:accountId:DescribeBudgets'
, describeBudgets_accountId
- The accountId
that is associated with the budgets that you want
descriptions of.
data DescribeBudgetsResponse Source #
Response of DescribeBudgets
See: newDescribeBudgetsResponse
smart constructor.
Instances
newDescribeBudgetsResponse Source #
Create a value of DescribeBudgetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:budgets:DescribeBudgetsResponse'
, describeBudgetsResponse_budgets
- A list of budgets.
DescribeBudgets
, describeBudgetsResponse_nextToken
- The pagination token in the service response that indicates the next set
of results that you can retrieve.
$sel:httpStatus:DescribeBudgetsResponse'
, describeBudgetsResponse_httpStatus
- The response's http status code.
DescribeNotificationsForBudget (Paginated)
data DescribeNotificationsForBudget Source #
Request of DescribeNotificationsForBudget
See: newDescribeNotificationsForBudget
smart constructor.
Instances
newDescribeNotificationsForBudget Source #
Create a value of DescribeNotificationsForBudget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeNotificationsForBudget'
, describeNotificationsForBudget_maxResults
- An optional integer that represents how many entries a paginated
response contains. The maximum is 100.
DescribeNotificationsForBudget
, describeNotificationsForBudget_nextToken
- The pagination token that you include in your request to indicate the
next set of results that you want to retrieve.
$sel:accountId:DescribeNotificationsForBudget'
, describeNotificationsForBudget_accountId
- The accountId
that is associated with the budget whose notifications
you want descriptions of.
DescribeNotificationsForBudget
, describeNotificationsForBudget_budgetName
- The name of the budget whose notifications you want descriptions of.
data DescribeNotificationsForBudgetResponse Source #
Response of GetNotificationsForBudget
See: newDescribeNotificationsForBudgetResponse
smart constructor.
Instances
newDescribeNotificationsForBudgetResponse Source #
Create a value of DescribeNotificationsForBudgetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeNotificationsForBudget
, describeNotificationsForBudgetResponse_nextToken
- The pagination token in the service response that indicates the next set
of results that you can retrieve.
DescribeNotificationsForBudgetResponse
, describeNotificationsForBudgetResponse_notifications
- A list of notifications that are associated with a budget.
$sel:httpStatus:DescribeNotificationsForBudgetResponse'
, describeNotificationsForBudgetResponse_httpStatus
- The response's http status code.
DescribeSubscribersForNotification (Paginated)
data DescribeSubscribersForNotification Source #
Request of DescribeSubscribersForNotification
See: newDescribeSubscribersForNotification
smart constructor.
Instances
newDescribeSubscribersForNotification Source #
Create a value of DescribeSubscribersForNotification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeSubscribersForNotification'
, describeSubscribersForNotification_maxResults
- An optional integer that represents how many entries a paginated
response contains. The maximum is 100.
DescribeSubscribersForNotification
, describeSubscribersForNotification_nextToken
- The pagination token that you include in your request to indicate the
next set of results that you want to retrieve.
$sel:accountId:DescribeSubscribersForNotification'
, describeSubscribersForNotification_accountId
- The accountId
that is associated with the budget whose subscribers you
want descriptions of.
DescribeSubscribersForNotification
, describeSubscribersForNotification_budgetName
- The name of the budget whose subscribers you want descriptions of.
DescribeSubscribersForNotification
, describeSubscribersForNotification_notification
- The notification whose subscribers you want to list.
data DescribeSubscribersForNotificationResponse Source #
Response of DescribeSubscribersForNotification
See: newDescribeSubscribersForNotificationResponse
smart constructor.
Instances
newDescribeSubscribersForNotificationResponse Source #
Create a value of DescribeSubscribersForNotificationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeSubscribersForNotification
, describeSubscribersForNotificationResponse_nextToken
- The pagination token in the service response that indicates the next set
of results that you can retrieve.
DescribeSubscribersForNotificationResponse
, describeSubscribersForNotificationResponse_subscribers
- A list of subscribers that are associated with a notification.
$sel:httpStatus:DescribeSubscribersForNotificationResponse'
, describeSubscribersForNotificationResponse_httpStatus
- The response's http status code.
ExecuteBudgetAction
data ExecuteBudgetAction Source #
See: newExecuteBudgetAction
smart constructor.
Instances
newExecuteBudgetAction Source #
:: Text | |
-> Text | |
-> Text | |
-> ExecutionType | |
-> ExecuteBudgetAction |
Create a value of ExecuteBudgetAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExecuteBudgetAction
, executeBudgetAction_accountId
- Undocumented member.
ExecuteBudgetAction
, executeBudgetAction_budgetName
- Undocumented member.
ExecuteBudgetAction
, executeBudgetAction_actionId
- A system-generated universally unique identifier (UUID) for the action.
ExecuteBudgetAction
, executeBudgetAction_executionType
- The type of execution.
data ExecuteBudgetActionResponse Source #
See: newExecuteBudgetActionResponse
smart constructor.
Instances
newExecuteBudgetActionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> ExecutionType | |
-> ExecuteBudgetActionResponse |
Create a value of ExecuteBudgetActionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ExecuteBudgetActionResponse'
, executeBudgetActionResponse_httpStatus
- The response's http status code.
ExecuteBudgetAction
, executeBudgetActionResponse_accountId
- Undocumented member.
ExecuteBudgetAction
, executeBudgetActionResponse_budgetName
- Undocumented member.
ExecuteBudgetAction
, executeBudgetActionResponse_actionId
- A system-generated universally unique identifier (UUID) for the action.
ExecuteBudgetAction
, executeBudgetActionResponse_executionType
- The type of execution.
UpdateBudget
data UpdateBudget Source #
Request of UpdateBudget
See: newUpdateBudget
smart constructor.
Instances
Create a value of UpdateBudget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:UpdateBudget'
, updateBudget_accountId
- The accountId
that is associated with the budget that you want to
update.
$sel:newBudget':UpdateBudget'
, updateBudget_newBudget
- The budget that you want to update your budget to.
data UpdateBudgetResponse Source #
Response of UpdateBudget
See: newUpdateBudgetResponse
smart constructor.
Instances
newUpdateBudgetResponse Source #
Create a value of UpdateBudgetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateBudgetResponse'
, updateBudgetResponse_httpStatus
- The response's http status code.
UpdateBudgetAction
data UpdateBudgetAction Source #
See: newUpdateBudgetAction
smart constructor.
UpdateBudgetAction' (Maybe ActionThreshold) (Maybe ApprovalModel) (Maybe Definition) (Maybe Text) (Maybe NotificationType) (Maybe (NonEmpty Subscriber)) Text Text Text |
Instances
newUpdateBudgetAction Source #
Create a value of UpdateBudgetAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateBudgetAction
, updateBudgetAction_actionThreshold
- Undocumented member.
UpdateBudgetAction
, updateBudgetAction_approvalModel
- This specifies if the action needs manual or automatic approval.
UpdateBudgetAction
, updateBudgetAction_definition
- Undocumented member.
UpdateBudgetAction
, updateBudgetAction_executionRoleArn
- The role passed for action execution and reversion. Roles and actions
must be in the same account.
UpdateBudgetAction
, updateBudgetAction_notificationType
- Undocumented member.
UpdateBudgetAction
, updateBudgetAction_subscribers
- Undocumented member.
UpdateBudgetAction
, updateBudgetAction_accountId
- Undocumented member.
UpdateBudgetAction
, updateBudgetAction_budgetName
- Undocumented member.
UpdateBudgetAction
, updateBudgetAction_actionId
- A system-generated universally unique identifier (UUID) for the action.
data UpdateBudgetActionResponse Source #
See: newUpdateBudgetActionResponse
smart constructor.
Instances
newUpdateBudgetActionResponse Source #
Create a value of UpdateBudgetActionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateBudgetActionResponse'
, updateBudgetActionResponse_httpStatus
- The response's http status code.
UpdateBudgetAction
, updateBudgetActionResponse_accountId
- Undocumented member.
UpdateBudgetAction
, updateBudgetActionResponse_budgetName
- Undocumented member.
$sel:oldAction:UpdateBudgetActionResponse'
, updateBudgetActionResponse_oldAction
- The previous action resource information.
$sel:newAction':UpdateBudgetActionResponse'
, updateBudgetActionResponse_newAction
- The updated action resource information.
UpdateNotification
data UpdateNotification Source #
Request of UpdateNotification
See: newUpdateNotification
smart constructor.
Instances
newUpdateNotification Source #
:: Text | |
-> Text | |
-> Notification | |
-> Notification | |
-> UpdateNotification |
Create a value of UpdateNotification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:UpdateNotification'
, updateNotification_accountId
- The accountId
that is associated with the budget whose notification
you want to update.
UpdateNotification
, updateNotification_budgetName
- The name of the budget whose notification you want to update.
$sel:oldNotification:UpdateNotification'
, updateNotification_oldNotification
- The previous notification that is associated with a budget.
$sel:newNotification':UpdateNotification'
, updateNotification_newNotification
- The updated notification to be associated with a budget.
data UpdateNotificationResponse Source #
Response of UpdateNotification
See: newUpdateNotificationResponse
smart constructor.
Instances
newUpdateNotificationResponse Source #
Create a value of UpdateNotificationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateNotificationResponse'
, updateNotificationResponse_httpStatus
- The response's http status code.
UpdateSubscriber
data UpdateSubscriber Source #
Request of UpdateSubscriber
See: newUpdateSubscriber
smart constructor.
Instances
:: Text | |
-> Text | |
-> Notification | |
-> Subscriber | |
-> Subscriber | |
-> UpdateSubscriber |
Create a value of UpdateSubscriber
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:UpdateSubscriber'
, updateSubscriber_accountId
- The accountId
that is associated with the budget whose subscriber you
want to update.
UpdateSubscriber
, updateSubscriber_budgetName
- The name of the budget whose subscriber you want to update.
UpdateSubscriber
, updateSubscriber_notification
- The notification whose subscriber you want to update.
$sel:oldSubscriber:UpdateSubscriber'
, updateSubscriber_oldSubscriber
- The previous subscriber that is associated with a budget notification.
$sel:newSubscriber':UpdateSubscriber'
, updateSubscriber_newSubscriber
- The updated subscriber that is associated with a budget notification.
data UpdateSubscriberResponse Source #
Response of UpdateSubscriber
See: newUpdateSubscriberResponse
smart constructor.
Instances
newUpdateSubscriberResponse Source #
Create a value of UpdateSubscriberResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateSubscriberResponse'
, updateSubscriberResponse_httpStatus
- The response's http status code.
Types
ActionStatus
newtype ActionStatus Source #
pattern ActionStatus_EXECUTION_FAILURE :: ActionStatus | |
pattern ActionStatus_EXECUTION_IN_PROGRESS :: ActionStatus | |
pattern ActionStatus_EXECUTION_SUCCESS :: ActionStatus | |
pattern ActionStatus_PENDING :: ActionStatus | |
pattern ActionStatus_RESET_FAILURE :: ActionStatus | |
pattern ActionStatus_RESET_IN_PROGRESS :: ActionStatus | |
pattern ActionStatus_REVERSE_FAILURE :: ActionStatus | |
pattern ActionStatus_REVERSE_IN_PROGRESS :: ActionStatus | |
pattern ActionStatus_REVERSE_SUCCESS :: ActionStatus | |
pattern ActionStatus_STANDBY :: ActionStatus |
Instances
ActionSubType
newtype ActionSubType Source #
pattern ActionSubType_STOP_EC2_INSTANCES :: ActionSubType | |
pattern ActionSubType_STOP_RDS_INSTANCES :: ActionSubType |
Instances
ActionType
newtype ActionType Source #
pattern ActionType_APPLY_IAM_POLICY :: ActionType | |
pattern ActionType_APPLY_SCP_POLICY :: ActionType | |
pattern ActionType_RUN_SSM_DOCUMENTS :: ActionType |
Instances
ApprovalModel
newtype ApprovalModel Source #
pattern ApprovalModel_AUTOMATIC :: ApprovalModel | |
pattern ApprovalModel_MANUAL :: ApprovalModel |
Instances
AutoAdjustType
newtype AutoAdjustType Source #
pattern AutoAdjustType_FORECAST :: AutoAdjustType | |
pattern AutoAdjustType_HISTORICAL :: AutoAdjustType |
Instances
BudgetType
newtype BudgetType Source #
The type of a budget. It must be one of the following types:
COST
, USAGE
, RI_UTILIZATION
, RI_COVERAGE
,
SAVINGS_PLANS_UTILIZATION
, or SAVINGS_PLANS_COVERAGE
.
pattern BudgetType_COST :: BudgetType | |
pattern BudgetType_RI_COVERAGE :: BudgetType | |
pattern BudgetType_RI_UTILIZATION :: BudgetType | |
pattern BudgetType_SAVINGS_PLANS_COVERAGE :: BudgetType | |
pattern BudgetType_SAVINGS_PLANS_UTILIZATION :: BudgetType | |
pattern BudgetType_USAGE :: BudgetType |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
The comparison operator of a notification. Currently, the service supports the following operators:
GREATER_THAN
, LESS_THAN
, EQUAL_TO
pattern ComparisonOperator_EQUAL_TO :: ComparisonOperator | |
pattern ComparisonOperator_GREATER_THAN :: ComparisonOperator | |
pattern ComparisonOperator_LESS_THAN :: ComparisonOperator |
Instances
EventType
pattern EventType_CREATE_ACTION :: EventType | |
pattern EventType_DELETE_ACTION :: EventType | |
pattern EventType_EXECUTE_ACTION :: EventType | |
pattern EventType_SYSTEM :: EventType | |
pattern EventType_UPDATE_ACTION :: EventType |
Instances
ExecutionType
newtype ExecutionType Source #
pattern ExecutionType_APPROVE_BUDGET_ACTION :: ExecutionType | |
pattern ExecutionType_RESET_BUDGET_ACTION :: ExecutionType | |
pattern ExecutionType_RETRY_BUDGET_ACTION :: ExecutionType | |
pattern ExecutionType_REVERSE_BUDGET_ACTION :: ExecutionType |
Instances
NotificationState
newtype NotificationState Source #
pattern NotificationState_ALARM :: NotificationState | |
pattern NotificationState_OK :: NotificationState |
Instances
NotificationType
newtype NotificationType Source #
The type of a notification. It must be ACTUAL or FORECASTED.
pattern NotificationType_ACTUAL :: NotificationType | |
pattern NotificationType_FORECASTED :: NotificationType |
Instances
SubscriptionType
newtype SubscriptionType Source #
The subscription type of the subscriber. It can be SMS or EMAIL.
pattern SubscriptionType_EMAIL :: SubscriptionType | |
pattern SubscriptionType_SNS :: SubscriptionType |
Instances
ThresholdType
newtype ThresholdType Source #
The type of threshold for a notification.
pattern ThresholdType_ABSOLUTE_VALUE :: ThresholdType | |
pattern ThresholdType_PERCENTAGE :: ThresholdType |
Instances
TimeUnit
The time unit of the budget, such as MONTHLY or QUARTERLY.
pattern TimeUnit_ANNUALLY :: TimeUnit | |
pattern TimeUnit_DAILY :: TimeUnit | |
pattern TimeUnit_MONTHLY :: TimeUnit | |
pattern TimeUnit_QUARTERLY :: TimeUnit |
Instances
Action
A budget action resource.
See: newAction
smart constructor.
Action' Text Text NotificationType ActionType ActionThreshold Definition Text ApprovalModel ActionStatus (NonEmpty Subscriber) |
Instances
:: Text | |
-> Text | |
-> NotificationType | |
-> ActionType | |
-> ActionThreshold | |
-> Definition | |
-> Text | |
-> ApprovalModel | |
-> ActionStatus | |
-> NonEmpty Subscriber | |
-> Action |
Create a value of Action
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionId:Action'
, action_actionId
- A system-generated universally unique identifier (UUID) for the action.
$sel:budgetName:Action'
, action_budgetName
- Undocumented member.
$sel:notificationType:Action'
, action_notificationType
- Undocumented member.
$sel:actionType:Action'
, action_actionType
- The type of action. This defines the type of tasks that can be carried
out by this action. This field also determines the format for
definition.
$sel:actionThreshold:Action'
, action_actionThreshold
- The trigger threshold of the action.
$sel:definition:Action'
, action_definition
- Where you specify all of the type-specific parameters.
$sel:executionRoleArn:Action'
, action_executionRoleArn
- The role passed for action execution and reversion. Roles and actions
must be in the same account.
$sel:approvalModel:Action'
, action_approvalModel
- This specifies if the action needs manual or automatic approval.
$sel:status:Action'
, action_status
- The status of the action.
$sel:subscribers:Action'
, action_subscribers
- Undocumented member.
ActionHistory
data ActionHistory Source #
The historical records for a budget action.
See: newActionHistory
smart constructor.
Instances
Create a value of ActionHistory
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timestamp:ActionHistory'
, actionHistory_timestamp
- Undocumented member.
$sel:status:ActionHistory'
, actionHistory_status
- The status of action at the time of the event.
$sel:eventType:ActionHistory'
, actionHistory_eventType
- This distinguishes between whether the events are triggered by the user
or are generated by the system.
$sel:actionHistoryDetails:ActionHistory'
, actionHistory_actionHistoryDetails
- The description of the details for the event.
ActionHistoryDetails
data ActionHistoryDetails Source #
The description of the details for the event.
See: newActionHistoryDetails
smart constructor.
Instances
newActionHistoryDetails Source #
:: Text | |
-> Action | |
-> ActionHistoryDetails |
Create a value of ActionHistoryDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:ActionHistoryDetails'
, actionHistoryDetails_message
- Undocumented member.
$sel:action:ActionHistoryDetails'
, actionHistoryDetails_action
- The budget action resource.
ActionThreshold
data ActionThreshold Source #
The trigger threshold of the action.
See: newActionThreshold
smart constructor.
Instances
:: Double | |
-> ThresholdType | |
-> ActionThreshold |
Create a value of ActionThreshold
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionThresholdValue:ActionThreshold'
, actionThreshold_actionThresholdValue
- Undocumented member.
$sel:actionThresholdType:ActionThreshold'
, actionThreshold_actionThresholdType
- Undocumented member.
AutoAdjustData
data AutoAdjustData Source #
The parameters that determine the budget amount for an auto-adjusting budget.
See: newAutoAdjustData
smart constructor.
Instances
Create a value of AutoAdjustData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:historicalOptions:AutoAdjustData'
, autoAdjustData_historicalOptions
- The parameters that define or describe the historical data that your
auto-adjusting budget is based on.
$sel:lastAutoAdjustTime:AutoAdjustData'
, autoAdjustData_lastAutoAdjustTime
- The last time that your budget was auto-adjusted.
$sel:autoAdjustType:AutoAdjustData'
, autoAdjustData_autoAdjustType
- The string that defines whether your budget auto-adjusts based on
historical or forecasted data.
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
See: newBudget
smart constructor.
Budget' (Maybe AutoAdjustData) (Maybe Spend) (Maybe CalculatedSpend) (Maybe (HashMap Text [Text])) (Maybe CostTypes) (Maybe POSIX) (Maybe (HashMap Text Spend)) (Maybe TimePeriod) Text TimeUnit BudgetType |
Instances
:: Text | |
-> TimeUnit | |
-> BudgetType | |
-> Budget |
Create a value of Budget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoAdjustData:Budget'
, budget_autoAdjustData
- The parameters that determine the budget amount for an auto-adjusting
budget.
$sel:budgetLimit:Budget'
, budget_budgetLimit
- The total amount of cost, usage, RI utilization, RI coverage, Savings
Plans utilization, or Savings Plans coverage that you want to track with
your budget.
BudgetLimit
is required for cost or usage budgets, but optional for RI
or Savings Plans utilization or coverage budgets. RI and Savings Plans
utilization or coverage budgets default to 100
. This is the only valid
value for RI or Savings Plans utilization or coverage budgets. You
can't use BudgetLimit
with PlannedBudgetLimits
for CreateBudget
and UpdateBudget
actions.
$sel:calculatedSpend:Budget'
, budget_calculatedSpend
- The actual and forecasted cost or usage that the budget tracks.
$sel:costFilters:Budget'
, budget_costFilters
- The cost filters, such as Region
, Service
, member account
, Tag
,
or Cost Category
, that are applied to a budget.
Amazon Web Services Budgets supports the following services as a
Service
filter for RI budgets:
- Amazon EC2
- Amazon Redshift
- Amazon Relational Database Service
- Amazon ElastiCache
- Amazon OpenSearch Service
$sel:costTypes:Budget'
, budget_costTypes
- The types of costs that are included in this COST
budget.
USAGE
, RI_UTILIZATION
, RI_COVERAGE
, SAVINGS_PLANS_UTILIZATION
,
and SAVINGS_PLANS_COVERAGE
budgets do not have CostTypes
.
$sel:lastUpdatedTime:Budget'
, budget_lastUpdatedTime
- The last time that you updated this budget.
$sel:plannedBudgetLimits:Budget'
, budget_plannedBudgetLimits
- A map containing multiple BudgetLimit
, including current or future
limits.
PlannedBudgetLimits
is available for cost or usage budget and supports
both monthly and quarterly TimeUnit
.
For monthly budgets, provide 12 months of PlannedBudgetLimits
values.
This must start from the current month and include the next 11 months.
The key
is the start of the month, UTC
in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits
value entries in standard calendar quarter increments. This must start
from the current quarter and include the next three quarters. The key
is the start of the quarter, UTC
in epoch seconds.
If the planned budget expires before 12 months for monthly or four
quarters for quarterly, provide the PlannedBudgetLimits
values only
for the remaining periods.
If the budget begins at a date in the future, provide
PlannedBudgetLimits
values from the start date of the budget.
After all of the BudgetLimit
values in PlannedBudgetLimits
are used,
the budget continues to use the last limit as the BudgetLimit
. At that
point, the planned budget provides the same experience as a fixed
budget.
DescribeBudget
and DescribeBudgets
response along with
PlannedBudgetLimits
also contain BudgetLimit
representing the
current month or quarter limit present in PlannedBudgetLimits
. This
only applies to budgets that are created with PlannedBudgetLimits
.
Budgets that are created without PlannedBudgetLimits
only contain
BudgetLimit
. They don't contain PlannedBudgetLimits
.
$sel:timePeriod:Budget'
, budget_timePeriod
- The period of time that's covered by a budget. You setthe start date
and end date. The start date must come before the end date. The end date
must come before 06/15/87 00:00 UTC
.
If you create your budget and don't specify a start date, Amazon Web
Services 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 DAILY
, and didn't set a start date,
Amazon Web Services set your start date to 01/24/18 00:00 UTC
. If
you chose MONTHLY
, Amazon Web Services set your start date to
01/01/18 00:00 UTC
. If you didn't specify an end date, Amazon Web
Services set your end date to 06/15/87 00:00 UTC
. The defaults are
the same for the Billing and Cost Management console and the API.
You can change either date with the UpdateBudget
operation.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
$sel:budgetName:Budget'
, budget_budgetName
- The name of a budget. The name must be unique within an account. The :
and \
characters aren't allowed in BudgetName
.
$sel:timeUnit:Budget'
, budget_timeUnit
- The length of time until a budget resets the actual and forecasted
spend.
$sel:budgetType:Budget'
, budget_budgetType
- Specifies whether this budget tracks costs, usage, RI utilization, RI
coverage, Savings Plans utilization, or Savings Plans coverage.
BudgetNotificationsForAccount
data BudgetNotificationsForAccount Source #
The budget name and associated notifications for an account.
See: newBudgetNotificationsForAccount
smart constructor.
Instances
newBudgetNotificationsForAccount :: BudgetNotificationsForAccount Source #
Create a value of BudgetNotificationsForAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:budgetName:BudgetNotificationsForAccount'
, budgetNotificationsForAccount_budgetName
- Undocumented member.
$sel:notifications:BudgetNotificationsForAccount'
, budgetNotificationsForAccount_notifications
- Undocumented member.
BudgetPerformanceHistory
data BudgetPerformanceHistory Source #
A history of the state of a budget at the end of the budget's specified time period.
See: newBudgetPerformanceHistory
smart constructor.
BudgetPerformanceHistory' (Maybe Text) (Maybe BudgetType) (Maybe [BudgetedAndActualAmounts]) (Maybe (HashMap Text [Text])) (Maybe CostTypes) (Maybe TimeUnit) |
Instances
newBudgetPerformanceHistory :: BudgetPerformanceHistory Source #
Create a value of BudgetPerformanceHistory
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:budgetName:BudgetPerformanceHistory'
, budgetPerformanceHistory_budgetName
- Undocumented member.
$sel:budgetType:BudgetPerformanceHistory'
, budgetPerformanceHistory_budgetType
- Undocumented member.
$sel:budgetedAndActualAmountsList:BudgetPerformanceHistory'
, budgetPerformanceHistory_budgetedAndActualAmountsList
- A list of amounts of cost or usage that you created budgets for, which
are compared to your actual costs or usage.
$sel:costFilters:BudgetPerformanceHistory'
, budgetPerformanceHistory_costFilters
- The history of the cost filters for a budget during the specified time
period.
$sel:costTypes:BudgetPerformanceHistory'
, budgetPerformanceHistory_costTypes
- The history of the cost types for a budget during the specified time
period.
$sel:timeUnit:BudgetPerformanceHistory'
, budgetPerformanceHistory_timeUnit
- Undocumented member.
BudgetedAndActualAmounts
data BudgetedAndActualAmounts Source #
The amount of cost or usage that you created the budget for, compared to your actual costs or usage.
See: newBudgetedAndActualAmounts
smart constructor.
Instances
newBudgetedAndActualAmounts :: BudgetedAndActualAmounts Source #
Create a value of BudgetedAndActualAmounts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actualAmount:BudgetedAndActualAmounts'
, budgetedAndActualAmounts_actualAmount
- Your actual costs or usage for a budget period.
$sel:budgetedAmount:BudgetedAndActualAmounts'
, budgetedAndActualAmounts_budgetedAmount
- The amount of cost or usage that you created the budget for.
$sel:timePeriod:BudgetedAndActualAmounts'
, budgetedAndActualAmounts_timePeriod
- The time period that's covered by this budget comparison.
CalculatedSpend
data CalculatedSpend Source #
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
.
See: newCalculatedSpend
smart constructor.
Instances
Create a value of CalculatedSpend
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forecastedSpend:CalculatedSpend'
, calculatedSpend_forecastedSpend
- The amount of cost, usage, RI units, or Savings Plans units that you're
forecasted to use.
$sel:actualSpend:CalculatedSpend'
, calculatedSpend_actualSpend
- The amount of cost, usage, RI units, or Savings Plans units that you
used.
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
.
See: newCostTypes
smart constructor.
CostTypes' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
Instances
newCostTypes :: CostTypes Source #
Create a value of CostTypes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeCredit:CostTypes'
, costTypes_includeCredit
- Specifies whether a budget includes credits.
The default value is true
.
$sel:includeDiscount:CostTypes'
, costTypes_includeDiscount
- Specifies whether a budget includes discounts.
The default value is true
.
$sel:includeOtherSubscription:CostTypes'
, costTypes_includeOtherSubscription
- Specifies whether a budget includes non-RI subscription costs.
The default value is true
.
$sel:includeRecurring:CostTypes'
, costTypes_includeRecurring
- Specifies whether a budget includes recurring fees such as monthly RI
fees.
The default value is true
.
$sel:includeRefund:CostTypes'
, costTypes_includeRefund
- Specifies whether a budget includes refunds.
The default value is true
.
$sel:includeSubscription:CostTypes'
, costTypes_includeSubscription
- Specifies whether a budget includes subscriptions.
The default value is true
.
$sel:includeSupport:CostTypes'
, costTypes_includeSupport
- Specifies whether a budget includes support subscription fees.
The default value is true
.
$sel:includeTax:CostTypes'
, costTypes_includeTax
- Specifies whether a budget includes taxes.
The default value is true
.
$sel:includeUpfront:CostTypes'
, costTypes_includeUpfront
- Specifies whether a budget includes upfront RI costs.
The default value is true
.
$sel:useAmortized:CostTypes'
, costTypes_useAmortized
- Specifies whether a budget uses the amortized rate.
The default value is false
.
$sel:useBlended:CostTypes'
, costTypes_useBlended
- Specifies whether a budget uses a blended rate.
The default value is false
.
Definition
data Definition Source #
Specifies all of the type-specific parameters.
See: newDefinition
smart constructor.
Instances
newDefinition :: Definition Source #
Create a value of Definition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamActionDefinition:Definition'
, definition_iamActionDefinition
- The Identity and Access Management (IAM) action definition details.
$sel:scpActionDefinition:Definition'
, definition_scpActionDefinition
- The service control policies (SCPs) action definition details.
$sel:ssmActionDefinition:Definition'
, definition_ssmActionDefinition
- The Amazon Web Services Systems Manager (SSM) action definition details.
HistoricalOptions
data HistoricalOptions Source #
The parameters that define or describe the historical data that your auto-adjusting budget is based on.
See: newHistoricalOptions
smart constructor.
Instances
Create a value of HistoricalOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lookBackAvailablePeriods:HistoricalOptions'
, historicalOptions_lookBackAvailablePeriods
- The integer that describes how many budget periods in your
BudgetAdjustmentPeriod
are included in the calculation of your current
BudgetLimit
. If the first budget period in your
BudgetAdjustmentPeriod
has no cost data, then that budget period isn’t
included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod
as 4
quarters, but
your account had no cost data in the first quarter, then only the last
three quarters are included in the calculation. In this scenario,
LookBackAvailablePeriods
returns 3
.
You can’t set your own LookBackAvailablePeriods
. The value is
automatically calculated from the BudgetAdjustmentPeriod
and your
historical cost data.
$sel:budgetAdjustmentPeriod:HistoricalOptions'
, historicalOptions_budgetAdjustmentPeriod
- The number of budget periods included in the moving-average calculation
that determines your auto-adjusted budget amount. The maximum value
depends on the TimeUnit
granularity of the budget:
- For the
DAILY
granularity, the maximum value is60
. - For the
MONTHLY
granularity, the maximum value is12
. - For the
QUARTERLY
granularity, the maximum value is4
. - For the
ANNUALLY
granularity, the maximum value is1
.
IamActionDefinition
data IamActionDefinition Source #
The Identity and Access Management (IAM) action definition details.
See: newIamActionDefinition
smart constructor.
Instances
newIamActionDefinition Source #
Create a value of IamActionDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groups:IamActionDefinition'
, iamActionDefinition_groups
- A list of groups to be attached. There must be at least one group.
$sel:roles:IamActionDefinition'
, iamActionDefinition_roles
- A list of roles to be attached. There must be at least one role.
$sel:users:IamActionDefinition'
, iamActionDefinition_users
- A list of users to be attached. There must be at least one user.
$sel:policyArn:IamActionDefinition'
, iamActionDefinition_policyArn
- The Amazon Resource Name (ARN) of the policy to be attached.
Notification
data Notification Source #
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
ofPERCENTAGE
- A
comparisonOperator
ofGREATER_THAN
- A notification
threshold
of80
See: newNotification
smart constructor.
Notification' (Maybe NotificationState) (Maybe ThresholdType) NotificationType ComparisonOperator Double |
Instances
Create a value of Notification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notificationState:Notification'
, notification_notificationState
- Specifies whether this notification is in alarm. If a budget
notification is in the ALARM
state, you passed the set threshold for
the budget.
$sel:thresholdType:Notification'
, notification_thresholdType
- The type of threshold for a notification. For ABSOLUTE_VALUE
thresholds, Amazon Web Services notifies you when you go over or are
forecasted to go over your total cost threshold. For PERCENTAGE
thresholds, Amazon Web Services 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
PERCENTAGE
threshold of 80%, Amazon Web Services notifies you when you
go over 160 dollars.
$sel:notificationType:Notification'
, notification_notificationType
- Specifies whether the notification is for how much you have spent
(ACTUAL
) or for how much that you're forecasted to spend
(FORECASTED
).
$sel:comparisonOperator:Notification'
, notification_comparisonOperator
- The comparison that's used for this notification.
$sel:threshold:Notification'
, notification_threshold
- The threshold that's 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.
NotificationWithSubscribers
data NotificationWithSubscribers Source #
A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
See: newNotificationWithSubscribers
smart constructor.
Instances
newNotificationWithSubscribers Source #
Create a value of NotificationWithSubscribers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notification:NotificationWithSubscribers'
, notificationWithSubscribers_notification
- The notification that's associated with a budget.
$sel:subscribers:NotificationWithSubscribers'
, notificationWithSubscribers_subscribers
- A list of subscribers who are subscribed to this notification.
ScpActionDefinition
data ScpActionDefinition Source #
The service control policies (SCP) action definition details.
See: newScpActionDefinition
smart constructor.
Instances
newScpActionDefinition Source #
:: Text | |
-> NonEmpty Text | |
-> ScpActionDefinition |
Create a value of ScpActionDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyId:ScpActionDefinition'
, scpActionDefinition_policyId
- The policy ID attached.
$sel:targetIds:ScpActionDefinition'
, scpActionDefinition_targetIds
- A list of target IDs.
Spend
The amount of cost or usage that's measured for a budget.
For example, a Spend
for 3 GB
of S3 usage has the following
parameters:
- An
Amount
of3
- A
unit
ofGB
See: newSpend
smart constructor.
Instances
FromJSON Spend Source # | |
ToJSON Spend Source # | |
Defined in Amazonka.Budgets.Types.Spend | |
Generic Spend Source # | |
Read Spend Source # | |
Show Spend Source # | |
NFData Spend Source # | |
Defined in Amazonka.Budgets.Types.Spend | |
Eq Spend Source # | |
Hashable Spend Source # | |
Defined in Amazonka.Budgets.Types.Spend | |
type Rep Spend Source # | |
Defined in Amazonka.Budgets.Types.Spend type Rep Spend = D1 ('MetaData "Spend" "Amazonka.Budgets.Types.Spend" "amazonka-budgets-2.0-7U1RWOWP6pxJESvTUhAD5Y" 'False) (C1 ('MetaCons "Spend'" 'PrefixI 'True) (S1 ('MetaSel ('Just "amount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Spend
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:amount:Spend'
, spend_amount
- The cost or usage amount that's associated with a budget forecast,
actual spend, or budget threshold.
$sel:unit:Spend'
, spend_unit
- The unit of measurement that's used for the budget forecast, actual
spend, or budget threshold, such as USD or GBP.
SsmActionDefinition
data SsmActionDefinition Source #
The Amazon Web Services Systems Manager (SSM) action definition details.
See: newSsmActionDefinition
smart constructor.
Instances
newSsmActionDefinition Source #
:: ActionSubType | |
-> Text | |
-> NonEmpty Text | |
-> SsmActionDefinition |
Create a value of SsmActionDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionSubType:SsmActionDefinition'
, ssmActionDefinition_actionSubType
- The action subType.
$sel:region:SsmActionDefinition'
, ssmActionDefinition_region
- The Region to run the SSM document.
$sel:instanceIds:SsmActionDefinition'
, ssmActionDefinition_instanceIds
- The EC2 and RDS instance IDs.
Subscriber
data Subscriber Source #
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
ofEMAIL
- An
address
ofexample@example.com
See: newSubscriber
smart constructor.
Instances
Create a value of Subscriber
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subscriptionType:Subscriber'
, subscriber_subscriptionType
- The type of notification that Amazon Web Services sends to a subscriber.
$sel:address:Subscriber'
, subscriber_address
- The address that Amazon Web Services sends budget notifications to,
either an SNS topic or an email.
When you create a subscriber, the value of Address
can't contain line
breaks.
TimePeriod
data TimePeriod Source #
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.
See: newTimePeriod
smart constructor.
TimePeriod' (Maybe POSIX) (Maybe POSIX) |
Instances
newTimePeriod :: TimePeriod Source #
Create a value of TimePeriod
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:end:TimePeriod'
, timePeriod_end
- The end date for a budget. If you didn't specify an end date, Amazon
Web Services set your end date to 06/15/87 00:00 UTC
. The defaults
are the same for the Billing and Cost Management console and the API.
After the end date, Amazon Web Services deletes the budget and all the
associated notifications and subscribers. You can change your end date
with the UpdateBudget
operation.
$sel:start:TimePeriod'
, timePeriod_start
- The start date for a budget. If you created your budget and didn't
specify a start date, Amazon Web Services 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 DAILY
,
and didn't set a start date, Amazon Web Services set your start date to
01/24/18 00:00 UTC
. If you chose MONTHLY
, Amazon Web Services set
your start date to 01/01/18 00:00 UTC
. The defaults are the same for
the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget
operation.