Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
All public APIs for AWS Budgets
- 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
- module Network.AWS.Budgets.DescribeSubscribersForNotification
- module Network.AWS.Budgets.DescribeNotificationsForBudget
- module Network.AWS.Budgets.DescribeBudgets
- module Network.AWS.Budgets.CreateSubscriber
- module Network.AWS.Budgets.UpdateBudget
- module Network.AWS.Budgets.DeleteBudget
- module Network.AWS.Budgets.DeleteNotification
- module Network.AWS.Budgets.UpdateNotification
- module Network.AWS.Budgets.DescribeBudget
- module Network.AWS.Budgets.UpdateSubscriber
- module Network.AWS.Budgets.DeleteSubscriber
- module Network.AWS.Budgets.CreateBudget
- module Network.AWS.Budgets.CreateNotification
- data BudgetType
- data ComparisonOperator
- data NotificationType
- = Actual
- | Forecasted
- data SubscriptionType
- data TimeUnit
- data Budget
- budget :: Text -> Spend -> CostTypes -> TimeUnit -> TimePeriod -> BudgetType -> Budget
- bCalculatedSpend :: Lens' Budget (Maybe CalculatedSpend)
- bCostFilters :: Lens' Budget (HashMap Text [Text])
- bBudgetName :: Lens' Budget Text
- bBudgetLimit :: Lens' Budget Spend
- bCostTypes :: Lens' Budget CostTypes
- bTimeUnit :: Lens' Budget TimeUnit
- bTimePeriod :: Lens' Budget TimePeriod
- bBudgetType :: Lens' Budget BudgetType
- data CalculatedSpend
- calculatedSpend :: Spend -> CalculatedSpend
- csForecastedSpend :: Lens' CalculatedSpend (Maybe Spend)
- csActualSpend :: Lens' CalculatedSpend Spend
- data CostTypes
- costTypes :: Bool -> Bool -> Bool -> CostTypes
- ctIncludeTax :: Lens' CostTypes Bool
- ctIncludeSubscription :: Lens' CostTypes Bool
- ctUseBlended :: Lens' CostTypes Bool
- data Notification
- notification :: NotificationType -> ComparisonOperator -> Double -> Notification
- 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 :: UTCTime -> UTCTime -> TimePeriod
- tpStart :: Lens' TimePeriod UTCTime
- tpEnd :: Lens' TimePeriod UTCTime
Service 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
.
InvalidParameterException
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
InternalErrorException
_InternalErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown on an unknown internal failure.
ExpiredNextTokenException
_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if the paging token is expired - past its TTL
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request
DuplicateRecordException
_DuplicateRecordException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The exception is thrown when customer tries to create a record (e.g. budget) that already exists.
CreationLimitExceededException
_CreationLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.
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.
DescribeSubscribersForNotification
DescribeNotificationsForBudget
DescribeBudgets
CreateSubscriber
UpdateBudget
DeleteBudget
DeleteNotification
UpdateNotification
DescribeBudget
UpdateSubscriber
DeleteSubscriber
CreateBudget
CreateNotification
Types
BudgetType
data BudgetType Source #
The type of a budget. Can be COST or USAGE.
ComparisonOperator
data ComparisonOperator Source #
The comparison operator of a notification. Currently we support less than, equal to and greater than.
NotificationType
data NotificationType Source #
The type of a notification. It should be ACTUAL or FORECASTED.
SubscriptionType
data SubscriptionType Source #
The subscription type of the subscriber. It can be SMS or EMAIL.
TimeUnit
The time unit of the budget. e.g. weekly, monthly, etc.
Budget
AWS Budget model
See: budget
smart constructor.
:: Text | |
-> Spend | |
-> CostTypes | |
-> TimeUnit | |
-> TimePeriod | |
-> BudgetType | |
-> Budget |
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
- Undocumented member.bCostFilters
- Undocumented member.bBudgetName
- Undocumented member.bBudgetLimit
- Undocumented member.bCostTypes
- Undocumented member.bTimeUnit
- Undocumented member.bTimePeriod
- Undocumented member.bBudgetType
- Undocumented member.
bCalculatedSpend :: Lens' Budget (Maybe CalculatedSpend) Source #
Undocumented member.
bTimePeriod :: Lens' Budget TimePeriod Source #
Undocumented member.
bBudgetType :: Lens' Budget BudgetType Source #
Undocumented member.
CalculatedSpend
data CalculatedSpend Source #
A structure holds the actual and forecasted spend for a budget.
See: calculatedSpend
smart constructor.
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
- Undocumented member.csActualSpend
- Undocumented member.
csForecastedSpend :: Lens' CalculatedSpend (Maybe Spend) Source #
Undocumented member.
csActualSpend :: Lens' CalculatedSpend Spend Source #
Undocumented member.
CostTypes
This includes the options for getting the cost of a budget.
See: costTypes
smart constructor.
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:
ctIncludeTax
- Undocumented member.ctIncludeSubscription
- Undocumented member.ctUseBlended
- Undocumented member.
Notification
data Notification Source #
Notification model. Each budget may contain multiple notifications with different settings.
See: notification
smart constructor.
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:
nNotificationType
- Undocumented member.nComparisonOperator
- Undocumented member.nThreshold
- Undocumented member.
nNotificationType :: Lens' Notification NotificationType Source #
Undocumented member.
nComparisonOperator :: Lens' Notification ComparisonOperator Source #
Undocumented member.
nThreshold :: Lens' Notification Double Source #
Undocumented member.
NotificationWithSubscribers
data NotificationWithSubscribers Source #
A structure to relate notification and a list of subscribers who belong to the notification.
See: notificationWithSubscribers
smart constructor.
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
- Undocumented member.nwsSubscribers
- Undocumented member.
nwsNotification :: Lens' NotificationWithSubscribers Notification Source #
Undocumented member.
nwsSubscribers :: Lens' NotificationWithSubscribers (NonEmpty Subscriber) Source #
Undocumented member.
Spend
A structure represent either a cost spend or usage spend. Contains an amount and a unit.
See: spend
smart constructor.
Subscriber
data Subscriber Source #
Subscriber model. Each notification may contain multiple subscribers with different addresses.
See: subscriber
smart constructor.
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
- Undocumented member.sAddress
- Undocumented member.
sSubscriptionType :: Lens' Subscriber SubscriptionType Source #
Undocumented member.
TimePeriod
data TimePeriod Source #
A time period indicated the start date and end date of a budget.
See: timePeriod
smart constructor.
:: UTCTime | |
-> UTCTime | |
-> TimePeriod |
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: