/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace CostExplorer { namespace Model { /** */ class GetSavingsPlansPurchaseRecommendationRequest : public CostExplorerRequest { public: AWS_COSTEXPLORER_API GetSavingsPlansPurchaseRecommendationRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetSavingsPlansPurchaseRecommendation"; } AWS_COSTEXPLORER_API Aws::String SerializePayload() const override; AWS_COSTEXPLORER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The Savings Plans recommendation type that's requested.

*/ inline const SupportedSavingsPlansType& GetSavingsPlansType() const{ return m_savingsPlansType; } /** *

The Savings Plans recommendation type that's requested.

*/ inline bool SavingsPlansTypeHasBeenSet() const { return m_savingsPlansTypeHasBeenSet; } /** *

The Savings Plans recommendation type that's requested.

*/ inline void SetSavingsPlansType(const SupportedSavingsPlansType& value) { m_savingsPlansTypeHasBeenSet = true; m_savingsPlansType = value; } /** *

The Savings Plans recommendation type that's requested.

*/ inline void SetSavingsPlansType(SupportedSavingsPlansType&& value) { m_savingsPlansTypeHasBeenSet = true; m_savingsPlansType = std::move(value); } /** *

The Savings Plans recommendation type that's requested.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithSavingsPlansType(const SupportedSavingsPlansType& value) { SetSavingsPlansType(value); return *this;} /** *

The Savings Plans recommendation type that's requested.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithSavingsPlansType(SupportedSavingsPlansType&& value) { SetSavingsPlansType(std::move(value)); return *this;} /** *

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

*/ inline const TermInYears& GetTermInYears() const{ return m_termInYears; } /** *

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

*/ inline bool TermInYearsHasBeenSet() const { return m_termInYearsHasBeenSet; } /** *

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

*/ inline void SetTermInYears(const TermInYears& value) { m_termInYearsHasBeenSet = true; m_termInYears = value; } /** *

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

*/ inline void SetTermInYears(TermInYears&& value) { m_termInYearsHasBeenSet = true; m_termInYears = std::move(value); } /** *

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

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithTermInYears(const TermInYears& value) { SetTermInYears(value); return *this;} /** *

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

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithTermInYears(TermInYears&& value) { SetTermInYears(std::move(value)); return *this;} /** *

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

*/ inline const PaymentOption& GetPaymentOption() const{ return m_paymentOption; } /** *

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

*/ inline bool PaymentOptionHasBeenSet() const { return m_paymentOptionHasBeenSet; } /** *

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

*/ inline void SetPaymentOption(const PaymentOption& value) { m_paymentOptionHasBeenSet = true; m_paymentOption = value; } /** *

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

*/ inline void SetPaymentOption(PaymentOption&& value) { m_paymentOptionHasBeenSet = true; m_paymentOption = std::move(value); } /** *

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

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithPaymentOption(const PaymentOption& value) { SetPaymentOption(value); return *this;} /** *

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

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithPaymentOption(PaymentOption&& value) { SetPaymentOption(std::move(value)); return *this;} /** *

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.

*/ inline const AccountScope& GetAccountScope() const{ return m_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.

*/ inline bool AccountScopeHasBeenSet() const { return m_accountScopeHasBeenSet; } /** *

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.

*/ inline void SetAccountScope(const AccountScope& value) { m_accountScopeHasBeenSet = true; m_accountScope = value; } /** *

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.

*/ inline void SetAccountScope(AccountScope&& value) { m_accountScopeHasBeenSet = true; m_accountScope = std::move(value); } /** *

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.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithAccountScope(const AccountScope& value) { SetAccountScope(value); return *this;} /** *

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.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithAccountScope(AccountScope&& value) { SetAccountScope(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetNextPageToken() const{ return m_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.

*/ inline bool NextPageTokenHasBeenSet() const { return m_nextPageTokenHasBeenSet; } /** *

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.

*/ inline void SetNextPageToken(const Aws::String& value) { m_nextPageTokenHasBeenSet = true; m_nextPageToken = value; } /** *

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.

*/ inline void SetNextPageToken(Aws::String&& value) { m_nextPageTokenHasBeenSet = true; m_nextPageToken = std::move(value); } /** *

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.

*/ inline void SetNextPageToken(const char* value) { m_nextPageTokenHasBeenSet = true; m_nextPageToken.assign(value); } /** *

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.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithNextPageToken(const Aws::String& value) { SetNextPageToken(value); return *this;} /** *

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.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithNextPageToken(Aws::String&& value) { SetNextPageToken(std::move(value)); return *this;} /** *

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.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithNextPageToken(const char* value) { SetNextPageToken(value); return *this;} /** *

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

*/ inline int GetPageSize() const{ return m_pageSize; } /** *

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

*/ inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; } /** *

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

*/ inline void SetPageSize(int value) { m_pageSizeHasBeenSet = true; m_pageSize = value; } /** *

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

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithPageSize(int value) { SetPageSize(value); return *this;} /** *

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

*/ inline const LookbackPeriodInDays& GetLookbackPeriodInDays() const{ return m_lookbackPeriodInDays; } /** *

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

*/ inline bool LookbackPeriodInDaysHasBeenSet() const { return m_lookbackPeriodInDaysHasBeenSet; } /** *

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

*/ inline void SetLookbackPeriodInDays(const LookbackPeriodInDays& value) { m_lookbackPeriodInDaysHasBeenSet = true; m_lookbackPeriodInDays = value; } /** *

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

*/ inline void SetLookbackPeriodInDays(LookbackPeriodInDays&& value) { m_lookbackPeriodInDaysHasBeenSet = true; m_lookbackPeriodInDays = std::move(value); } /** *

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

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithLookbackPeriodInDays(const LookbackPeriodInDays& value) { SetLookbackPeriodInDays(value); return *this;} /** *

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

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithLookbackPeriodInDays(LookbackPeriodInDays&& value) { SetLookbackPeriodInDays(std::move(value)); return *this;} /** *

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.

*/ inline const Expression& GetFilter() const{ return m_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.

*/ inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; } /** *

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.

*/ inline void SetFilter(const Expression& value) { m_filterHasBeenSet = true; m_filter = value; } /** *

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.

*/ inline void SetFilter(Expression&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); } /** *

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.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithFilter(const Expression& value) { SetFilter(value); return *this;} /** *

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.

*/ inline GetSavingsPlansPurchaseRecommendationRequest& WithFilter(Expression&& value) { SetFilter(std::move(value)); return *this;} private: SupportedSavingsPlansType m_savingsPlansType; bool m_savingsPlansTypeHasBeenSet = false; TermInYears m_termInYears; bool m_termInYearsHasBeenSet = false; PaymentOption m_paymentOption; bool m_paymentOptionHasBeenSet = false; AccountScope m_accountScope; bool m_accountScopeHasBeenSet = false; Aws::String m_nextPageToken; bool m_nextPageTokenHasBeenSet = false; int m_pageSize; bool m_pageSizeHasBeenSet = false; LookbackPeriodInDays m_lookbackPeriodInDays; bool m_lookbackPeriodInDaysHasBeenSet = false; Expression m_filter; bool m_filterHasBeenSet = false; }; } // namespace Model } // namespace CostExplorer } // namespace Aws