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 |
Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:
- AZ
- CACHE_ENGINE
- DATABASE_ENGINE
- DEPLOYMENT_OPTION
- INSTANCE_TYPE
- LINKED_ACCOUNT
- OPERATING_SYSTEM
- PLATFORM
- REGION
- SERVICE
- TAG
- TENANCY
To determine valid values for a dimension, use the GetDimensionValues
operation.
Synopsis
- getReservationCoverage :: DateInterval -> GetReservationCoverage
- data GetReservationCoverage
- grcGroupBy :: Lens' GetReservationCoverage [GroupDefinition]
- grcNextPageToken :: Lens' GetReservationCoverage (Maybe Text)
- grcGranularity :: Lens' GetReservationCoverage (Maybe Granularity)
- grcFilter :: Lens' GetReservationCoverage (Maybe Expression)
- grcTimePeriod :: Lens' GetReservationCoverage DateInterval
- getReservationCoverageResponse :: Int -> GetReservationCoverageResponse
- data GetReservationCoverageResponse
- grcrsNextPageToken :: Lens' GetReservationCoverageResponse (Maybe Text)
- grcrsTotal :: Lens' GetReservationCoverageResponse (Maybe Coverage)
- grcrsResponseStatus :: Lens' GetReservationCoverageResponse Int
- grcrsCoveragesByTime :: Lens' GetReservationCoverageResponse [CoverageByTime]
Creating a Request
getReservationCoverage Source #
Creates a value of GetReservationCoverage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grcGroupBy
- You can group the data by the following attributes: * AZ * CACHE_ENGINE * DATABASE_ENGINE * DEPLOYMENT_OPTION * INSTANCE_TYPE * LINKED_ACCOUNT * OPERATING_SYSTEM * PLATFORM * REGION * TAG * TENANCYgrcNextPageToken
- The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.grcGranularity
- The granularity of the AWS cost data for the reservation. Valid values areMONTHLY
andDAILY
. IfGroupBy
is set,Granularity
can't be set. IfGranularity
isn't set, the response object doesn't includeGranularity
, eitherMONTHLY
orDAILY
.grcFilter
- Filters utilization data by dimensions. You can filter by the following dimensions: * AZ * CACHE_ENGINE * DATABASE_ENGINE * DEPLOYMENT_OPTION * INSTANCE_TYPE * LINKED_ACCOUNT * OPERATING_SYSTEM * PLATFORM * REGION * SERVICE * TAG * TENANCYGetReservationCoverage
uses the sameExpression
object as the other operations, but onlyAND
is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.grcTimePeriod
- The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, ifstart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.
data GetReservationCoverage Source #
You can use the following request parameters to query for how much of your instance usage is covered by a reservation.
See: getReservationCoverage
smart constructor.
Instances
Request Lenses
grcGroupBy :: Lens' GetReservationCoverage [GroupDefinition] Source #
You can group the data by the following attributes: * AZ * CACHE_ENGINE * DATABASE_ENGINE * DEPLOYMENT_OPTION * INSTANCE_TYPE * LINKED_ACCOUNT * OPERATING_SYSTEM * PLATFORM * REGION * TAG * TENANCY
grcNextPageToken :: Lens' GetReservationCoverage (Maybe Text) Source #
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
grcGranularity :: Lens' GetReservationCoverage (Maybe Granularity) Source #
The granularity of the AWS cost data for the reservation. Valid values are MONTHLY
and DAILY
. If GroupBy
is set, Granularity
can't be set. If Granularity
isn't set, the response object doesn't include Granularity
, either MONTHLY
or DAILY
.
grcFilter :: Lens' GetReservationCoverage (Maybe Expression) Source #
Filters utilization data by dimensions. You can filter by the following dimensions: * AZ * CACHE_ENGINE * DATABASE_ENGINE * DEPLOYMENT_OPTION * INSTANCE_TYPE * LINKED_ACCOUNT * OPERATING_SYSTEM * PLATFORM * REGION * SERVICE * TAG * TENANCY GetReservationCoverage
uses the same Expression
object as the other operations, but only AND
is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.
grcTimePeriod :: Lens' GetReservationCoverage DateInterval Source #
The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start
is 2017-01-01
and end
is 2017-05-01
, then the cost and usage data is retrieved from 2017-01-01
up to and including 2017-04-30
but not including 2017-05-01
.
Destructuring the Response
getReservationCoverageResponse Source #
Creates a value of GetReservationCoverageResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grcrsNextPageToken
- The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.grcrsTotal
- The total amount of instance usage that is covered by a reservation.grcrsResponseStatus
- -- | The response status code.grcrsCoveragesByTime
- The amount of time that your reservations covered.
data GetReservationCoverageResponse Source #
See: getReservationCoverageResponse
smart constructor.
Instances
Response Lenses
grcrsNextPageToken :: Lens' GetReservationCoverageResponse (Maybe Text) Source #
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
grcrsTotal :: Lens' GetReservationCoverageResponse (Maybe Coverage) Source #
The total amount of instance usage that is covered by a reservation.
grcrsResponseStatus :: Lens' GetReservationCoverageResponse Int Source #
- - | The response status code.
grcrsCoveragesByTime :: Lens' GetReservationCoverageResponse [CoverageByTime] Source #
The amount of time that your reservations covered.