amazonka-budgets-2.0: Amazon Budgets SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Budgets.Lens

Description

 
Synopsis

Operations

CreateBudget

createBudget_notificationsWithSubscribers :: Lens' CreateBudget (Maybe [NotificationWithSubscribers]) Source #

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.

createBudget_accountId :: Lens' CreateBudget Text Source #

The accountId that is associated with the budget.

createBudget_budget :: Lens' CreateBudget Budget Source #

The budget object that you want to create.

createBudgetResponse_httpStatus :: Lens' CreateBudgetResponse Int Source #

The response's http status code.

CreateBudgetAction

createBudgetAction_accountId :: Lens' CreateBudgetAction Text Source #

Undocumented member.

createBudgetAction_budgetName :: Lens' CreateBudgetAction Text Source #

Undocumented member.

createBudgetAction_notificationType :: Lens' CreateBudgetAction NotificationType Source #

Undocumented member.

createBudgetAction_actionType :: Lens' CreateBudgetAction ActionType Source #

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_actionThreshold :: Lens' CreateBudgetAction ActionThreshold Source #

Undocumented member.

createBudgetAction_definition :: Lens' CreateBudgetAction Definition Source #

Undocumented member.

createBudgetAction_executionRoleArn :: Lens' CreateBudgetAction Text Source #

The role passed for action execution and reversion. Roles and actions must be in the same account.

createBudgetAction_approvalModel :: Lens' CreateBudgetAction ApprovalModel Source #

This specifies if the action needs manual or automatic approval.

createBudgetAction_subscribers :: Lens' CreateBudgetAction (NonEmpty Subscriber) Source #

Undocumented member.

createBudgetActionResponse_httpStatus :: Lens' CreateBudgetActionResponse Int Source #

The response's http status code.

createBudgetActionResponse_accountId :: Lens' CreateBudgetActionResponse Text Source #

Undocumented member.

createBudgetActionResponse_budgetName :: Lens' CreateBudgetActionResponse Text Source #

Undocumented member.

createBudgetActionResponse_actionId :: Lens' CreateBudgetActionResponse Text Source #

A system-generated universally unique identifier (UUID) for the action.

CreateNotification

createNotification_accountId :: Lens' CreateNotification Text Source #

The accountId that is associated with the budget that you want to create a notification for.

createNotification_budgetName :: Lens' CreateNotification Text Source #

The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.

createNotification_notification :: Lens' CreateNotification Notification Source #

The notification that you want to create.

createNotification_subscribers :: Lens' CreateNotification (NonEmpty Subscriber) Source #

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.

createNotificationResponse_httpStatus :: Lens' CreateNotificationResponse Int Source #

The response's http status code.

CreateSubscriber

createSubscriber_accountId :: Lens' CreateSubscriber Text Source #

The accountId that is associated with the budget that you want to create a subscriber for.

createSubscriber_budgetName :: Lens' CreateSubscriber Text Source #

The name of the budget that you want to subscribe to. Budget names must be unique within an account.

createSubscriber_notification :: Lens' CreateSubscriber Notification Source #

The notification that you want to create a subscriber for.

createSubscriber_subscriber :: Lens' CreateSubscriber Subscriber Source #

The subscriber that you want to associate with a budget notification.

createSubscriberResponse_httpStatus :: Lens' CreateSubscriberResponse Int Source #

The response's http status code.

DeleteBudget

deleteBudget_accountId :: Lens' DeleteBudget Text Source #

The accountId that is associated with the budget that you want to delete.

deleteBudget_budgetName :: Lens' DeleteBudget Text Source #

The name of the budget that you want to delete.

deleteBudgetResponse_httpStatus :: Lens' DeleteBudgetResponse Int Source #

The response's http status code.

DeleteBudgetAction

deleteBudgetAction_accountId :: Lens' DeleteBudgetAction Text Source #

Undocumented member.

deleteBudgetAction_budgetName :: Lens' DeleteBudgetAction Text Source #

Undocumented member.

deleteBudgetAction_actionId :: Lens' DeleteBudgetAction Text Source #

A system-generated universally unique identifier (UUID) for the action.

deleteBudgetActionResponse_httpStatus :: Lens' DeleteBudgetActionResponse Int Source #

The response's http status code.

deleteBudgetActionResponse_accountId :: Lens' DeleteBudgetActionResponse Text Source #

Undocumented member.

deleteBudgetActionResponse_budgetName :: Lens' DeleteBudgetActionResponse Text Source #

Undocumented member.

deleteBudgetActionResponse_action :: Lens' DeleteBudgetActionResponse Action Source #

Undocumented member.

DeleteNotification

deleteNotification_accountId :: Lens' DeleteNotification Text Source #

The accountId that is associated with the budget whose notification you want to delete.

deleteNotification_budgetName :: Lens' DeleteNotification Text Source #

The name of the budget whose notification you want to delete.

deleteNotification_notification :: Lens' DeleteNotification Notification Source #

The notification that you want to delete.

deleteNotificationResponse_httpStatus :: Lens' DeleteNotificationResponse Int Source #

The response's http status code.

DeleteSubscriber

deleteSubscriber_accountId :: Lens' DeleteSubscriber Text Source #

The accountId that is associated with the budget whose subscriber you want to delete.

deleteSubscriber_budgetName :: Lens' DeleteSubscriber Text Source #

The name of the budget whose subscriber you want to delete.

deleteSubscriber_notification :: Lens' DeleteSubscriber Notification Source #

The notification whose subscriber you want to delete.

deleteSubscriber_subscriber :: Lens' DeleteSubscriber Subscriber Source #

The subscriber that you want to delete.

deleteSubscriberResponse_httpStatus :: Lens' DeleteSubscriberResponse Int Source #

The response's http status code.

DescribeBudget

describeBudget_accountId :: Lens' DescribeBudget Text Source #

The accountId that is associated with the budget that you want a description of.

describeBudget_budgetName :: Lens' DescribeBudget Text Source #

The name of the budget that you want a description of.

describeBudgetResponse_budget :: Lens' DescribeBudgetResponse (Maybe Budget) Source #

The description of the budget.

describeBudgetResponse_httpStatus :: Lens' DescribeBudgetResponse Int Source #

The response's http status code.

DescribeBudgetAction

describeBudgetAction_accountId :: Lens' DescribeBudgetAction Text Source #

Undocumented member.

describeBudgetAction_budgetName :: Lens' DescribeBudgetAction Text Source #

Undocumented member.

describeBudgetAction_actionId :: Lens' DescribeBudgetAction Text Source #

A system-generated universally unique identifier (UUID) for the action.

describeBudgetActionResponse_httpStatus :: Lens' DescribeBudgetActionResponse Int Source #

The response's http status code.

describeBudgetActionResponse_accountId :: Lens' DescribeBudgetActionResponse Text Source #

Undocumented member.

describeBudgetActionResponse_budgetName :: Lens' DescribeBudgetActionResponse Text Source #

Undocumented member.

describeBudgetActionResponse_action :: Lens' DescribeBudgetActionResponse Action Source #

A budget action resource.

DescribeBudgetActionHistories

describeBudgetActionHistories_maxResults :: Lens' DescribeBudgetActionHistories (Maybe Natural) Source #

Undocumented member.

describeBudgetActionHistories_nextToken :: Lens' DescribeBudgetActionHistories (Maybe Text) Source #

Undocumented member.

describeBudgetActionHistories_timePeriod :: Lens' DescribeBudgetActionHistories (Maybe TimePeriod) Source #

Undocumented member.

describeBudgetActionHistories_accountId :: Lens' DescribeBudgetActionHistories Text Source #

Undocumented member.

describeBudgetActionHistories_budgetName :: Lens' DescribeBudgetActionHistories Text Source #

Undocumented member.

describeBudgetActionHistories_actionId :: Lens' DescribeBudgetActionHistories Text Source #

A system-generated universally unique identifier (UUID) for the action.

describeBudgetActionHistoriesResponse_nextToken :: Lens' DescribeBudgetActionHistoriesResponse (Maybe Text) Source #

Undocumented member.

describeBudgetActionHistoriesResponse_httpStatus :: Lens' DescribeBudgetActionHistoriesResponse Int Source #

The response's http status code.

describeBudgetActionHistoriesResponse_actionHistories :: Lens' DescribeBudgetActionHistoriesResponse [ActionHistory] Source #

The historical record of the budget action resource.

DescribeBudgetActionsForAccount

describeBudgetActionsForAccount_maxResults :: Lens' DescribeBudgetActionsForAccount (Maybe Natural) Source #

Undocumented member.

describeBudgetActionsForAccount_nextToken :: Lens' DescribeBudgetActionsForAccount (Maybe Text) Source #

Undocumented member.

describeBudgetActionsForAccount_accountId :: Lens' DescribeBudgetActionsForAccount Text Source #

Undocumented member.

describeBudgetActionsForAccountResponse_nextToken :: Lens' DescribeBudgetActionsForAccountResponse (Maybe Text) Source #

Undocumented member.

describeBudgetActionsForAccountResponse_httpStatus :: Lens' DescribeBudgetActionsForAccountResponse Int Source #

The response's http status code.

describeBudgetActionsForAccountResponse_actions :: Lens' DescribeBudgetActionsForAccountResponse [Action] Source #

A list of the budget action resources information.

DescribeBudgetActionsForBudget

describeBudgetActionsForBudget_maxResults :: Lens' DescribeBudgetActionsForBudget (Maybe Natural) Source #

Undocumented member.

describeBudgetActionsForBudget_nextToken :: Lens' DescribeBudgetActionsForBudget (Maybe Text) Source #

Undocumented member.

describeBudgetActionsForBudget_accountId :: Lens' DescribeBudgetActionsForBudget Text Source #

Undocumented member.

describeBudgetActionsForBudget_budgetName :: Lens' DescribeBudgetActionsForBudget Text Source #

Undocumented member.

describeBudgetActionsForBudgetResponse_nextToken :: Lens' DescribeBudgetActionsForBudgetResponse (Maybe Text) Source #

Undocumented member.

describeBudgetActionsForBudgetResponse_httpStatus :: Lens' DescribeBudgetActionsForBudgetResponse Int Source #

The response's http status code.

describeBudgetActionsForBudgetResponse_actions :: Lens' DescribeBudgetActionsForBudgetResponse [Action] Source #

A list of the budget action resources information.

DescribeBudgetNotificationsForAccount

describeBudgetNotificationsForAccount_maxResults :: Lens' DescribeBudgetNotificationsForAccount (Maybe Natural) Source #

An integer that shows how many budget name entries a paginated response contains.

describeBudgetNotificationsForAccount_nextToken :: Lens' DescribeBudgetNotificationsForAccount (Maybe Text) Source #

Undocumented member.

describeBudgetNotificationsForAccount_accountId :: Lens' DescribeBudgetNotificationsForAccount Text Source #

Undocumented member.

describeBudgetNotificationsForAccountResponse_budgetNotificationsForAccount :: Lens' DescribeBudgetNotificationsForAccountResponse (Maybe [BudgetNotificationsForAccount]) Source #

A list of budget names and associated notifications for an account.

describeBudgetNotificationsForAccountResponse_nextToken :: Lens' DescribeBudgetNotificationsForAccountResponse (Maybe Text) Source #

Undocumented member.

describeBudgetNotificationsForAccountResponse_httpStatus :: Lens' DescribeBudgetNotificationsForAccountResponse Int Source #

The response's http status code.

DescribeBudgetPerformanceHistory

describeBudgetPerformanceHistory_maxResults :: Lens' DescribeBudgetPerformanceHistory (Maybe Natural) Source #

Undocumented member.

describeBudgetPerformanceHistory_nextToken :: Lens' DescribeBudgetPerformanceHistory (Maybe Text) Source #

Undocumented member.

describeBudgetPerformanceHistory_timePeriod :: Lens' DescribeBudgetPerformanceHistory (Maybe TimePeriod) Source #

Retrieves how often the budget went into an ALARM state for the specified time period.

describeBudgetPerformanceHistory_accountId :: Lens' DescribeBudgetPerformanceHistory Text Source #

Undocumented member.

describeBudgetPerformanceHistory_budgetName :: Lens' DescribeBudgetPerformanceHistory Text Source #

Undocumented member.

describeBudgetPerformanceHistoryResponse_budgetPerformanceHistory :: Lens' DescribeBudgetPerformanceHistoryResponse (Maybe BudgetPerformanceHistory) Source #

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.

describeBudgetPerformanceHistoryResponse_nextToken :: Lens' DescribeBudgetPerformanceHistoryResponse (Maybe Text) Source #

Undocumented member.

describeBudgetPerformanceHistoryResponse_httpStatus :: Lens' DescribeBudgetPerformanceHistoryResponse Int Source #

The response's http status code.

DescribeBudgets

describeBudgets_maxResults :: Lens' DescribeBudgets (Maybe Natural) Source #

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

describeBudgets_nextToken :: Lens' DescribeBudgets (Maybe Text) Source #

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

describeBudgets_accountId :: Lens' DescribeBudgets Text Source #

The accountId that is associated with the budgets that you want descriptions of.

describeBudgetsResponse_budgets :: Lens' DescribeBudgetsResponse (Maybe [Budget]) Source #

A list of budgets.

describeBudgetsResponse_nextToken :: Lens' DescribeBudgetsResponse (Maybe Text) Source #

The pagination token in the service response that indicates the next set of results that you can retrieve.

describeBudgetsResponse_httpStatus :: Lens' DescribeBudgetsResponse Int Source #

The response's http status code.

DescribeNotificationsForBudget

describeNotificationsForBudget_maxResults :: Lens' DescribeNotificationsForBudget (Maybe Natural) Source #

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

describeNotificationsForBudget_nextToken :: Lens' DescribeNotificationsForBudget (Maybe Text) Source #

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

describeNotificationsForBudget_accountId :: Lens' DescribeNotificationsForBudget Text Source #

The accountId that is associated with the budget whose notifications you want descriptions of.

describeNotificationsForBudget_budgetName :: Lens' DescribeNotificationsForBudget Text Source #

The name of the budget whose notifications you want descriptions of.

describeNotificationsForBudgetResponse_nextToken :: Lens' DescribeNotificationsForBudgetResponse (Maybe Text) Source #

The pagination token in the service response that indicates the next set of results that you can retrieve.

describeNotificationsForBudgetResponse_notifications :: Lens' DescribeNotificationsForBudgetResponse (Maybe [Notification]) Source #

A list of notifications that are associated with a budget.

describeNotificationsForBudgetResponse_httpStatus :: Lens' DescribeNotificationsForBudgetResponse Int Source #

The response's http status code.

DescribeSubscribersForNotification

describeSubscribersForNotification_maxResults :: Lens' DescribeSubscribersForNotification (Maybe Natural) Source #

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

describeSubscribersForNotification_nextToken :: Lens' DescribeSubscribersForNotification (Maybe Text) Source #

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

describeSubscribersForNotification_accountId :: Lens' DescribeSubscribersForNotification Text Source #

The accountId that is associated with the budget whose subscribers you want descriptions of.

describeSubscribersForNotification_budgetName :: Lens' DescribeSubscribersForNotification Text Source #

The name of the budget whose subscribers you want descriptions of.

