Copyright | (c) 2013-2021 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 |
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
Synopsis
- data GetSavingsPlansPurchaseRecommendation = GetSavingsPlansPurchaseRecommendation' {}
- newGetSavingsPlansPurchaseRecommendation :: SupportedSavingsPlansType -> TermInYears -> PaymentOption -> LookbackPeriodInDays -> GetSavingsPlansPurchaseRecommendation
- getSavingsPlansPurchaseRecommendation_nextPageToken :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe Text)
- getSavingsPlansPurchaseRecommendation_accountScope :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe AccountScope)
- getSavingsPlansPurchaseRecommendation_filter :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe Expression)
- getSavingsPlansPurchaseRecommendation_pageSize :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe Natural)
- getSavingsPlansPurchaseRecommendation_savingsPlansType :: Lens' GetSavingsPlansPurchaseRecommendation SupportedSavingsPlansType
- getSavingsPlansPurchaseRecommendation_termInYears :: Lens' GetSavingsPlansPurchaseRecommendation TermInYears
- getSavingsPlansPurchaseRecommendation_paymentOption :: Lens' GetSavingsPlansPurchaseRecommendation PaymentOption
- getSavingsPlansPurchaseRecommendation_lookbackPeriodInDays :: Lens' GetSavingsPlansPurchaseRecommendation LookbackPeriodInDays
- data GetSavingsPlansPurchaseRecommendationResponse = GetSavingsPlansPurchaseRecommendationResponse' {}
- newGetSavingsPlansPurchaseRecommendationResponse :: Int -> GetSavingsPlansPurchaseRecommendationResponse
- getSavingsPlansPurchaseRecommendationResponse_nextPageToken :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe Text)
- getSavingsPlansPurchaseRecommendationResponse_savingsPlansPurchaseRecommendation :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe SavingsPlansPurchaseRecommendation)
- getSavingsPlansPurchaseRecommendationResponse_metadata :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe SavingsPlansPurchaseRecommendationMetadata)
- getSavingsPlansPurchaseRecommendationResponse_httpStatus :: Lens' GetSavingsPlansPurchaseRecommendationResponse Int
Creating a Request
data GetSavingsPlansPurchaseRecommendation Source #
See: newGetSavingsPlansPurchaseRecommendation
smart constructor.
GetSavingsPlansPurchaseRecommendation' | |
|
Instances
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:
$sel:nextPageToken: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:accountScope: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) for which you want to see Savings Plans purchase
recommendations.
For GetSavingsPlansPurchaseRecommendation, the Filter
does not 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 for which you want to
see Savings Plans Purchase Recommendations. AND
and OR
operators are
not supported.
$sel:pageSize:GetSavingsPlansPurchaseRecommendation'
, getSavingsPlansPurchaseRecommendation_pageSize
- The number of recommendations that you want returned in a single
response object.
$sel:savingsPlansType:GetSavingsPlansPurchaseRecommendation'
, getSavingsPlansPurchaseRecommendation_savingsPlansType
- The Savings Plans recommendation type requested.
$sel:termInYears:GetSavingsPlansPurchaseRecommendation'
, getSavingsPlansPurchaseRecommendation_termInYears
- The savings plan recommendation term used to generate these
recommendations.
$sel:paymentOption:GetSavingsPlansPurchaseRecommendation'
, getSavingsPlansPurchaseRecommendation_paymentOption
- The payment option used to generate these recommendations.
$sel:lookbackPeriodInDays:GetSavingsPlansPurchaseRecommendation'
, getSavingsPlansPurchaseRecommendation_lookbackPeriodInDays
- The lookback period used to generate the recommendation.
Request Lenses
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_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) for which you want to see Savings Plans purchase
recommendations.
For GetSavingsPlansPurchaseRecommendation, the Filter
does not 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 for which you want to
see Savings Plans Purchase Recommendations. AND
and OR
operators are
not supported.
getSavingsPlansPurchaseRecommendation_pageSize :: Lens' GetSavingsPlansPurchaseRecommendation (Maybe Natural) Source #
The number of recommendations that you want returned in a single response object.
getSavingsPlansPurchaseRecommendation_savingsPlansType :: Lens' GetSavingsPlansPurchaseRecommendation SupportedSavingsPlansType Source #
The Savings Plans recommendation type requested.
getSavingsPlansPurchaseRecommendation_termInYears :: Lens' GetSavingsPlansPurchaseRecommendation TermInYears Source #
The savings plan recommendation term used to generate these recommendations.
getSavingsPlansPurchaseRecommendation_paymentOption :: Lens' GetSavingsPlansPurchaseRecommendation PaymentOption Source #
The payment option used to generate these recommendations.
getSavingsPlansPurchaseRecommendation_lookbackPeriodInDays :: Lens' GetSavingsPlansPurchaseRecommendation LookbackPeriodInDays Source #
The lookback period used to generate the recommendation.
Destructuring the Response
data GetSavingsPlansPurchaseRecommendationResponse Source #
See: newGetSavingsPlansPurchaseRecommendationResponse
smart constructor.
GetSavingsPlansPurchaseRecommendationResponse' | |
|
Instances
newGetSavingsPlansPurchaseRecommendationResponse Source #
:: Int |
|
-> GetSavingsPlansPurchaseRecommendationResponse |
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:nextPageToken: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:metadata:GetSavingsPlansPurchaseRecommendationResponse'
, getSavingsPlansPurchaseRecommendationResponse_metadata
- Information regarding this specific recommendation set.
$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.
getSavingsPlansPurchaseRecommendationResponse_savingsPlansPurchaseRecommendation :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe SavingsPlansPurchaseRecommendation) Source #
Contains your request parameters, Savings Plan Recommendations Summary, and Details.
getSavingsPlansPurchaseRecommendationResponse_metadata :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe SavingsPlansPurchaseRecommendationMetadata) Source #
Information regarding this specific recommendation set.
getSavingsPlansPurchaseRecommendationResponse_httpStatus :: Lens' GetSavingsPlansPurchaseRecommendationResponse Int Source #
The response's http status code.