Network.AWS.CostExplorer.GetReservationCoverage

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.

Creating a Request

getReservationCoverage

Arguments

:: DateInterval

grcTimePeriod

-> GetReservationCoverage

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 * TENANCY
• grcNextPageToken - 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 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 - 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 - 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 .

data GetReservationCoverage

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

Eq GetReservationCoverage

Methods

(==) :: GetReservationCoverage -> GetReservationCoverage -> Bool

(/=) :: GetReservationCoverage -> GetReservationCoverage -> Bool

Data GetReservationCoverage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetReservationCoverage -> c GetReservationCoverage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetReservationCoverage

toConstr :: GetReservationCoverage -> Constr

dataTypeOf :: GetReservationCoverage -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetReservationCoverage)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetReservationCoverage)

gmapT :: (forall b. Data b => b -> b) -> GetReservationCoverage -> GetReservationCoverage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationCoverage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationCoverage -> r

gmapQ :: (forall d. Data d => d -> u) -> GetReservationCoverage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetReservationCoverage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetReservationCoverage -> m GetReservationCoverage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationCoverage -> m GetReservationCoverage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationCoverage -> m GetReservationCoverage

Read GetReservationCoverage

Methods

readsPrec :: Int -> ReadS GetReservationCoverage

readList :: ReadS [GetReservationCoverage]

readPrec :: ReadPrec GetReservationCoverage

readListPrec :: ReadPrec [GetReservationCoverage]

Show GetReservationCoverage

Methods

showsPrec :: Int -> GetReservationCoverage -> ShowS

show :: GetReservationCoverage -> String

showList :: [GetReservationCoverage] -> ShowS

Generic GetReservationCoverage

Associated Types

type Rep GetReservationCoverage :: * -> *

Methods

from :: GetReservationCoverage -> Rep GetReservationCoverage x

to :: Rep GetReservationCoverage x -> GetReservationCoverage

Hashable GetReservationCoverage

Methods

hashWithSalt :: Int -> GetReservationCoverage -> Int

hash :: GetReservationCoverage -> Int

ToJSON GetReservationCoverage

Methods

toJSON :: GetReservationCoverage -> Value

toEncoding :: GetReservationCoverage -> Encoding

toJSONList :: [GetReservationCoverage] -> Value

toEncodingList :: [GetReservationCoverage] -> Encoding

NFData GetReservationCoverage

Methods

rnf :: GetReservationCoverage -> ()

AWSRequest GetReservationCoverage

Associated Types

type Rs GetReservationCoverage :: *

Methods

request :: GetReservationCoverage -> Request GetReservationCoverage

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetReservationCoverage -> ClientResponse -> m (Response GetReservationCoverage)

ToHeaders GetReservationCoverage

Methods

toHeaders :: GetReservationCoverage -> [Header]

ToPath GetReservationCoverage

Methods

toPath :: GetReservationCoverage -> ByteString

ToQuery GetReservationCoverage

Methods

toQuery :: GetReservationCoverage -> QueryString

type Rep GetReservationCoverage

type Rep GetReservationCoverage = D1 * (MetaData "GetReservationCoverage" "Network.AWS.CostExplorer.GetReservationCoverage" "amazonka-cost-explorer-1.6.0-1EmcUb6qhvECvPsx1AQih6" False) (C1 * (MetaCons "GetReservationCoverage'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_grcGroupBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [GroupDefinition]))) (S1 * (MetaSel (Just Symbol "_grcNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_grcGranularity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Granularity))) ((:*:) * (S1 * (MetaSel (Just Symbol "_grcFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Expression))) (S1 * (MetaSel (Just Symbol "_grcTimePeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * DateInterval))))))

type Rs GetReservationCoverage

type Rs GetReservationCoverage = GetReservationCoverageResponse

Request Lenses

grcGroupBy :: Lens' GetReservationCoverage [GroupDefinition]

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)

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)

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)

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

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

Arguments

:: Int

grcrsResponseStatus

-> GetReservationCoverageResponse

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

See: getReservationCoverageResponse smart constructor.

Instances

Eq GetReservationCoverageResponse

Methods

(==) :: GetReservationCoverageResponse -> GetReservationCoverageResponse -> Bool

(/=) :: GetReservationCoverageResponse -> GetReservationCoverageResponse -> Bool

Data GetReservationCoverageResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetReservationCoverageResponse -> c GetReservationCoverageResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetReservationCoverageResponse

toConstr :: GetReservationCoverageResponse -> Constr

dataTypeOf :: GetReservationCoverageResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetReservationCoverageResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetReservationCoverageResponse)

gmapT :: (forall b. Data b => b -> b) -> GetReservationCoverageResponse -> GetReservationCoverageResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationCoverageResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationCoverageResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetReservationCoverageResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetReservationCoverageResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetReservationCoverageResponse -> m GetReservationCoverageResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationCoverageResponse -> m GetReservationCoverageResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationCoverageResponse -> m GetReservationCoverageResponse

Read GetReservationCoverageResponse

Methods

readsPrec :: Int -> ReadS GetReservationCoverageResponse

readList :: ReadS [GetReservationCoverageResponse]

readPrec :: ReadPrec GetReservationCoverageResponse

readListPrec :: ReadPrec [GetReservationCoverageResponse]

Show GetReservationCoverageResponse

Methods

showsPrec :: Int -> GetReservationCoverageResponse -> ShowS

show :: GetReservationCoverageResponse -> String

showList :: [GetReservationCoverageResponse] -> ShowS

Generic GetReservationCoverageResponse

Associated Types

type Rep GetReservationCoverageResponse :: * -> *

Methods

from :: GetReservationCoverageResponse -> Rep GetReservationCoverageResponse x

to :: Rep GetReservationCoverageResponse x -> GetReservationCoverageResponse

NFData GetReservationCoverageResponse

Methods

rnf :: GetReservationCoverageResponse -> ()

type Rep GetReservationCoverageResponse

type Rep GetReservationCoverageResponse = D1 * (MetaData "GetReservationCoverageResponse" "Network.AWS.CostExplorer.GetReservationCoverage" "amazonka-cost-explorer-1.6.0-1EmcUb6qhvECvPsx1AQih6" False) (C1 * (MetaCons "GetReservationCoverageResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_grcrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_grcrsTotal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Coverage)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_grcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_grcrsCoveragesByTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [CoverageByTime])))))

Response Lenses

grcrsNextPageToken :: Lens' GetReservationCoverageResponse (Maybe Text)

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)

The total amount of instance usage that is covered by a reservation.

grcrsResponseStatus :: Lens' GetReservationCoverageResponse Int

• - | The response status code.

grcrsCoveragesByTime :: Lens' GetReservationCoverageResponse [CoverageByTime]

The amount of time that your reservations covered.