describeSubscribersForNotification_notification :: Lens' DescribeSubscribersForNotification Notification Source #

The notification whose subscribers you want to list.

describeSubscribersForNotificationResponse_nextToken :: Lens' DescribeSubscribersForNotificationResponse (Maybe Text) Source #

The pagination token in the service response that indicates the next set of results that you can retrieve.

describeSubscribersForNotificationResponse_subscribers :: Lens' DescribeSubscribersForNotificationResponse (Maybe (NonEmpty Subscriber)) Source #

A list of subscribers that are associated with a notification.

describeSubscribersForNotificationResponse_httpStatus :: Lens' DescribeSubscribersForNotificationResponse Int Source #

The response's http status code.

ExecuteBudgetAction

executeBudgetAction_accountId :: Lens' ExecuteBudgetAction Text Source #

Undocumented member.

executeBudgetAction_budgetName :: Lens' ExecuteBudgetAction Text Source #

Undocumented member.

executeBudgetAction_actionId :: Lens' ExecuteBudgetAction Text Source #

A system-generated universally unique identifier (UUID) for the action.

executeBudgetAction_executionType :: Lens' ExecuteBudgetAction ExecutionType Source #

The type of execution.

executeBudgetActionResponse_httpStatus :: Lens' ExecuteBudgetActionResponse Int Source #

The response's http status code.

executeBudgetActionResponse_accountId :: Lens' ExecuteBudgetActionResponse Text Source #

Undocumented member.

executeBudgetActionResponse_budgetName :: Lens' ExecuteBudgetActionResponse Text Source #

Undocumented member.

executeBudgetActionResponse_actionId :: Lens' ExecuteBudgetActionResponse Text Source #

A system-generated universally unique identifier (UUID) for the action.

executeBudgetActionResponse_executionType :: Lens' ExecuteBudgetActionResponse ExecutionType Source #

The type of execution.

UpdateBudget

updateBudget_accountId :: Lens' UpdateBudget Text Source #

The accountId that is associated with the budget that you want to update.

updateBudget_newBudget :: Lens' UpdateBudget Budget Source #

The budget that you want to update your budget to.

updateBudgetResponse_httpStatus :: Lens' UpdateBudgetResponse Int Source #

The response's http status code.

UpdateBudgetAction

updateBudgetAction_actionThreshold :: Lens' UpdateBudgetAction (Maybe ActionThreshold) Source #

Undocumented member.

updateBudgetAction_approvalModel :: Lens' UpdateBudgetAction (Maybe ApprovalModel) Source #

This specifies if the action needs manual or automatic approval.

updateBudgetAction_definition :: Lens' UpdateBudgetAction (Maybe Definition) Source #

Undocumented member.

updateBudgetAction_executionRoleArn :: Lens' UpdateBudgetAction (Maybe Text) Source #

The role passed for action execution and reversion. Roles and actions must be in the same account.

updateBudgetAction_notificationType :: Lens' UpdateBudgetAction (Maybe NotificationType) Source #

Undocumented member.

updateBudgetAction_subscribers :: Lens' UpdateBudgetAction (Maybe (NonEmpty Subscriber)) Source #

Undocumented member.

updateBudgetAction_accountId :: Lens' UpdateBudgetAction Text Source #

Undocumented member.

updateBudgetAction_budgetName :: Lens' UpdateBudgetAction Text Source #

Undocumented member.

updateBudgetAction_actionId :: Lens' UpdateBudgetAction Text Source #

A system-generated universally unique identifier (UUID) for the action.

updateBudgetActionResponse_httpStatus :: Lens' UpdateBudgetActionResponse Int Source #

The response's http status code.

updateBudgetActionResponse_accountId :: Lens' UpdateBudgetActionResponse Text Source #

Undocumented member.

updateBudgetActionResponse_budgetName :: Lens' UpdateBudgetActionResponse Text Source #

Undocumented member.

