amazonka-cost-explorer-2.0: Amazon Cost Explorer Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Description

Retrieves the Savings Plans recommendations for your account. First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.

Synopsis

Creating a Request

data GetSavingsPlansPurchaseRecommendation Source #

Constructors

GetSavingsPlansPurchaseRecommendation' 

Fields

  • accountScope :: Maybe AccountScope

    The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

  • filter' :: Maybe Expression

    You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

    For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.

  • nextPageToken :: Maybe Text

    The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

  • pageSize :: Maybe Natural

    The number of recommendations that you want returned in a single response object.

  • savingsPlansType :: SupportedSavingsPlansType

    The Savings Plans recommendation type that's requested.

  • termInYears :: TermInYears

    The savings plan recommendation term that's used to generate these recommendations.

  • paymentOption :: PaymentOption

    The payment option that's used to generate these recommendations.

  • lookbackPeriodInDays :: LookbackPeriodInDays

    The lookback period that's used to generate the recommendation.

Instances

Instances details
ToJSON GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

ToHeaders GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

ToPath GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

ToQuery GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

AWSRequest GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Generic GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Read GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Show GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

NFData GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Eq GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Hashable GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

type AWSResponse GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

type Rep GetSavingsPlansPurchaseRecommendation Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

type Rep GetSavingsPlansPurchaseRecommendation = D1 ('MetaData "GetSavingsPlansPurchaseRecommendation" "Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetSavingsPlansPurchaseRecommendation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accountScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountScope)) :*: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression))) :*: (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "savingsPlansType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SupportedSavingsPlansType) :*: S1 ('MetaSel ('Just "termInYears") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TermInYears)) :*: (S1 ('MetaSel ('Just "paymentOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PaymentOption) :*: S1 ('MetaSel ('Just "lookbackPeriodInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LookbackPeriodInDays)))))

newGetSavingsPlansPurchaseRecommendation Source #

Create a value of GetSavingsPlansPurchaseRecommendation 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:

GetSavingsPlansPurchaseRecommendation, getSavingsPlansPurchaseRecommendation_accountScope - The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

$sel:filter':GetSavingsPlansPurchaseRecommendation', getSavingsPlansPurchaseRecommendation_filter - You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.

GetSavingsPlansPurchaseRecommendation, getSavingsPlansPurchaseRecommendation_nextPageToken - The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

$sel:pageSize:GetSavingsPlansPurchaseRecommendation', getSavingsPlansPurchaseRecommendation_pageSize - The number of recommendations that you want returned in a single response object.

GetSavingsPlansPurchaseRecommendation, getSavingsPlansPurchaseRecommendation_savingsPlansType - The Savings Plans recommendation type that's requested.

GetSavingsPlansPurchaseRecommendation, getSavingsPlansPurchaseRecommendation_termInYears - The savings plan recommendation term that's used to generate these recommendations.

GetSavingsPlansPurchaseRecommendation, getSavingsPlansPurchaseRecommendation_paymentOption - The payment option that's used to generate these recommendations.

GetSavingsPlansPurchaseRecommendation, getSavingsPlansPurchaseRecommendation_lookbackPeriodInDays - The lookback period that's used to generate the recommendation.

Request Lenses

getSavingsPlansPurchaseRecommendation_accountScope :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe AccountScope) Source #

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

getSavingsPlansPurchaseRecommendation_filter :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe Expression) Source #

You can filter your recommendations by Account ID with the LINKED_ACCOUNT dimension. To filter your recommendations by Account ID, specify Key as LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to see Savings Plans purchase recommendations for.

For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include CostCategories or Tags. It only includes Dimensions. With Dimensions, Key must be LINKED_ACCOUNT and Value can be a single Account ID or multiple comma-separated Account IDs that you want to see Savings Plans Purchase Recommendations for. AND and OR operators are not supported.

getSavingsPlansPurchaseRecommendation_nextPageToken :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe Text) Source #

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

getSavingsPlansPurchaseRecommendation_pageSize :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe Natural) Source #

The number of recommendations that you want returned in a single response object.

getSavingsPlansPurchaseRecommendation_termInYears :: Lens' GetSavingsPlansPurchaseRecommendation TermInYears Source #

The savings plan recommendation term that's used to generate these recommendations.

Destructuring the Response

data GetSavingsPlansPurchaseRecommendationResponse Source #

Constructors

GetSavingsPlansPurchaseRecommendationResponse' 

Fields

Instances

Instances details
Generic GetSavingsPlansPurchaseRecommendationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Read GetSavingsPlansPurchaseRecommendationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Show GetSavingsPlansPurchaseRecommendationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

NFData GetSavingsPlansPurchaseRecommendationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Eq GetSavingsPlansPurchaseRecommendationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

type Rep GetSavingsPlansPurchaseRecommendationResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

type Rep GetSavingsPlansPurchaseRecommendationResponse = D1 ('MetaData "GetSavingsPlansPurchaseRecommendationResponse" "Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetSavingsPlansPurchaseRecommendationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SavingsPlansPurchaseRecommendationMetadata)) :*: S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "savingsPlansPurchaseRecommendation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SavingsPlansPurchaseRecommendation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetSavingsPlansPurchaseRecommendationResponse Source #

Create a value of GetSavingsPlansPurchaseRecommendationResponse 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:metadata:GetSavingsPlansPurchaseRecommendationResponse', getSavingsPlansPurchaseRecommendationResponse_metadata - Information that regards this specific recommendation set.

GetSavingsPlansPurchaseRecommendation, getSavingsPlansPurchaseRecommendationResponse_nextPageToken - The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

$sel:savingsPlansPurchaseRecommendation:GetSavingsPlansPurchaseRecommendationResponse', getSavingsPlansPurchaseRecommendationResponse_savingsPlansPurchaseRecommendation - Contains your request parameters, Savings Plan Recommendations Summary, and Details.

$sel:httpStatus:GetSavingsPlansPurchaseRecommendationResponse', getSavingsPlansPurchaseRecommendationResponse_httpStatus - The response's http status code.

Response Lenses

getSavingsPlansPurchaseRecommendationResponse_nextPageToken :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe Text) Source #

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.