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

Network.AWS.CostExplorer.GetReservationUtilization

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID .

Synopsis

Creating a Request

getReservationUtilization Source #

Arguments

:: DateInterval	`gruTimePeriod`
-> GetReservationUtilization

Creates a value of GetReservationUtilization with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gruGroupBy - Groups only by SUBSCRIPTION_ID . Metadata is included.
gruNextPageToken - 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.
gruGranularity - 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 . If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY .
gruFilter - 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 * SCOPE * TENANCY GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
gruTimePeriod - Sets the start and end dates for retrieving Reserved Instance (RI) utilization. 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 GetReservationUtilization Source #

See: getReservationUtilization smart constructor.

Instances

Eq GetReservationUtilization Source #
Methods (==) :: GetReservationUtilization -> GetReservationUtilization -> Bool # (/=) :: GetReservationUtilization -> GetReservationUtilization -> Bool #
Data GetReservationUtilization Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetReservationUtilization -> c GetReservationUtilization # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetReservationUtilization # toConstr :: GetReservationUtilization -> Constr # dataTypeOf :: GetReservationUtilization -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetReservationUtilization) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetReservationUtilization) # gmapT :: (forall b. Data b => b -> b) -> GetReservationUtilization -> GetReservationUtilization # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationUtilization -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationUtilization -> r # gmapQ :: (forall d. Data d => d -> u) -> GetReservationUtilization -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetReservationUtilization -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetReservationUtilization -> m GetReservationUtilization # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationUtilization -> m GetReservationUtilization # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationUtilization -> m GetReservationUtilization #
Read GetReservationUtilization Source #
Methods readsPrec :: Int -> ReadS GetReservationUtilization # readList :: ReadS [GetReservationUtilization] # readPrec :: ReadPrec GetReservationUtilization # readListPrec :: ReadPrec [GetReservationUtilization] #
Show GetReservationUtilization Source #
Methods showsPrec :: Int -> GetReservationUtilization -> ShowS # show :: GetReservationUtilization -> String # showList :: [GetReservationUtilization] -> ShowS #
Generic GetReservationUtilization Source #
Associated Types type Rep GetReservationUtilization :: * -> * # Methods from :: GetReservationUtilization -> Rep GetReservationUtilization x # to :: Rep GetReservationUtilization x -> GetReservationUtilization #
Hashable GetReservationUtilization Source #
Methods hashWithSalt :: Int -> GetReservationUtilization -> Int # hash :: GetReservationUtilization -> Int #
ToJSON GetReservationUtilization Source #
Methods toJSON :: GetReservationUtilization -> Value # toEncoding :: GetReservationUtilization -> Encoding # toJSONList :: [GetReservationUtilization] -> Value # toEncodingList :: [GetReservationUtilization] -> Encoding #
NFData GetReservationUtilization Source #
Methods rnf :: GetReservationUtilization -> () #
AWSRequest GetReservationUtilization Source #
Associated Types type Rs GetReservationUtilization :: * # Methods request :: GetReservationUtilization -> Request GetReservationUtilization # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetReservationUtilization -> ClientResponse -> m (Response GetReservationUtilization) #
ToHeaders GetReservationUtilization Source #
Methods toHeaders :: GetReservationUtilization -> [Header] #
ToPath GetReservationUtilization Source #
Methods toPath :: GetReservationUtilization -> ByteString #
ToQuery GetReservationUtilization Source #
Methods toQuery :: GetReservationUtilization -> QueryString #
type Rep GetReservationUtilization Source #
type Rep GetReservationUtilization = D1 * (MetaData "GetReservationUtilization" "Network.AWS.CostExplorer.GetReservationUtilization" "amazonka-cost-explorer-1.6.0-1EmcUb6qhvECvPsx1AQih6" False) (C1 * (MetaCons "GetReservationUtilization'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_gruGroupBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [GroupDefinition]))) (S1 * (MetaSel (Just Symbol "_gruNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((::) (S1 * (MetaSel (Just Symbol "_gruGranularity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Granularity))) ((::) (S1 * (MetaSel (Just Symbol "_gruFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Expression))) (S1 * (MetaSel (Just Symbol "_gruTimePeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * DateInterval))))))
type Rs GetReservationUtilization Source #
type Rs GetReservationUtilization = GetReservationUtilizationResponse

Request Lenses

gruGroupBy :: Lens' GetReservationUtilization [GroupDefinition] Source #

Groups only by SUBSCRIPTION_ID . Metadata is included.

gruNextPageToken :: Lens' GetReservationUtilization (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.

gruGranularity :: Lens' GetReservationUtilization (Maybe Granularity) Source #

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 . If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY .

gruFilter :: Lens' GetReservationUtilization (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 * SCOPE * TENANCY GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

gruTimePeriod :: Lens' GetReservationUtilization DateInterval Source #

Sets the start and end dates for retrieving Reserved Instance (RI) utilization. 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

getReservationUtilizationResponse Source #

Arguments

:: Int	`grursResponseStatus`
-> GetReservationUtilizationResponse

Creates a value of GetReservationUtilizationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

grursNextPageToken - 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.
grursTotal - The total amount of time that you utilized your RIs.
grursResponseStatus - -- | The response status code.
grursUtilizationsByTime - The amount of time that you utilized your RIs.

data GetReservationUtilizationResponse Source #

See: getReservationUtilizationResponse smart constructor.

Instances

Eq GetReservationUtilizationResponse Source #
Methods (==) :: GetReservationUtilizationResponse -> GetReservationUtilizationResponse -> Bool # (/=) :: GetReservationUtilizationResponse -> GetReservationUtilizationResponse -> Bool #
Data GetReservationUtilizationResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetReservationUtilizationResponse -> c GetReservationUtilizationResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetReservationUtilizationResponse # toConstr :: GetReservationUtilizationResponse -> Constr # dataTypeOf :: GetReservationUtilizationResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetReservationUtilizationResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetReservationUtilizationResponse) # gmapT :: (forall b. Data b => b -> b) -> GetReservationUtilizationResponse -> GetReservationUtilizationResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationUtilizationResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetReservationUtilizationResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetReservationUtilizationResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetReservationUtilizationResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetReservationUtilizationResponse -> m GetReservationUtilizationResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationUtilizationResponse -> m GetReservationUtilizationResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetReservationUtilizationResponse -> m GetReservationUtilizationResponse #
Read GetReservationUtilizationResponse Source #
Methods readsPrec :: Int -> ReadS GetReservationUtilizationResponse # readList :: ReadS [GetReservationUtilizationResponse] # readPrec :: ReadPrec GetReservationUtilizationResponse # readListPrec :: ReadPrec [GetReservationUtilizationResponse] #
Show GetReservationUtilizationResponse Source #
Methods showsPrec :: Int -> GetReservationUtilizationResponse -> ShowS # show :: GetReservationUtilizationResponse -> String # showList :: [GetReservationUtilizationResponse] -> ShowS #
Generic GetReservationUtilizationResponse Source #
Associated Types type Rep GetReservationUtilizationResponse :: * -> * # Methods from :: GetReservationUtilizationResponse -> Rep GetReservationUtilizationResponse x # to :: Rep GetReservationUtilizationResponse x -> GetReservationUtilizationResponse #
NFData GetReservationUtilizationResponse Source #
Methods rnf :: GetReservationUtilizationResponse -> () #
type Rep GetReservationUtilizationResponse Source #
type Rep GetReservationUtilizationResponse = D1 * (MetaData "GetReservationUtilizationResponse" "Network.AWS.CostExplorer.GetReservationUtilization" "amazonka-cost-explorer-1.6.0-1EmcUb6qhvECvPsx1AQih6" False) (C1 * (MetaCons "GetReservationUtilizationResponse'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_grursNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_grursTotal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ReservationAggregates)))) ((::) (S1 * (MetaSel (Just Symbol "_grursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_grursUtilizationsByTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [UtilizationByTime])))))

Response Lenses

grursNextPageToken :: Lens' GetReservationUtilizationResponse (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.

grursTotal :: Lens' GetReservationUtilizationResponse (Maybe ReservationAggregates) Source #

The total amount of time that you utilized your RIs.

grursResponseStatus :: Lens' GetReservationUtilizationResponse Int Source #

- | The response status code.

grursUtilizationsByTime :: Lens' GetReservationUtilizationResponse [UtilizationByTime] Source #

The amount of time that you utilized your RIs.