updateBudgetActionResponse_oldAction :: Lens' UpdateBudgetActionResponse Action Source #

The previous action resource information.

updateBudgetActionResponse_newAction :: Lens' UpdateBudgetActionResponse Action Source #

The updated action resource information.

UpdateNotification

updateNotification_accountId :: Lens' UpdateNotification Text Source #

The accountId that is associated with the budget whose notification you want to update.

updateNotification_budgetName :: Lens' UpdateNotification Text Source #

The name of the budget whose notification you want to update.

updateNotification_oldNotification :: Lens' UpdateNotification Notification Source #

The previous notification that is associated with a budget.

updateNotification_newNotification :: Lens' UpdateNotification Notification Source #

The updated notification to be associated with a budget.

updateNotificationResponse_httpStatus :: Lens' UpdateNotificationResponse Int Source #

The response's http status code.

UpdateSubscriber

updateSubscriber_accountId :: Lens' UpdateSubscriber Text Source #

The accountId that is associated with the budget whose subscriber you want to update.

updateSubscriber_budgetName :: Lens' UpdateSubscriber Text Source #

The name of the budget whose subscriber you want to update.

updateSubscriber_notification :: Lens' UpdateSubscriber Notification Source #

The notification whose subscriber you want to update.

updateSubscriber_oldSubscriber :: Lens' UpdateSubscriber Subscriber Source #

The previous subscriber that is associated with a budget notification.

updateSubscriber_newSubscriber :: Lens' UpdateSubscriber Subscriber Source #

The updated subscriber that is associated with a budget notification.

updateSubscriberResponse_httpStatus :: Lens' UpdateSubscriberResponse Int Source #

The response's http status code.

Types

Action

action_actionId :: Lens' Action Text Source #

A system-generated universally unique identifier (UUID) for the action.

action_budgetName :: Lens' Action Text Source #

Undocumented member.

action_notificationType :: Lens' Action NotificationType Source #

Undocumented member.

action_actionType :: Lens' Action ActionType Source #

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.

action_actionThreshold :: Lens' Action ActionThreshold Source #

The trigger threshold of the action.

action_definition :: Lens' Action Definition Source #

Where you specify all of the type-specific parameters.

action_executionRoleArn :: Lens' Action Text Source #

The role passed for action execution and reversion. Roles and actions must be in the same account.

action_approvalModel :: Lens' Action ApprovalModel Source #

This specifies if the action needs manual or automatic approval.

action_status :: Lens' Action ActionStatus Source #

The status of the action.

action_subscribers :: Lens' Action (NonEmpty Subscriber) Source #

Undocumented member.

ActionHistory

actionHistory_timestamp :: Lens' ActionHistory UTCTime Source #

Undocumented member.

actionHistory_status :: Lens' ActionHistory ActionStatus Source #

The status of action at the time of the event.

actionHistory_eventType :: Lens' ActionHistory EventType Source #

This distinguishes between whether the events are triggered by the user or are generated by the system.

actionHistory_actionHistoryDetails :: Lens' ActionHistory ActionHistoryDetails Source #

The description of the details for the event.

ActionHistoryDetails

actionHistoryDetails_message :: Lens' ActionHistoryDetails Text Source #

Undocumented member.

actionHistoryDetails_action :: Lens' ActionHistoryDetails Action Source #

The budget action resource.

ActionThreshold

actionThreshold_actionThresholdValue :: Lens' ActionThreshold Double Source #

Undocumented member.

actionThreshold_actionThresholdType :: Lens' ActionThreshold ThresholdType Source #

Undocumented member.

AutoAdjustData

autoAdjustData_historicalOptions :: Lens' AutoAdjustData (Maybe HistoricalOptions) Source #

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

autoAdjustData_lastAutoAdjustTime :: Lens' AutoAdjustData (Maybe UTCTime) Source #

The last time that your budget was auto-adjusted.

autoAdjustData_autoAdjustType :: Lens' AutoAdjustData AutoAdjustType Source #

The string that defines whether your budget auto-adjusts based on historical or forecasted data.

Budget

budget_autoAdjustData :: Lens' Budget (Maybe AutoAdjustData) Source #

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

budget_budgetLimit :: Lens' Budget (Maybe Spend) Source #

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.

budget_calculatedSpend :: Lens' Budget (Maybe CalculatedSpend) Source #

The actual and forecasted cost or usage that the budget tracks.

budget_costFilters :: Lens' Budget (Maybe (HashMap Text [Text])) Source #

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

budget_costTypes :: Lens' Budget (Maybe CostTypes) Source #

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.

budget_lastUpdatedTime :: Lens' Budget (Maybe UTCTime) Source #

The last time that you updated this budget.

budget_plannedBudgetLimits :: Lens' Budget (Maybe (HashMap Text Spend)) Source #

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.

budget_timePeriod :: Lens' Budget (Maybe TimePeriod) Source #

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.

budget_budgetName :: Lens' Budget Text Source #

The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.

budget_timeUnit :: Lens' Budget TimeUnit Source #

The length of time until a budget resets the actual and forecasted spend.

budget_budgetType :: Lens' Budget BudgetType Source #

Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

BudgetNotificationsForAccount

budgetNotificationsForAccount_budgetName :: Lens' BudgetNotificationsForAccount (Maybe Text) Source #

Undocumented member.

budgetNotificationsForAccount_notifications :: Lens' BudgetNotificationsForAccount (Maybe [Notification]) Source #

Undocumented member.

BudgetPerformanceHistory

budgetPerformanceHistory_budgetName :: Lens' BudgetPerformanceHistory (Maybe Text) Source #

Undocumented member.

budgetPerformanceHistory_budgetType :: Lens' BudgetPerformanceHistory (Maybe BudgetType) Source #

Undocumented member.

budgetPerformanceHistory_budgetedAndActualAmountsList :: Lens' BudgetPerformanceHistory (Maybe [BudgetedAndActualAmounts]) Source #

A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.

budgetPerformanceHistory_costFilters :: Lens' BudgetPerformanceHistory (Maybe (HashMap Text [Text])) Source #

The history of the cost filters for a budget during the specified time period.

budgetPerformanceHistory_costTypes :: Lens' BudgetPerformanceHistory (Maybe CostTypes) Source #

The history of the cost types for a budget during the specified time period.

budgetPerformanceHistory_timeUnit :: Lens' BudgetPerformanceHistory (Maybe TimeUnit) Source #

Undocumented member.

BudgetedAndActualAmounts

budgetedAndActualAmounts_actualAmount :: Lens' BudgetedAndActualAmounts (Maybe Spend) Source #

Your actual costs or usage for a budget period.

budgetedAndActualAmounts_budgetedAmount :: Lens' BudgetedAndActualAmounts (Maybe Spend) Source #

The amount of cost or usage that you created the budget for.

budgetedAndActualAmounts_timePeriod :: Lens' BudgetedAndActualAmounts (Maybe TimePeriod) Source #

The time period that's covered by this budget comparison.

CalculatedSpend

calculatedSpend_forecastedSpend :: Lens' CalculatedSpend (Maybe Spend) Source #

The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.

calculatedSpend_actualSpend :: Lens' CalculatedSpend Spend Source #

The amount of cost, usage, RI units, or Savings Plans units that you used.

CostTypes

costTypes_includeCredit :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes credits.

The default value is true.

costTypes_includeDiscount :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes discounts.

The default value is true.

costTypes_includeOtherSubscription :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes non-RI subscription costs.

The default value is true.

costTypes_includeRecurring :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes recurring fees such as monthly RI fees.

The default value is true.

costTypes_includeRefund :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes refunds.

The default value is true.

costTypes_includeSubscription :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes subscriptions.

The default value is true.

costTypes_includeSupport :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes support subscription fees.

The default value is true.

costTypes_includeTax :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes taxes.

The default value is true.

costTypes_includeUpfront :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget includes upfront RI costs.

The default value is true.

costTypes_useAmortized :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget uses the amortized rate.

The default value is false.

costTypes_useBlended :: Lens' CostTypes (Maybe Bool) Source #

Specifies whether a budget uses a blended rate.

The default value is false.

Definition

definition_iamActionDefinition :: Lens' Definition (Maybe IamActionDefinition) Source #

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

definition_scpActionDefinition :: Lens' Definition (Maybe ScpActionDefinition) Source #

The service control policies (SCPs) action definition details.

definition_ssmActionDefinition :: Lens' Definition (Maybe SsmActionDefinition) Source #

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

HistoricalOptions

historicalOptions_lookBackAvailablePeriods :: Lens' HistoricalOptions (Maybe Natural) Source #

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.

historicalOptions_budgetAdjustmentPeriod :: Lens' HistoricalOptions Natural Source #

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 is 60.
  • For the MONTHLY granularity, the maximum value is 12.
  • For the QUARTERLY granularity, the maximum value is 4.
  • For the ANNUALLY granularity, the maximum value is 1.

IamActionDefinition

iamActionDefinition_groups :: Lens' IamActionDefinition (Maybe (NonEmpty Text)) Source #

A list of groups to be attached. There must be at least one group.

iamActionDefinition_roles :: Lens' IamActionDefinition (Maybe (NonEmpty Text)) Source #

A list of roles to be attached. There must be at least one role.

iamActionDefinition_users :: Lens' IamActionDefinition (Maybe (NonEmpty Text)) Source #

A list of users to be attached. There must be at least one user.

iamActionDefinition_policyArn :: Lens' IamActionDefinition Text Source #

The Amazon Resource Name (ARN) of the policy to be attached.

Notification

notification_notificationState :: Lens' Notification (Maybe NotificationState) Source #

Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

notification_thresholdType :: Lens' Notification (Maybe ThresholdType) Source #

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.

notification_notificationType :: Lens' Notification NotificationType Source #

Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

notification_comparisonOperator :: Lens' Notification ComparisonOperator Source #

The comparison that's used for this notification.

notification_threshold :: Lens' Notification Double Source #

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

notificationWithSubscribers_notification :: Lens' NotificationWithSubscribers Notification Source #

The notification that's associated with a budget.

notificationWithSubscribers_subscribers :: Lens' NotificationWithSubscribers (NonEmpty Subscriber) Source #

A list of subscribers who are subscribed to this notification.

ScpActionDefinition

scpActionDefinition_policyId :: Lens' ScpActionDefinition Text Source #

The policy ID attached.

scpActionDefinition_targetIds :: Lens' ScpActionDefinition (NonEmpty Text) Source #

A list of target IDs.

Spend

spend_amount :: Lens' Spend Text Source #

The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

spend_unit :: Lens' Spend Text Source #

The unit of measurement that's used for the budget forecast, actual spend, or budget threshold, such as USD or GBP.

SsmActionDefinition

ssmActionDefinition_actionSubType :: Lens' SsmActionDefinition ActionSubType Source #

The action subType.

ssmActionDefinition_region :: Lens' SsmActionDefinition Text Source #

The Region to run the SSM document.

ssmActionDefinition_instanceIds :: Lens' SsmActionDefinition (NonEmpty Text) Source #

The EC2 and RDS instance IDs.

Subscriber

subscriber_subscriptionType :: Lens' Subscriber SubscriptionType Source #

The type of notification that Amazon Web Services sends to a subscriber.

subscriber_address :: Lens' Subscriber Text Source #

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

timePeriod_end :: Lens' TimePeriod (Maybe UTCTime) Source #

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.

timePeriod_start :: Lens' TimePeriod (Maybe UTCTime) Source #

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.