libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CostExplorer.GetSavingsPlansUtilization

Description

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

You cannot group by any dimension values for GetSavingsPlansUtilization.

Synopsis

Creating a Request

data GetSavingsPlansUtilization Source #

See: newGetSavingsPlansUtilization smart constructor.

Constructors

GetSavingsPlansUtilization' 

Fields

  • granularity :: Maybe Granularity

    The granularity of the Amazon Web Services utillization data for your Savings Plans.

    The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

  • filter' :: Maybe Expression

    Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

    • LINKED_ACCOUNT
    • SAVINGS_PLAN_ARN
    • SAVINGS_PLANS_TYPE
    • REGION
    • PAYMENT_OPTION
    • INSTANCE_TYPE_FAMILY

    GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

  • sortBy :: Maybe SortDefinition

    The value by which you want to sort the data.

    The following values are supported for Key:

    • UtilizationPercentage
    • TotalCommitment
    • UsedCommitment
    • UnusedCommitment
    • NetSavings

    Supported values for SortOrder are ASCENDING or DESCENDING.

  • timePeriod :: DateInterval

    The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Instances

Instances details
Eq GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

(==) :: GetSavingsPlansUtilization -> GetSavingsPlansUtilization -> Bool #

(/=) :: GetSavingsPlansUtilization -> GetSavingsPlansUtilization -> Bool #

Read GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

readsPrec :: Int -> ReadS GetSavingsPlansUtilization #

readList :: ReadS [GetSavingsPlansUtilization] #

readPrec :: ReadPrec GetSavingsPlansUtilization #

readListPrec :: ReadPrec [GetSavingsPlansUtilization] #

Show GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

showsPrec :: Int -> GetSavingsPlansUtilization -> ShowS #

show :: GetSavingsPlansUtilization -> String #

showList :: [GetSavingsPlansUtilization] -> ShowS #

Generic GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Associated Types

type Rep GetSavingsPlansUtilization :: Type -> Type #

Methods

from :: GetSavingsPlansUtilization -> Rep GetSavingsPlansUtilization x #

to :: Rep GetSavingsPlansUtilization x -> GetSavingsPlansUtilization #

NFData GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

rnf :: GetSavingsPlansUtilization -> () #

Hashable GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

hashWithSalt :: Int -> GetSavingsPlansUtilization -> Int #

hash :: GetSavingsPlansUtilization -> Int #

ToJSON GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

toJSON :: GetSavingsPlansUtilization -> Value #

toEncoding :: GetSavingsPlansUtilization -> Encoding #

toJSONList :: [GetSavingsPlansUtilization] -> Value #

toEncodingList :: [GetSavingsPlansUtilization] -> Encoding #

AWSRequest GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Associated Types

type AWSResponse GetSavingsPlansUtilization #

Methods

request :: GetSavingsPlansUtilization -> Request GetSavingsPlansUtilization #

response :: MonadResource m => Logger -> Service -> Proxy GetSavingsPlansUtilization -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSavingsPlansUtilization))) #

ToHeaders GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

toHeaders :: GetSavingsPlansUtilization -> [Header] #

ToPath GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

toPath :: GetSavingsPlansUtilization -> ByteString #

ToQuery GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

toQuery :: GetSavingsPlansUtilization -> QueryString #

type Rep GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

type Rep GetSavingsPlansUtilization = D1 ('MetaData "GetSavingsPlansUtilization" "Amazonka.CostExplorer.GetSavingsPlansUtilization" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetSavingsPlansUtilization'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "granularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Granularity)) :*: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression))) :*: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortDefinition)) :*: S1 ('MetaSel ('Just "timePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DateInterval))))
type AWSResponse GetSavingsPlansUtilization Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

type AWSResponse GetSavingsPlansUtilization = GetSavingsPlansUtilizationResponse

newGetSavingsPlansUtilization Source #

Arguments

:: DateInterval

$sel:timePeriod:GetSavingsPlansUtilization'

-> GetSavingsPlansUtilization 

Create a value of GetSavingsPlansUtilization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:granularity:GetSavingsPlansUtilization', getSavingsPlansUtilization_granularity - The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

$sel:filter':GetSavingsPlansUtilization', getSavingsPlansUtilization_filter - Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

  • LINKED_ACCOUNT
  • SAVINGS_PLAN_ARN
  • SAVINGS_PLANS_TYPE
  • REGION
  • PAYMENT_OPTION
  • INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

$sel:sortBy:GetSavingsPlansUtilization', getSavingsPlansUtilization_sortBy - The value by which you want to sort the data.

The following values are supported for Key:

  • UtilizationPercentage
  • TotalCommitment
  • UsedCommitment
  • UnusedCommitment
  • NetSavings

Supported values for SortOrder are ASCENDING or DESCENDING.

