Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Synopsis
- budgets :: Service
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateRecordException :: AsError a => Getting (First ServiceError) a ServiceError
- _CreationLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data BudgetType
- = Cost
- | RiCoverage
- | RiUtilization
- | Usage
- data ComparisonOperator
- data NotificationType
- = Actual
- | Forecasted
- data SubscriptionType
- data ThresholdType
- data TimeUnit
- data Budget
- budget :: Text -> TimeUnit -> BudgetType -> Budget
- bCalculatedSpend :: Lens' Budget (Maybe CalculatedSpend)
- bBudgetLimit :: Lens' Budget (Maybe Spend)
- bTimePeriod :: Lens' Budget (Maybe TimePeriod)
- bCostTypes :: Lens' Budget (Maybe CostTypes)
- bCostFilters :: Lens' Budget (HashMap Text [Text])
- bBudgetName :: Lens' Budget Text
- bTimeUnit :: Lens' Budget TimeUnit
- bBudgetType :: Lens' Budget BudgetType
- data CalculatedSpend
- calculatedSpend :: Spend -> CalculatedSpend
- csForecastedSpend :: Lens' CalculatedSpend (Maybe Spend)
- csActualSpend :: Lens' CalculatedSpend Spend
- data CostTypes
- costTypes :: CostTypes
- ctUseAmortized :: Lens' CostTypes (Maybe Bool)
- ctIncludeRecurring :: Lens' CostTypes (Maybe Bool)
- ctUseBlended :: Lens' CostTypes (Maybe Bool)
- ctIncludeSupport :: Lens' CostTypes (Maybe Bool)
- ctIncludeDiscount :: Lens' CostTypes (Maybe Bool)
- ctIncludeSubscription :: Lens' CostTypes (Maybe Bool)
- ctIncludeRefund :: Lens' CostTypes (Maybe Bool)
- ctIncludeUpfront :: Lens' CostTypes (Maybe Bool)
- ctIncludeOtherSubscription :: Lens' CostTypes (Maybe Bool)
- ctIncludeTax :: Lens' CostTypes (Maybe Bool)
- ctIncludeCredit :: Lens' CostTypes (Maybe Bool)
- data Notification
- notification :: NotificationType -> ComparisonOperator -> Double -> Notification
- nThresholdType :: Lens' Notification (Maybe ThresholdType)
- nNotificationType :: Lens' Notification NotificationType
- nComparisonOperator :: Lens' Notification ComparisonOperator
- nThreshold :: Lens' Notification Double
- data NotificationWithSubscribers
- notificationWithSubscribers :: Notification -> NonEmpty Subscriber -> NotificationWithSubscribers
- nwsNotification :: Lens' NotificationWithSubscribers Notification
- nwsSubscribers :: Lens' NotificationWithSubscribers (NonEmpty Subscriber)
- data Spend
- spend :: Text -> Text -> Spend
- sAmount :: Lens' Spend Text
- sUnit :: Lens' Spend Text
- data Subscriber
- subscriber :: SubscriptionType -> Text -> Subscriber
- sSubscriptionType :: Lens' Subscriber SubscriptionType
- sAddress :: Lens' Subscriber Text
- data TimePeriod
- timePeriod :: TimePeriod
- tpStart :: Lens' TimePeriod (Maybe UTCTime)
- tpEnd :: Lens' TimePeriod (Maybe UTCTime)
Service Configuration
Errors
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error on the client occurred. Typically, the cause is an invalid input value.
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error on the server occurred during the processing of your request. Try again later.
_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pagination token expired.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can’t locate the resource that you specified.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pagination token is invalid.
_DuplicateRecordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The budget name already exists. Budget names must be unique within an account.
_CreationLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've exceeded the notification or subscriber limit.
BudgetType
data BudgetType Source #
The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.
Instances
ComparisonOperator
data ComparisonOperator Source #
The comparison operator of a notification. Currently we support less than, equal to and greater than.
Instances
NotificationType
data NotificationType Source #
The type of a notification. It should be ACTUAL or FORECASTED.
Instances
SubscriptionType
data SubscriptionType Source #
The subscription type of the subscriber. It can be SMS or EMAIL.
Instances
ThresholdType
data ThresholdType Source #
The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.
Instances
TimeUnit
The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.
Instances
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
.
The ARN pattern for a budget is: arn:aws:budgetservice::AccountId:budget/budgetName
See: budget
smart constructor.
Instances
Creates a value of Budget
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bCalculatedSpend
- The actual and forecasted cost or usage being tracked by a budget.bBudgetLimit
- The total amount of cost, usage, or RI utilization that you want to track with your budget.BudgetLimit
is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is100
.bTimePeriod
- The period of time covered by a budget. 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. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, choseDAILY
, and didn't set a start date, AWS set your start date to012418 00:00 UTC
. If you choseMONTHLY
, AWS set your start date to010118 00:00 UTC
. If you didn't specify an end date, AWS set your end date to061587 00:00 UTC
. The defaults are the same for the AWS Billing and Cost Management console and the API. You can change either date with theUpdateBudget
operation. After the end date, AWS deletes the budget and all associated notifications and subscribers.bCostTypes
- The types of costs included in this budget.bCostFilters
- The cost filters applied to a budget, such as service or region.bBudgetName
- The name of a budget. Unique within accounts.:
and@ characters are not allowed in the
BudgetName@ .bTimeUnit
- The length of time until a budget resets the actual and forecasted spend.bBudgetType
- Whether this budget tracks monetary costs, usage, or RI utilization.
bCalculatedSpend :: Lens' Budget (Maybe CalculatedSpend) Source #
The actual and forecasted cost or usage being tracked by a budget.
bBudgetLimit :: Lens' Budget (Maybe Spend) Source #
The total amount of cost, usage, or RI utilization that you want to track with your budget. BudgetLimit
is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is 100
.
bTimePeriod :: Lens' Budget (Maybe TimePeriod) Source #
The period of time covered by a budget. 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. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY
, and didn't set a start date, AWS set your start date to 012418 00:00 UTC
. If you chose MONTHLY
, AWS set your start date to 010118 00:00 UTC
. If you didn't specify an end date, AWS set your end date to 061587 00:00 UTC
. The defaults are the same for the AWS Billing and Cost Management console and the API. You can change either date with the UpdateBudget
operation. After the end date, AWS deletes the budget and all associated notifications and subscribers.
bCostFilters :: Lens' Budget (HashMap Text [Text]) Source #
The cost filters applied to a budget, such as service or region.
bBudgetName :: Lens' Budget Text Source #
The name of a budget. Unique within accounts. :
and @ characters are not allowed in the
BudgetName@ .
bTimeUnit :: Lens' Budget TimeUnit Source #
The length of time until a budget resets the actual and forecasted spend.
bBudgetType :: Lens' Budget BudgetType Source #
Whether this budget tracks monetary costs, usage, or RI utilization.
CalculatedSpend
data CalculatedSpend Source #
The spend objects associated with this budget. The actualSpend
tracks how much you've used, cost, usage, or RI units, and the forecastedSpend
tracks how much you are predicted to spend if your current usage remains steady.
For example, if it is the 20th of the month and you have spent 50
dollars on Amazon EC2, your actualSpend
is 50 USD
, and your forecastedSpend
is 75 USD
.
See: calculatedSpend
smart constructor.
Instances
Creates a value of CalculatedSpend
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csForecastedSpend
- The amount of cost, usage, or RI units that you are forecasted to use.csActualSpend
- The amount of cost, usage, or RI units that you have used.
csForecastedSpend :: Lens' CalculatedSpend (Maybe Spend) Source #
The amount of cost, usage, or RI units that you are forecasted to use.
csActualSpend :: Lens' CalculatedSpend Spend Source #
The amount of cost, usage, or RI units that you have used.
CostTypes
The types of cost included in a budget, such as tax and subscriptions.
See: costTypes
smart constructor.
Instances
costTypes :: CostTypes Source #
Creates a value of CostTypes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ctUseAmortized
- Specifies whether a budget uses the amortized rate. The default value isfalse
.ctIncludeRecurring
- Specifies whether a budget includes recurring fees such as monthly RI fees. The default value istrue
.ctUseBlended
- Specifies whether a budget uses blended rate. The default value isfalse
.ctIncludeSupport
- Specifies whether a budget includes support subscription fees. The default value istrue
.ctIncludeDiscount
- Specifies whether a budget includes discounts. The default value istrue
.ctIncludeSubscription
- Specifies whether a budget includes subscriptions. The default value istrue
.ctIncludeRefund
- Specifies whether a budget includes refunds. The default value istrue
.ctIncludeUpfront
- Specifies whether a budget includes upfront RI costs. The default value istrue
.ctIncludeOtherSubscription
- Specifies whether a budget includes non-RI subscription costs. The default value istrue
.ctIncludeTax
- Specifies whether a budget includes taxes. The default value istrue
.ctIncludeCredit
- Specifies whether a budget includes credits. The default value istrue
.
ctUseAmortized :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget uses the amortized rate. The default value is false
.
ctIncludeRecurring :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes recurring fees such as monthly RI fees. The default value is true
.
ctUseBlended :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget uses blended rate. The default value is false
.
ctIncludeSupport :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes support subscription fees. The default value is true
.
ctIncludeDiscount :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes discounts. The default value is true
.
ctIncludeSubscription :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes subscriptions. The default value is true
.
ctIncludeRefund :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes refunds. The default value is true
.
ctIncludeUpfront :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes upfront RI costs. The default value is true
.
ctIncludeOtherSubscription :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes non-RI subscription costs. The default value is true
.
ctIncludeTax :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes taxes. The default value is true
.
ctIncludeCredit :: Lens' CostTypes (Maybe Bool) Source #
Specifies whether a budget includes credits. The default value is true
.
Notification
data Notification Source #
A notification associated with a budget. A budget can have up to five notifications.
Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to ten 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 comparisonOperator of
GREATER_THAN
- A notification threshold of
80
See: notification
smart constructor.
Instances
Creates a value of Notification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nThresholdType
- The type of threshold for a notification. ForACTUAL
thresholds, AWS notifies you when you go over the threshold, and forFORECASTED
thresholds AWS notifies you when you are forecasted to go over the threshold.nNotificationType
- Whether the notification is for how much you have spent (ACTUAL
) or for how much you are forecasted to spend (FORECASTED
).nComparisonOperator
- The comparison used for this notification.nThreshold
- The threshold associated with a notification. Thresholds are always a percentage.
nThresholdType :: Lens' Notification (Maybe ThresholdType) Source #
The type of threshold for a notification. For ACTUAL
thresholds, AWS notifies you when you go over the threshold, and for FORECASTED
thresholds AWS notifies you when you are forecasted to go over the threshold.
nNotificationType :: Lens' Notification NotificationType Source #
Whether the notification is for how much you have spent (ACTUAL
) or for how much you are forecasted to spend (FORECASTED
).
nComparisonOperator :: Lens' Notification ComparisonOperator Source #
The comparison used for this notification.
nThreshold :: Lens' Notification Double Source #
The threshold associated with a notification. Thresholds are always a percentage.
NotificationWithSubscribers
data NotificationWithSubscribers Source #
A notification with subscribers. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.
See: notificationWithSubscribers
smart constructor.
Instances
notificationWithSubscribers Source #
Creates a value of NotificationWithSubscribers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nwsNotification
- The notification associated with a budget.nwsSubscribers
- A list of subscribers who are subscribed to this notification.
nwsNotification :: Lens' NotificationWithSubscribers Notification Source #
The notification associated with a budget.
nwsSubscribers :: Lens' NotificationWithSubscribers (NonEmpty Subscriber) Source #
A list of subscribers who are subscribed to this notification.
Spend
The amount of cost or usage being measured for a budget.
For example, a Spend
for 3 GB
of S3 usage would have the following parameters:
- An
Amount
of3
- A
unit
ofGB
See: spend
smart constructor.
Instances
Eq Spend Source # | |
Data Spend Source # | |
Defined in Network.AWS.Budgets.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Spend -> c Spend # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Spend # dataTypeOf :: Spend -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Spend) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Spend) # gmapT :: (forall b. Data b => b -> b) -> Spend -> Spend # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Spend -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Spend -> r # gmapQ :: (forall d. Data d => d -> u) -> Spend -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Spend -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Spend -> m Spend # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Spend -> m Spend # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Spend -> m Spend # | |
Read Spend Source # | |
Show Spend Source # | |
Generic Spend Source # | |
Hashable Spend Source # | |
Defined in Network.AWS.Budgets.Types.Product | |
ToJSON Spend Source # | |
Defined in Network.AWS.Budgets.Types.Product | |
FromJSON Spend Source # | |
NFData Spend Source # | |
Defined in Network.AWS.Budgets.Types.Product | |
type Rep Spend Source # | |
Defined in Network.AWS.Budgets.Types.Product type Rep Spend = D1 (MetaData "Spend" "Network.AWS.Budgets.Types.Product" "amazonka-budgets-1.6.1-EaVNVCh4SNz6bhjSdjYIRa" False) (C1 (MetaCons "Spend'" PrefixI True) (S1 (MetaSel (Just "_sAmount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sUnit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) |
Creates a value of Spend
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sAmount :: Lens' Spend Text Source #
The cost or usage amount associated with a budget forecast, actual spend, or budget threshold.
sUnit :: Lens' Spend Text Source #
The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.
Subscriber
data Subscriber Source #
The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon Simple Notification Service topic or an email address.
For example, an email subscriber would have the following parameters:
- A
subscriptionType
ofEMAIL
- An
address
ofexample
example.com@
See: subscriber
smart constructor.
Instances
Creates a value of Subscriber
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sSubscriptionType
- The type of notification that AWS sends to a subscriber.sAddress
- The address that AWS sends budget notifications to, either an SNS topic or an email.
sSubscriptionType :: Lens' Subscriber SubscriptionType Source #
The type of notification that AWS sends to a subscriber.
sAddress :: Lens' Subscriber Text Source #
The address that AWS sends budget notifications to, either an SNS topic or an email.
TimePeriod
data TimePeriod Source #
The period of time covered by a budget. 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: timePeriod
smart constructor.
Instances
timePeriod :: TimePeriod Source #
Creates a value of TimePeriod
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpStart
- The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, choseDAILY
, and didn't set a start date, AWS set your start date to012418 00:00 UTC
. If you choseMONTHLY
, AWS set your start date to010118 00:00 UTC
. The defaults are the same for the AWS Billing and Cost Management console and the API. You can change your start date with theUpdateBudget
operation.tpEnd
- The end date for a budget. If you didn't specify an end date, AWS set your end date to061587 00:00 UTC
. The defaults are the same for the AWS Billing and Cost Management console and the API. After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with theUpdateBudget
operation.
tpStart :: Lens' TimePeriod (Maybe UTCTime) Source #
The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose DAILY
, and didn't set a start date, AWS set your start date to 012418 00:00 UTC
. If you chose MONTHLY
, AWS set your start date to 010118 00:00 UTC
. The defaults are the same for the AWS Billing and Cost Management console and the API. You can change your start date with the UpdateBudget
operation.
tpEnd :: Lens' TimePeriod (Maybe UTCTime) Source #
The end date for a budget. If you didn't specify an end date, AWS set your end date to 061587 00:00 UTC
. The defaults are the same for the AWS Billing and Cost Management console and the API. After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget
operation.