Network.AWS.CostExplorer.GetReservationUtilization

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 .

Creating a Request

getReservationUtilization

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

See: getReservationUtilization smart constructor.

Instances

Eq GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

(==) :: GetReservationUtilization -> GetReservationUtilization -> Bool

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

Data GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

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

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

readsPrec :: Int -> ReadS GetReservationUtilization

readList :: ReadS [GetReservationUtilization]

readPrec :: ReadPrec GetReservationUtilization

readListPrec :: ReadPrec [GetReservationUtilization]

Show GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

showsPrec :: Int -> GetReservationUtilization -> ShowS

show :: GetReservationUtilization -> String

showList :: [GetReservationUtilization] -> ShowS

Generic GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Associated Types

type Rep GetReservationUtilization :: Type -> Type

Methods

from :: GetReservationUtilization -> Rep GetReservationUtilization x

to :: Rep GetReservationUtilization x -> GetReservationUtilization

Hashable GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

hashWithSalt :: Int -> GetReservationUtilization -> Int

hash :: GetReservationUtilization -> Int

ToJSON GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

toJSON :: GetReservationUtilization -> Value

toEncoding :: GetReservationUtilization -> Encoding

toJSONList :: [GetReservationUtilization] -> Value

toEncodingList :: [GetReservationUtilization] -> Encoding

AWSRequest GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Associated Types

type Rs GetReservationUtilization :: Type

Methods

request :: GetReservationUtilization -> Request GetReservationUtilization

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

ToHeaders GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

toHeaders :: GetReservationUtilization -> [Header]

ToPath GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

toPath :: GetReservationUtilization -> ByteString

ToQuery GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

toQuery :: GetReservationUtilization -> QueryString

NFData GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

rnf :: GetReservationUtilization -> ()

type Rep GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

type Rep GetReservationUtilization = D1 (MetaData "GetReservationUtilization" "Network.AWS.CostExplorer.GetReservationUtilization" "amazonka-cost-explorer-1.6.1-7sTfcQv11bzDg3vrG851Fd" False) (C1 (MetaCons "GetReservationUtilization'" PrefixI True) ((S1 (MetaSel (Just "_gruGroupBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GroupDefinition])) :*: S1 (MetaSel (Just "_gruNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gruGranularity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Granularity)) :*: (S1 (MetaSel (Just "_gruFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Expression)) :*: S1 (MetaSel (Just "_gruTimePeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DateInterval)))))

type Rs GetReservationUtilization

Defined in Network.AWS.CostExplorer.GetReservationUtilization

type Rs GetReservationUtilization = GetReservationUtilizationResponse

Request Lenses

gruGroupBy :: Lens' GetReservationUtilization [GroupDefinition]

Groups only by SUBSCRIPTION_ID . Metadata is included.

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

gruGranularity :: Lens' GetReservationUtilization (Maybe Granularity)

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)

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

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

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

See: getReservationUtilizationResponse smart constructor.

Instances

Eq GetReservationUtilizationResponse

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

(==) :: GetReservationUtilizationResponse -> GetReservationUtilizationResponse -> Bool

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

Data GetReservationUtilizationResponse

Defined in Network.AWS.CostExplorer.GetReservationUtilization

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

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

readsPrec :: Int -> ReadS GetReservationUtilizationResponse

readList :: ReadS [GetReservationUtilizationResponse]

readPrec :: ReadPrec GetReservationUtilizationResponse

readListPrec :: ReadPrec [GetReservationUtilizationResponse]

Show GetReservationUtilizationResponse

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

showsPrec :: Int -> GetReservationUtilizationResponse -> ShowS

show :: GetReservationUtilizationResponse -> String

showList :: [GetReservationUtilizationResponse] -> ShowS

Generic GetReservationUtilizationResponse

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Associated Types

type Rep GetReservationUtilizationResponse :: Type -> Type

Methods

from :: GetReservationUtilizationResponse -> Rep GetReservationUtilizationResponse x

to :: Rep GetReservationUtilizationResponse x -> GetReservationUtilizationResponse

NFData GetReservationUtilizationResponse

Defined in Network.AWS.CostExplorer.GetReservationUtilization

Methods

rnf :: GetReservationUtilizationResponse -> ()

type Rep GetReservationUtilizationResponse

Defined in Network.AWS.CostExplorer.GetReservationUtilization

type Rep GetReservationUtilizationResponse = D1 (MetaData "GetReservationUtilizationResponse" "Network.AWS.CostExplorer.GetReservationUtilization" "amazonka-cost-explorer-1.6.1-7sTfcQv11bzDg3vrG851Fd" False) (C1 (MetaCons "GetReservationUtilizationResponse'" PrefixI True) ((S1 (MetaSel (Just "_grursNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_grursTotal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ReservationAggregates))) :*: (S1 (MetaSel (Just "_grursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_grursUtilizationsByTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [UtilizationByTime]))))

Response Lenses

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

grursTotal :: Lens' GetReservationUtilizationResponse (Maybe ReservationAggregates)

The total amount of time that you utilized your RIs.

grursResponseStatus :: Lens' GetReservationUtilizationResponse Int

• - | The response status code.

grursUtilizationsByTime :: Lens' GetReservationUtilizationResponse [UtilizationByTime]

The amount of time that you utilized your RIs.