$sel:timePeriod:GetSavingsPlansUtilization', getSavingsPlansUtilization_timePeriod - The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Request Lenses

getSavingsPlansUtilization_granularity :: Lens' GetSavingsPlansUtilization (Maybe Granularity) Source #

The granularity of the Amazon Web Services utillization data for your Savings Plans.

The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY granularities.

getSavingsPlansUtilization_filter :: Lens' GetSavingsPlansUtilization (Maybe Expression) Source #

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

  • LINKED_ACCOUNT
  • SAVINGS_PLAN_ARN
  • SAVINGS_PLANS_TYPE
  • REGION
  • PAYMENT_OPTION
  • INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.

getSavingsPlansUtilization_sortBy :: Lens' GetSavingsPlansUtilization (Maybe SortDefinition) Source #

The value by which you want to sort the data.

The following values are supported for Key:

  • UtilizationPercentage
  • TotalCommitment
  • UsedCommitment
  • UnusedCommitment
  • NetSavings

Supported values for SortOrder are ASCENDING or DESCENDING.

getSavingsPlansUtilization_timePeriod :: Lens' GetSavingsPlansUtilization DateInterval Source #

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

Destructuring the Response

data GetSavingsPlansUtilizationResponse Source #

See: newGetSavingsPlansUtilizationResponse smart constructor.

Constructors

GetSavingsPlansUtilizationResponse' 

Fields

Instances

Instances details
Eq GetSavingsPlansUtilizationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

(==) :: GetSavingsPlansUtilizationResponse -> GetSavingsPlansUtilizationResponse -> Bool #

(/=) :: GetSavingsPlansUtilizationResponse -> GetSavingsPlansUtilizationResponse -> Bool #

Read GetSavingsPlansUtilizationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

readsPrec :: Int -> ReadS GetSavingsPlansUtilizationResponse #

readList :: ReadS [GetSavingsPlansUtilizationResponse] #

readPrec :: ReadPrec GetSavingsPlansUtilizationResponse #

readListPrec :: ReadPrec [GetSavingsPlansUtilizationResponse] #

Show GetSavingsPlansUtilizationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

showsPrec :: Int -> GetSavingsPlansUtilizationResponse -> ShowS #

show :: GetSavingsPlansUtilizationResponse -> String #

showList :: [GetSavingsPlansUtilizationResponse] -> ShowS #

Generic GetSavingsPlansUtilizationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Associated Types

type Rep GetSavingsPlansUtilizationResponse :: Type -> Type #

Methods

from :: GetSavingsPlansUtilizationResponse -> Rep GetSavingsPlansUtilizationResponse x #

to :: Rep GetSavingsPlansUtilizationResponse x -> GetSavingsPlansUtilizationResponse #

NFData GetSavingsPlansUtilizationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

Methods

rnf :: GetSavingsPlansUtilizationResponse -> () #

type Rep GetSavingsPlansUtilizationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansUtilization

type Rep GetSavingsPlansUtilizationResponse = D1 ('MetaData "GetSavingsPlansUtilizationResponse" "Amazonka.CostExplorer.GetSavingsPlansUtilization" "libZSservicesZSamazonka-cost-explorerZSamazonka-cost-explorer" 'False) (C1 ('MetaCons "GetSavingsPlansUtilizationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "savingsPlansUtilizationsByTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SavingsPlansUtilizationByTime])) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SavingsPlansUtilizationAggregates))))

newGetSavingsPlansUtilizationResponse Source #

Arguments

:: Int

$sel:httpStatus:GetSavingsPlansUtilizationResponse'

-> SavingsPlansUtilizationAggregates

$sel:total:GetSavingsPlansUtilizationResponse'

-> GetSavingsPlansUtilizationResponse 

Create a value of GetSavingsPlansUtilizationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:savingsPlansUtilizationsByTime:GetSavingsPlansUtilizationResponse', getSavingsPlansUtilizationResponse_savingsPlansUtilizationsByTime - The amount of cost/commitment you used your Savings Plans. This allows you to specify date ranges.

$sel:httpStatus:GetSavingsPlansUtilizationResponse', getSavingsPlansUtilizationResponse_httpStatus - The response's http status code.

$sel:total:GetSavingsPlansUtilizationResponse', getSavingsPlansUtilizationResponse_total - The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.

Response Lenses

getSavingsPlansUtilizationResponse_savingsPlansUtilizationsByTime :: Lens' GetSavingsPlansUtilizationResponse (Maybe [SavingsPlansUtilizationByTime]) Source #

The amount of cost/commitment you used your Savings Plans. This allows you to specify date ranges.

getSavingsPlansUtilizationResponse_httpStatus :: Lens' GetSavingsPlansUtilizationResponse Int Source #

The response's http status code.

getSavingsPlansUtilizationResponse_total :: Lens' GetSavingsPlansUtilizationResponse SavingsPlansUtilizationAggregates Source #

The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.