| 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 |
Network.AWS.Budgets.Types
Contents
Description
- 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
- 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
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown on an unknown internal failure.
_ExpiredNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if the paging token is expired - past its TTL
_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 :: 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 :: 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 :: 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.
BudgetType
data BudgetType Source #
The type of a budget. Can be COST or USAGE.
Instances
ComparisonOperator
data ComparisonOperator Source #
The comparison operator of a notification. Currently we support less than, equal to and greater than.
Constructors
| EqualTo | |
| GreaterThan | |
| LessThan |
Instances
NotificationType
data NotificationType Source #
The type of a notification. It should be ACTUAL or FORECASTED.
Constructors
| Actual | |
| Forecasted |
Instances
SubscriptionType
data SubscriptionType Source #
The subscription type of the subscriber. It can be SMS or EMAIL.
Instances
TimeUnit
The time unit of the budget. e.g. weekly, monthly, etc.
Instances
Budget
AWS Budget model
See: budget smart constructor.
Arguments
| :: 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.
Instances
Arguments
| :: Spend | |
| -> CalculatedSpend |
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.
Arguments
| :: NotificationType | |
| -> ComparisonOperator | |
| -> Double | |
| -> Notification |
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.
Instances
notificationWithSubscribers Source #
Arguments
| :: Notification | |
| -> NonEmpty Subscriber | |
| -> NotificationWithSubscribers |
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.
Arguments
| :: SubscriptionType | |
| -> Text | |
| -> Subscriber |
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.
Arguments
| :: 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: