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 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- AccountScope
- Context
- Dimension
- Granularity
- GroupDefinitionType
- LookbackPeriodInDays
- OfferingClass
- PaymentOption
- TermInYears
- Coverage
- CoverageByTime
- CoverageHours
- DateInterval
- DimensionValues
- DimensionValuesWithAttributes
- EC2InstanceDetails
- EC2Specification
- Expression
- Group
- GroupDefinition
- InstanceDetails
- MetricValue
- RDSInstanceDetails
- ReservationAggregates
- ReservationCoverageGroup
- ReservationPurchaseRecommendation
- ReservationPurchaseRecommendationDetail
- ReservationPurchaseRecommendationMetadata
- ReservationPurchaseRecommendationSummary
- ReservationUtilizationGroup
- ResultByTime
- ServiceSpecification
- TagValues
- UtilizationByTime
The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing .
- costExplorer :: Service
- _BillExpirationException :: AsError a => Getting (First ServiceError) a ServiceError
- _RequestChangedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _DataUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.CostExplorer.GetReservationUtilization
- module Network.AWS.CostExplorer.GetTags
- module Network.AWS.CostExplorer.GetReservationCoverage
- module Network.AWS.CostExplorer.GetDimensionValues
- module Network.AWS.CostExplorer.GetReservationPurchaseRecommendation
- module Network.AWS.CostExplorer.GetCostAndUsage
- data AccountScope = Payer
- data Context
- data Dimension
- = DimensionAZ
- | DimensionCacheEngine
- | DimensionDatabaseEngine
- | DimensionDeploymentOption
- | DimensionInstanceType
- | DimensionInstanceTypeFamily
- | DimensionLegalEntityName
- | DimensionLinkedAccount
- | DimensionOperatingSystem
- | DimensionOperation
- | DimensionPlatform
- | DimensionPurchaseType
- | DimensionRecordType
- | DimensionRegion
- | DimensionScope
- | DimensionService
- | DimensionSubscriptionId
- | DimensionTenancy
- | DimensionUsageType
- | DimensionUsageTypeGroup
- data Granularity
- data GroupDefinitionType
- data LookbackPeriodInDays
- data OfferingClass
- data PaymentOption
- data TermInYears
- data Coverage
- coverage :: Coverage
- cCoverageHours :: Lens' Coverage (Maybe CoverageHours)
- data CoverageByTime
- coverageByTime :: CoverageByTime
- cbtGroups :: Lens' CoverageByTime [ReservationCoverageGroup]
- cbtTimePeriod :: Lens' CoverageByTime (Maybe DateInterval)
- cbtTotal :: Lens' CoverageByTime (Maybe Coverage)
- data CoverageHours
- coverageHours :: CoverageHours
- chCoverageHoursPercentage :: Lens' CoverageHours (Maybe Text)
- chOnDemandHours :: Lens' CoverageHours (Maybe Text)
- chTotalRunningHours :: Lens' CoverageHours (Maybe Text)
- chReservedHours :: Lens' CoverageHours (Maybe Text)
- data DateInterval
- dateInterval :: Text -> Text -> DateInterval
- diStart :: Lens' DateInterval Text
- diEnd :: Lens' DateInterval Text
- data DimensionValues
- dimensionValues :: DimensionValues
- dvValues :: Lens' DimensionValues [Text]
- dvKey :: Lens' DimensionValues (Maybe Dimension)
- data DimensionValuesWithAttributes
- dimensionValuesWithAttributes :: DimensionValuesWithAttributes
- dvwaValue :: Lens' DimensionValuesWithAttributes (Maybe Text)
- dvwaAttributes :: Lens' DimensionValuesWithAttributes (HashMap Text Text)
- data EC2InstanceDetails
- ec2InstanceDetails :: EC2InstanceDetails
- eidCurrentGeneration :: Lens' EC2InstanceDetails (Maybe Bool)
- eidPlatform :: Lens' EC2InstanceDetails (Maybe Text)
- eidFamily :: Lens' EC2InstanceDetails (Maybe Text)
- eidInstanceType :: Lens' EC2InstanceDetails (Maybe Text)
- eidAvailabilityZone :: Lens' EC2InstanceDetails (Maybe Text)
- eidSizeFlexEligible :: Lens' EC2InstanceDetails (Maybe Bool)
- eidTenancy :: Lens' EC2InstanceDetails (Maybe Text)
- eidRegion :: Lens' EC2InstanceDetails (Maybe Text)
- data EC2Specification
- ec2Specification :: EC2Specification
- esOfferingClass :: Lens' EC2Specification (Maybe OfferingClass)
- data Expression
- expression :: Expression
- eNot :: Lens' Expression (Maybe Expression)
- eAnd :: Lens' Expression [Expression]
- eOr :: Lens' Expression [Expression]
- eDimensions :: Lens' Expression (Maybe DimensionValues)
- eTags :: Lens' Expression (Maybe TagValues)
- data Group
- group' :: Group
- gMetrics :: Lens' Group (HashMap Text MetricValue)
- gKeys :: Lens' Group [Text]
- data GroupDefinition
- groupDefinition :: GroupDefinition
- gdKey :: Lens' GroupDefinition (Maybe Text)
- gdType :: Lens' GroupDefinition (Maybe GroupDefinitionType)
- data InstanceDetails
- instanceDetails :: InstanceDetails
- idRDSInstanceDetails :: Lens' InstanceDetails (Maybe RDSInstanceDetails)
- idEC2InstanceDetails :: Lens' InstanceDetails (Maybe EC2InstanceDetails)
- data MetricValue
- metricValue :: MetricValue
- mvAmount :: Lens' MetricValue (Maybe Text)
- mvUnit :: Lens' MetricValue (Maybe Text)
- data RDSInstanceDetails
- rdsInstanceDetails :: RDSInstanceDetails
- ridCurrentGeneration :: Lens' RDSInstanceDetails (Maybe Bool)
- ridDeploymentOption :: Lens' RDSInstanceDetails (Maybe Text)
- ridFamily :: Lens' RDSInstanceDetails (Maybe Text)
- ridInstanceType :: Lens' RDSInstanceDetails (Maybe Text)
- ridLicenseModel :: Lens' RDSInstanceDetails (Maybe Text)
- ridSizeFlexEligible :: Lens' RDSInstanceDetails (Maybe Bool)
- ridRegion :: Lens' RDSInstanceDetails (Maybe Text)
- ridDatabaseEngine :: Lens' RDSInstanceDetails (Maybe Text)
- data ReservationAggregates
- reservationAggregates :: ReservationAggregates
- raPurchasedHours :: Lens' ReservationAggregates (Maybe Text)
- raTotalActualHours :: Lens' ReservationAggregates (Maybe Text)
- raUtilizationPercentage :: Lens' ReservationAggregates (Maybe Text)
- raUnusedHours :: Lens' ReservationAggregates (Maybe Text)
- data ReservationCoverageGroup
- reservationCoverageGroup :: ReservationCoverageGroup
- rcgCoverage :: Lens' ReservationCoverageGroup (Maybe Coverage)
- rcgAttributes :: Lens' ReservationCoverageGroup (HashMap Text Text)
- data ReservationPurchaseRecommendation
- reservationPurchaseRecommendation :: ReservationPurchaseRecommendation
- rprTermInYears :: Lens' ReservationPurchaseRecommendation (Maybe TermInYears)
- rprRecommendationSummary :: Lens' ReservationPurchaseRecommendation (Maybe ReservationPurchaseRecommendationSummary)
- rprServiceSpecification :: Lens' ReservationPurchaseRecommendation (Maybe ServiceSpecification)
- rprAccountScope :: Lens' ReservationPurchaseRecommendation (Maybe AccountScope)
- rprRecommendationDetails :: Lens' ReservationPurchaseRecommendation [ReservationPurchaseRecommendationDetail]
- rprLookbackPeriodInDays :: Lens' ReservationPurchaseRecommendation (Maybe LookbackPeriodInDays)
- rprPaymentOption :: Lens' ReservationPurchaseRecommendation (Maybe PaymentOption)
- data ReservationPurchaseRecommendationDetail
- reservationPurchaseRecommendationDetail :: ReservationPurchaseRecommendationDetail
- rprdMaximumNormalizedUnitsUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdRecurringStandardMonthlyCost :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdAverageNormalizedUnitsUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdCurrencyCode :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdEstimatedMonthlySavingsPercentage :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdRecommendedNormalizedUnitsToPurchase :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdAverageUtilization :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdEstimatedMonthlySavingsAmount :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdUpfrontCost :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdMinimumNormalizedUnitsUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdEstimatedMonthlyOnDemandCost :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdRecommendedNumberOfInstancesToPurchase :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdMaximumNumberOfInstancesUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdEstimatedReservationCostForLookbackPeriod :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdInstanceDetails :: Lens' ReservationPurchaseRecommendationDetail (Maybe InstanceDetails)
- rprdAverageNumberOfInstancesUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdMinimumNumberOfInstancesUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- rprdEstimatedBreakEvenInMonths :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text)
- data ReservationPurchaseRecommendationMetadata
- reservationPurchaseRecommendationMetadata :: ReservationPurchaseRecommendationMetadata
- rprmRecommendationId :: Lens' ReservationPurchaseRecommendationMetadata (Maybe Text)
- rprmGenerationTimestamp :: Lens' ReservationPurchaseRecommendationMetadata (Maybe Text)
- data ReservationPurchaseRecommendationSummary
- reservationPurchaseRecommendationSummary :: ReservationPurchaseRecommendationSummary
- rprsCurrencyCode :: Lens' ReservationPurchaseRecommendationSummary (Maybe Text)
- rprsTotalEstimatedMonthlySavingsPercentage :: Lens' ReservationPurchaseRecommendationSummary (Maybe Text)
- rprsTotalEstimatedMonthlySavingsAmount :: Lens' ReservationPurchaseRecommendationSummary (Maybe Text)
- data ReservationUtilizationGroup
- reservationUtilizationGroup :: ReservationUtilizationGroup
- rugValue :: Lens' ReservationUtilizationGroup (Maybe Text)
- rugKey :: Lens' ReservationUtilizationGroup (Maybe Text)
- rugAttributes :: Lens' ReservationUtilizationGroup (HashMap Text Text)
- rugUtilization :: Lens' ReservationUtilizationGroup (Maybe ReservationAggregates)
- data ResultByTime
- resultByTime :: ResultByTime
- rbtGroups :: Lens' ResultByTime [Group]
- rbtTimePeriod :: Lens' ResultByTime (Maybe DateInterval)
- rbtTotal :: Lens' ResultByTime (HashMap Text MetricValue)
- rbtEstimated :: Lens' ResultByTime (Maybe Bool)
- data ServiceSpecification
- serviceSpecification :: ServiceSpecification
- ssEC2Specification :: Lens' ServiceSpecification (Maybe EC2Specification)
- data TagValues
- tagValues :: TagValues
- tvValues :: Lens' TagValues [Text]
- tvKey :: Lens' TagValues (Maybe Text)
- data UtilizationByTime
- utilizationByTime :: UtilizationByTime
- ubtGroups :: Lens' UtilizationByTime [ReservationUtilizationGroup]
- ubtTimePeriod :: Lens' UtilizationByTime (Maybe DateInterval)
- ubtTotal :: Lens' UtilizationByTime (Maybe ReservationAggregates)
Service Configuration
costExplorer :: Service Source #
API version 2017-10-25
of the Amazon Cost Explorer Service 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 CostExplorer
.
BillExpirationException
_BillExpirationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested report expired. Update the date interval and try again.
RequestChangedException
_RequestChangedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The pagination token is invalid. Try again without a pagination token.
DataUnavailableException
_DataUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested data is unavailable.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You made too many calls in a short period of time. Try again later.
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.
GetReservationUtilization
GetTags
GetReservationCoverage
GetDimensionValues
GetReservationPurchaseRecommendation
GetCostAndUsage
Types
AccountScope
data AccountScope Source #
Context
Dimension
Granularity
data Granularity Source #
GroupDefinitionType
data GroupDefinitionType Source #
LookbackPeriodInDays
data LookbackPeriodInDays Source #
OfferingClass
data OfferingClass Source #
PaymentOption
data PaymentOption Source #
TermInYears
data TermInYears Source #
Coverage
The amount of instance usage that a reservation covered.
See: coverage
smart constructor.
Creates a value of Coverage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cCoverageHours
- The amount of instance usage that a reservation covered, in hours.
cCoverageHours :: Lens' Coverage (Maybe CoverageHours) Source #
The amount of instance usage that a reservation covered, in hours.
CoverageByTime
data CoverageByTime Source #
Reservation coverage for a specified period, in hours.
See: coverageByTime
smart constructor.
coverageByTime :: CoverageByTime Source #
Creates a value of CoverageByTime
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cbtGroups
- The groups of instances that are covered by a reservation.cbtTimePeriod
- The period over which this coverage was used.cbtTotal
- The total reservation coverage, in hours.
cbtGroups :: Lens' CoverageByTime [ReservationCoverageGroup] Source #
The groups of instances that are covered by a reservation.
cbtTimePeriod :: Lens' CoverageByTime (Maybe DateInterval) Source #
The period over which this coverage was used.
CoverageHours
data CoverageHours Source #
How long a running instance either used a reservation or was On-Demand.
See: coverageHours
smart constructor.
coverageHours :: CoverageHours Source #
Creates a value of CoverageHours
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
chCoverageHoursPercentage
- The percentage of instance hours that are covered by a reservation.chOnDemandHours
- The number of instance running hours that are covered by On-Demand Instances.chTotalRunningHours
- The total instance usage, in hours.chReservedHours
- The number of instance running hours that are covered by reservations.
chCoverageHoursPercentage :: Lens' CoverageHours (Maybe Text) Source #
The percentage of instance hours that are covered by a reservation.
chOnDemandHours :: Lens' CoverageHours (Maybe Text) Source #
The number of instance running hours that are covered by On-Demand Instances.
chTotalRunningHours :: Lens' CoverageHours (Maybe Text) Source #
The total instance usage, in hours.
chReservedHours :: Lens' CoverageHours (Maybe Text) Source #
The number of instance running hours that are covered by reservations.
DateInterval
data DateInterval Source #
The time period that you want the usage and costs for.
See: dateInterval
smart constructor.
:: Text | |
-> Text | |
-> DateInterval |
Creates a value of DateInterval
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
diStart
- The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, ifstart
is2017-01-01
, AWS retrieves cost and usage data starting at2017-01-01
up to the end date.diEnd
- The end of the time period that you want the usage and costs for. The end date is exclusive. For example, ifend
is2017-05-01
, AWS retrieves cost and usage data from the start date up to, but not including,2017-05-01
.
diStart :: Lens' DateInterval Text Source #
The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start
is 2017-01-01
, AWS retrieves cost and usage data starting at 2017-01-01
up to the end date.
diEnd :: Lens' DateInterval Text Source #
The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end
is 2017-05-01
, AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01
.
DimensionValues
data DimensionValues Source #
The metadata that you can use to filter and group your results. You can use GetDimensionValues
to find specific values.
See: dimensionValues
smart constructor.
dimensionValues :: DimensionValues Source #
Creates a value of DimensionValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvValues :: Lens' DimensionValues [Text] Source #
The metadata values that you can use to filter and group your results. You can use GetDimensionValues
to find specific values.
dvKey :: Lens' DimensionValues (Maybe Dimension) Source #
The names of the metadata types that you can use to filter and group your results. For example, AZ
returns a list of Availability Zones.
DimensionValuesWithAttributes
data DimensionValuesWithAttributes Source #
The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues
to find specific values.
See: dimensionValuesWithAttributes
smart constructor.
dimensionValuesWithAttributes :: DimensionValuesWithAttributes Source #
Creates a value of DimensionValuesWithAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvwaValue
- The value of a dimension with a specific attribute.dvwaAttributes
- The attribute that applies to a specificDimension
.
dvwaValue :: Lens' DimensionValuesWithAttributes (Maybe Text) Source #
The value of a dimension with a specific attribute.
dvwaAttributes :: Lens' DimensionValuesWithAttributes (HashMap Text Text) Source #
The attribute that applies to a specific Dimension
.
EC2InstanceDetails
data EC2InstanceDetails Source #
Details about the EC2 instances that AWS recommends that you purchase.
See: ec2InstanceDetails
smart constructor.
ec2InstanceDetails :: EC2InstanceDetails Source #
Creates a value of EC2InstanceDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eidCurrentGeneration
- Whether the recommendation is for a current generation instance.eidPlatform
- The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.eidFamily
- The instance family of the recommended reservation.eidInstanceType
- The type of instance that AWS recommends.eidAvailabilityZone
- The Availability Zone of the recommended reservation.eidSizeFlexEligible
- Whether the recommended reservation is size flexible.eidTenancy
- Whether the recommended reservation is dedicated or shared.eidRegion
- The AWS Region of the recommended reservation.
eidCurrentGeneration :: Lens' EC2InstanceDetails (Maybe Bool) Source #
Whether the recommendation is for a current generation instance.
eidPlatform :: Lens' EC2InstanceDetails (Maybe Text) Source #
The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
eidFamily :: Lens' EC2InstanceDetails (Maybe Text) Source #
The instance family of the recommended reservation.
eidInstanceType :: Lens' EC2InstanceDetails (Maybe Text) Source #
The type of instance that AWS recommends.
eidAvailabilityZone :: Lens' EC2InstanceDetails (Maybe Text) Source #
The Availability Zone of the recommended reservation.
eidSizeFlexEligible :: Lens' EC2InstanceDetails (Maybe Bool) Source #
Whether the recommended reservation is size flexible.
eidTenancy :: Lens' EC2InstanceDetails (Maybe Text) Source #
Whether the recommended reservation is dedicated or shared.
eidRegion :: Lens' EC2InstanceDetails (Maybe Text) Source #
The AWS Region of the recommended reservation.
EC2Specification
data EC2Specification Source #
The EC2 hardware specifications that you want AWS to provide recommendations for.
See: ec2Specification
smart constructor.
ec2Specification :: EC2Specification Source #
Creates a value of EC2Specification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
esOfferingClass
- Whether you want a recommendation for standard or convertible reservations.
esOfferingClass :: Lens' EC2Specification (Maybe OfferingClass) Source #
Whether you want a recommendation for standard or convertible reservations.
Expression
data Expression Source #
Use Expression
to filter by cost or by usage. There are two patterns:
- Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for
INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large
. TheExpression
for that looks like this:
{ Dimensions: { Key: INSTANCE_TYPE, Values: [ "m4.xlarge", “c4.large” ] } }
The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression
and DimensionValues
objects using either with*
methods or set*
methods in multiple lines.
- Compound dimension values with logical operations - You can use multiple
Expression
types and the logical operatorsANDORNOT
to create a list of one or moreExpression
objects. This allows you to filter on more advanced options. For example, you can filter on((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)
. TheExpression
for that looks like this:
{ And: [ {Or: [ {Dimensions: { Key: INSTANCE_TYPE, Values: [ "m4.x.large", "c4.large" ] }}, {Tag: { Key: TagName, Values: [Value1] } } ]}, {Not: {"dimensions": { Key: USAGE_TYPE, Values: [DataTransfer] }}} ] }
{ And: [ ... ], DimensionValues: { Dimension: USAGE_TYPE, Values: [ DataTransfer ] } }
See: expression
smart constructor.
expression :: Expression Source #
Creates a value of Expression
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eNot
- Return results that don't match aDimension
object.eAnd
- Return results that match bothDimension
objects.eOr
- Return results that match eitherDimension
object.eDimensions
- The specificDimension
to use forExpression
.eTags
- The specificTag
to use forExpression
.
eNot :: Lens' Expression (Maybe Expression) Source #
Return results that don't match a Dimension
object.
eAnd :: Lens' Expression [Expression] Source #
Return results that match both Dimension
objects.
eOr :: Lens' Expression [Expression] Source #
Return results that match either Dimension
object.
eDimensions :: Lens' Expression (Maybe DimensionValues) Source #
The specific Dimension
to use for Expression
.
Group
One level of grouped data within the results.
See: group'
smart constructor.
gMetrics :: Lens' Group (HashMap Text MetricValue) Source #
The metrics that are included in this group.
GroupDefinition
data GroupDefinition Source #
Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.
See: groupDefinition
smart constructor.
groupDefinition :: GroupDefinition Source #
Creates a value of GroupDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdKey :: Lens' GroupDefinition (Maybe Text) Source #
The string that represents a key for a specified group.
gdType :: Lens' GroupDefinition (Maybe GroupDefinitionType) Source #
The string that represents the type of group.
InstanceDetails
data InstanceDetails Source #
Details about the instances that AWS recommends that you purchase.
See: instanceDetails
smart constructor.
instanceDetails :: InstanceDetails Source #
Creates a value of InstanceDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
idRDSInstanceDetails
- The RDS instances that AWS recommends that you purchase.idEC2InstanceDetails
- The EC2 instances that AWS recommends that you purchase.
idRDSInstanceDetails :: Lens' InstanceDetails (Maybe RDSInstanceDetails) Source #
The RDS instances that AWS recommends that you purchase.
idEC2InstanceDetails :: Lens' InstanceDetails (Maybe EC2InstanceDetails) Source #
The EC2 instances that AWS recommends that you purchase.
MetricValue
data MetricValue Source #
The aggregated value for a metric.
See: metricValue
smart constructor.
metricValue :: MetricValue Source #
Creates a value of MetricValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RDSInstanceDetails
data RDSInstanceDetails Source #
Details about the RDS instances that AWS recommends that you purchase.
See: rdsInstanceDetails
smart constructor.
rdsInstanceDetails :: RDSInstanceDetails Source #
Creates a value of RDSInstanceDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ridCurrentGeneration
- Whether the recommendation is for a current generation instance.ridDeploymentOption
- Whether the recommendation is for a reservation in a single availability zone or a reservation with a backup in a second availability zone.ridFamily
- The instance family of the recommended reservation.ridInstanceType
- The type of instance that AWS recommends.ridLicenseModel
- The license model that the recommended reservation supports.ridSizeFlexEligible
- Whether the recommended reservation is size flexible.ridRegion
- The AWS Region of the recommended reservation.ridDatabaseEngine
- The database engine that the recommended reservation supports.
ridCurrentGeneration :: Lens' RDSInstanceDetails (Maybe Bool) Source #
Whether the recommendation is for a current generation instance.
ridDeploymentOption :: Lens' RDSInstanceDetails (Maybe Text) Source #
Whether the recommendation is for a reservation in a single availability zone or a reservation with a backup in a second availability zone.
ridFamily :: Lens' RDSInstanceDetails (Maybe Text) Source #
The instance family of the recommended reservation.
ridInstanceType :: Lens' RDSInstanceDetails (Maybe Text) Source #
The type of instance that AWS recommends.
ridLicenseModel :: Lens' RDSInstanceDetails (Maybe Text) Source #
The license model that the recommended reservation supports.
ridSizeFlexEligible :: Lens' RDSInstanceDetails (Maybe Bool) Source #
Whether the recommended reservation is size flexible.
ridRegion :: Lens' RDSInstanceDetails (Maybe Text) Source #
The AWS Region of the recommended reservation.
ridDatabaseEngine :: Lens' RDSInstanceDetails (Maybe Text) Source #
The database engine that the recommended reservation supports.
ReservationAggregates
data ReservationAggregates Source #
The aggregated numbers for your RI usage.
See: reservationAggregates
smart constructor.
reservationAggregates :: ReservationAggregates Source #
Creates a value of ReservationAggregates
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raPurchasedHours
- How many RI hours that you purchased.raTotalActualHours
- The total number of RI hours that you used.raUtilizationPercentage
- The percentage of RI time that you used.raUnusedHours
- The number of RI hours that you didn't use.
raPurchasedHours :: Lens' ReservationAggregates (Maybe Text) Source #
How many RI hours that you purchased.
raTotalActualHours :: Lens' ReservationAggregates (Maybe Text) Source #
The total number of RI hours that you used.
raUtilizationPercentage :: Lens' ReservationAggregates (Maybe Text) Source #
The percentage of RI time that you used.
raUnusedHours :: Lens' ReservationAggregates (Maybe Text) Source #
The number of RI hours that you didn't use.
ReservationCoverageGroup
data ReservationCoverageGroup Source #
A group of reservations that share a set of attributes.
See: reservationCoverageGroup
smart constructor.
reservationCoverageGroup :: ReservationCoverageGroup Source #
Creates a value of ReservationCoverageGroup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcgCoverage
- How much instance usage this group of reservations covered.rcgAttributes
- The attributes for this group of reservations.
rcgCoverage :: Lens' ReservationCoverageGroup (Maybe Coverage) Source #
How much instance usage this group of reservations covered.
rcgAttributes :: Lens' ReservationCoverageGroup (HashMap Text Text) Source #
The attributes for this group of reservations.
ReservationPurchaseRecommendation
data ReservationPurchaseRecommendation Source #
A specific reservation that AWS recommends for purchase.
See: reservationPurchaseRecommendation
smart constructor.
reservationPurchaseRecommendation :: ReservationPurchaseRecommendation Source #
Creates a value of ReservationPurchaseRecommendation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rprTermInYears
- The term of the reservation that you want recommendations for, in years.rprRecommendationSummary
- A summary about the recommended purchase.rprServiceSpecification
- Hardware specifications for the service that you want recommendations for.rprAccountScope
- The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.rprRecommendationDetails
- Details about the recommended purchases.rprLookbackPeriodInDays
- How many days of previous usage that AWS takes into consideration when making this recommendation.rprPaymentOption
- The payment option for the reservation. For example,AllUpfront
orNoUpfront
.
rprTermInYears :: Lens' ReservationPurchaseRecommendation (Maybe TermInYears) Source #
The term of the reservation that you want recommendations for, in years.
rprRecommendationSummary :: Lens' ReservationPurchaseRecommendation (Maybe ReservationPurchaseRecommendationSummary) Source #
A summary about the recommended purchase.
rprServiceSpecification :: Lens' ReservationPurchaseRecommendation (Maybe ServiceSpecification) Source #
Hardware specifications for the service that you want recommendations for.
rprAccountScope :: Lens' ReservationPurchaseRecommendation (Maybe AccountScope) Source #
The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.
rprRecommendationDetails :: Lens' ReservationPurchaseRecommendation [ReservationPurchaseRecommendationDetail] Source #
Details about the recommended purchases.
rprLookbackPeriodInDays :: Lens' ReservationPurchaseRecommendation (Maybe LookbackPeriodInDays) Source #
How many days of previous usage that AWS takes into consideration when making this recommendation.
rprPaymentOption :: Lens' ReservationPurchaseRecommendation (Maybe PaymentOption) Source #
The payment option for the reservation. For example, AllUpfront
or NoUpfront
.
ReservationPurchaseRecommendationDetail
data ReservationPurchaseRecommendationDetail Source #
Details about your recommended reservation purchase.
See: reservationPurchaseRecommendationDetail
smart constructor.
reservationPurchaseRecommendationDetail :: ReservationPurchaseRecommendationDetail Source #
Creates a value of ReservationPurchaseRecommendationDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rprdMaximumNormalizedUnitsUsedPerHour
- The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.rprdRecurringStandardMonthlyCost
- How much purchasing this instance costs you on a monthly basis.rprdAverageNormalizedUnitsUsedPerHour
- The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.rprdCurrencyCode
- The currency code that AWS used to calculate the costs for this instance.rprdEstimatedMonthlySavingsPercentage
- How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.rprdRecommendedNormalizedUnitsToPurchase
- The number of normalized units that AWS recommends that you purchase.rprdAverageUtilization
- The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.rprdEstimatedMonthlySavingsAmount
- How much AWS estimates that this specific recommendation could save you in a month.rprdUpfrontCost
- How much purchasing this instance costs you upfront.rprdMinimumNormalizedUnitsUsedPerHour
- The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.rprdEstimatedMonthlyOnDemandCost
- How much AWS estimates that you spend on On-Demand Instances in a month.rprdRecommendedNumberOfInstancesToPurchase
- The number of instances that AWS recommends that you purchase.rprdMaximumNumberOfInstancesUsedPerHour
- The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.rprdEstimatedReservationCostForLookbackPeriod
- How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.rprdInstanceDetails
- Details about the instances that AWS recommends that you purchase.rprdAverageNumberOfInstancesUsedPerHour
- The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.rprdMinimumNumberOfInstancesUsedPerHour
- The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.rprdEstimatedBreakEvenInMonths
- How long AWS estimates that it takes for this instance to start saving you money, in months.
rprdMaximumNormalizedUnitsUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
rprdRecurringStandardMonthlyCost :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
How much purchasing this instance costs you on a monthly basis.
rprdAverageNormalizedUnitsUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
rprdCurrencyCode :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The currency code that AWS used to calculate the costs for this instance.
rprdEstimatedMonthlySavingsPercentage :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.
rprdRecommendedNormalizedUnitsToPurchase :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The number of normalized units that AWS recommends that you purchase.
rprdAverageUtilization :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.
rprdEstimatedMonthlySavingsAmount :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
How much AWS estimates that this specific recommendation could save you in a month.
rprdUpfrontCost :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
How much purchasing this instance costs you upfront.
rprdMinimumNormalizedUnitsUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
rprdEstimatedMonthlyOnDemandCost :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
How much AWS estimates that you spend on On-Demand Instances in a month.
rprdRecommendedNumberOfInstancesToPurchase :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The number of instances that AWS recommends that you purchase.
rprdMaximumNumberOfInstancesUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
rprdEstimatedReservationCostForLookbackPeriod :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.
rprdInstanceDetails :: Lens' ReservationPurchaseRecommendationDetail (Maybe InstanceDetails) Source #
Details about the instances that AWS recommends that you purchase.
rprdAverageNumberOfInstancesUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
rprdMinimumNumberOfInstancesUsedPerHour :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.
rprdEstimatedBreakEvenInMonths :: Lens' ReservationPurchaseRecommendationDetail (Maybe Text) Source #
How long AWS estimates that it takes for this instance to start saving you money, in months.
ReservationPurchaseRecommendationMetadata
data ReservationPurchaseRecommendationMetadata Source #
Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.
See: reservationPurchaseRecommendationMetadata
smart constructor.
reservationPurchaseRecommendationMetadata :: ReservationPurchaseRecommendationMetadata Source #
Creates a value of ReservationPurchaseRecommendationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rprmRecommendationId
- The ID for this specific recommendation.rprmGenerationTimestamp
- The time stamp for when AWS made this recommendation.
rprmRecommendationId :: Lens' ReservationPurchaseRecommendationMetadata (Maybe Text) Source #
The ID for this specific recommendation.
rprmGenerationTimestamp :: Lens' ReservationPurchaseRecommendationMetadata (Maybe Text) Source #
The time stamp for when AWS made this recommendation.
ReservationPurchaseRecommendationSummary
data ReservationPurchaseRecommendationSummary Source #
A summary about this recommendation, such as the currency code, the amount that AWS estimates you could save, and the total amount of reservation to purchase.
See: reservationPurchaseRecommendationSummary
smart constructor.
reservationPurchaseRecommendationSummary :: ReservationPurchaseRecommendationSummary Source #
Creates a value of ReservationPurchaseRecommendationSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rprsCurrencyCode
- The currency code used for this recommendation.rprsTotalEstimatedMonthlySavingsPercentage
- The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.rprsTotalEstimatedMonthlySavingsAmount
- The total amount that AWS estimates that this recommendation could save you in a month.
rprsCurrencyCode :: Lens' ReservationPurchaseRecommendationSummary (Maybe Text) Source #
The currency code used for this recommendation.
rprsTotalEstimatedMonthlySavingsPercentage :: Lens' ReservationPurchaseRecommendationSummary (Maybe Text) Source #
The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.
rprsTotalEstimatedMonthlySavingsAmount :: Lens' ReservationPurchaseRecommendationSummary (Maybe Text) Source #
The total amount that AWS estimates that this recommendation could save you in a month.
ReservationUtilizationGroup
data ReservationUtilizationGroup Source #
A group of RIs that share a set of attributes.
See: reservationUtilizationGroup
smart constructor.
reservationUtilizationGroup :: ReservationUtilizationGroup Source #
Creates a value of ReservationUtilizationGroup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rugValue
- The value of a specific RI attribute.rugKey
- The key for a specific RI attribute.rugAttributes
- The attributes for this group of RIs.rugUtilization
- How much you used this group of RIs.
rugValue :: Lens' ReservationUtilizationGroup (Maybe Text) Source #
The value of a specific RI attribute.
rugKey :: Lens' ReservationUtilizationGroup (Maybe Text) Source #
The key for a specific RI attribute.
rugAttributes :: Lens' ReservationUtilizationGroup (HashMap Text Text) Source #
The attributes for this group of RIs.
rugUtilization :: Lens' ReservationUtilizationGroup (Maybe ReservationAggregates) Source #
How much you used this group of RIs.
ResultByTime
data ResultByTime Source #
The result that is associated with a time period.
See: resultByTime
smart constructor.
resultByTime :: ResultByTime Source #
Creates a value of ResultByTime
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rbtGroups
- The groups that are included in this time period.rbtTimePeriod
- The time period covered by a result.rbtTotal
- The total amount of cost or usage accrued during the time period.rbtEstimated
- Whether this result is estimated.
rbtTimePeriod :: Lens' ResultByTime (Maybe DateInterval) Source #
The time period covered by a result.
rbtTotal :: Lens' ResultByTime (HashMap Text MetricValue) Source #
The total amount of cost or usage accrued during the time period.
rbtEstimated :: Lens' ResultByTime (Maybe Bool) Source #
Whether this result is estimated.
ServiceSpecification
data ServiceSpecification Source #
Hardware specifications for the service that you want recommendations for.
See: serviceSpecification
smart constructor.
serviceSpecification :: ServiceSpecification Source #
Creates a value of ServiceSpecification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssEC2Specification
- The EC2 hardware specifications that you want AWS to provide recommendations for.
ssEC2Specification :: Lens' ServiceSpecification (Maybe EC2Specification) Source #
The EC2 hardware specifications that you want AWS to provide recommendations for.
TagValues
The values that are available for a tag.
See: tagValues
smart constructor.
UtilizationByTime
data UtilizationByTime Source #
The amount of utilization, in hours.
See: utilizationByTime
smart constructor.
utilizationByTime :: UtilizationByTime Source #
Creates a value of UtilizationByTime
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ubtGroups
- The groups that are included in this utilization result.ubtTimePeriod
- The period of time over which this utilization was used.ubtTotal
- The total number of RI hours that were used.
ubtGroups :: Lens' UtilizationByTime [ReservationUtilizationGroup] Source #
The groups that are included in this utilization result.
ubtTimePeriod :: Lens' UtilizationByTime (Maybe DateInterval) Source #
The period of time over which this utilization was used.
ubtTotal :: Lens' UtilizationByTime (Maybe ReservationAggregates) Source #
The total number of RI hours that were used.