Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

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.

Creating a Request

data GetSavingsPlansPurchaseRecommendation

See: newGetSavingsPlansPurchaseRecommendation smart constructor.

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

ToJSON GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

toJSON :: GetSavingsPlansPurchaseRecommendation -> Value

toEncoding :: GetSavingsPlansPurchaseRecommendation -> Encoding

toJSONList :: [GetSavingsPlansPurchaseRecommendation] -> Value

toEncodingList :: [GetSavingsPlansPurchaseRecommendation] -> Encoding

ToHeaders GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

toHeaders :: GetSavingsPlansPurchaseRecommendation -> [Header]

ToPath GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

toPath :: GetSavingsPlansPurchaseRecommendation -> ByteString

ToQuery GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

toQuery :: GetSavingsPlansPurchaseRecommendation -> QueryString

AWSRequest GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Associated Types

type AWSResponse GetSavingsPlansPurchaseRecommendation

Methods

request :: (Service -> Service) -> GetSavingsPlansPurchaseRecommendation -> Request GetSavingsPlansPurchaseRecommendation

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSavingsPlansPurchaseRecommendation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSavingsPlansPurchaseRecommendation)))

Generic GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Associated Types

type Rep GetSavingsPlansPurchaseRecommendation :: Type -> Type

Methods

from :: GetSavingsPlansPurchaseRecommendation -> Rep GetSavingsPlansPurchaseRecommendation x

to :: Rep GetSavingsPlansPurchaseRecommendation x -> GetSavingsPlansPurchaseRecommendation

Read GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

readsPrec :: Int -> ReadS GetSavingsPlansPurchaseRecommendation

readList :: ReadS [GetSavingsPlansPurchaseRecommendation]

readPrec :: ReadPrec GetSavingsPlansPurchaseRecommendation

readListPrec :: ReadPrec [GetSavingsPlansPurchaseRecommendation]

Show GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

showsPrec :: Int -> GetSavingsPlansPurchaseRecommendation -> ShowS

show :: GetSavingsPlansPurchaseRecommendation -> String

showList :: [GetSavingsPlansPurchaseRecommendation] -> ShowS

NFData GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

rnf :: GetSavingsPlansPurchaseRecommendation -> ()

Eq GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

(==) :: GetSavingsPlansPurchaseRecommendation -> GetSavingsPlansPurchaseRecommendation -> Bool

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

Hashable GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

hashWithSalt :: Int -> GetSavingsPlansPurchaseRecommendation -> Int

hash :: GetSavingsPlansPurchaseRecommendation -> Int

type AWSResponse GetSavingsPlansPurchaseRecommendation

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

type AWSResponse GetSavingsPlansPurchaseRecommendation = GetSavingsPlansPurchaseRecommendationResponse

type Rep GetSavingsPlansPurchaseRecommendation

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

Arguments

:: SupportedSavingsPlansType

GetSavingsPlansPurchaseRecommendation

-> TermInYears

GetSavingsPlansPurchaseRecommendation

-> PaymentOption

GetSavingsPlansPurchaseRecommendation

-> LookbackPeriodInDays

GetSavingsPlansPurchaseRecommendation

-> GetSavingsPlansPurchaseRecommendation

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)

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)

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)

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)

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

getSavingsPlansPurchaseRecommendation_savingsPlansType :: Lens' GetSavingsPlansPurchaseRecommendation SupportedSavingsPlansType

The Savings Plans recommendation type that's requested.

getSavingsPlansPurchaseRecommendation_termInYears :: Lens' GetSavingsPlansPurchaseRecommendation TermInYears

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

getSavingsPlansPurchaseRecommendation_paymentOption :: Lens' GetSavingsPlansPurchaseRecommendation PaymentOption

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

getSavingsPlansPurchaseRecommendation_lookbackPeriodInDays :: Lens' GetSavingsPlansPurchaseRecommendation LookbackPeriodInDays

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

Destructuring the Response

data GetSavingsPlansPurchaseRecommendationResponse

See: newGetSavingsPlansPurchaseRecommendationResponse smart constructor.

Constructors

GetSavingsPlansPurchaseRecommendationResponse'

Fields

• metadata :: Maybe SavingsPlansPurchaseRecommendationMetadata

  Information that regards this specific recommendation set.

• nextPageToken :: Maybe Text

  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.

• savingsPlansPurchaseRecommendation :: Maybe SavingsPlansPurchaseRecommendation

  Contains your request parameters, Savings Plan Recommendations Summary, and Details.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetSavingsPlansPurchaseRecommendationResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Associated Types

type Rep GetSavingsPlansPurchaseRecommendationResponse :: Type -> Type

Methods

from :: GetSavingsPlansPurchaseRecommendationResponse -> Rep GetSavingsPlansPurchaseRecommendationResponse x

to :: Rep GetSavingsPlansPurchaseRecommendationResponse x -> GetSavingsPlansPurchaseRecommendationResponse

Read GetSavingsPlansPurchaseRecommendationResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

readsPrec :: Int -> ReadS GetSavingsPlansPurchaseRecommendationResponse

readList :: ReadS [GetSavingsPlansPurchaseRecommendationResponse]

readPrec :: ReadPrec GetSavingsPlansPurchaseRecommendationResponse

readListPrec :: ReadPrec [GetSavingsPlansPurchaseRecommendationResponse]

Show GetSavingsPlansPurchaseRecommendationResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

showsPrec :: Int -> GetSavingsPlansPurchaseRecommendationResponse -> ShowS

show :: GetSavingsPlansPurchaseRecommendationResponse -> String

showList :: [GetSavingsPlansPurchaseRecommendationResponse] -> ShowS

NFData GetSavingsPlansPurchaseRecommendationResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

rnf :: GetSavingsPlansPurchaseRecommendationResponse -> ()

Eq GetSavingsPlansPurchaseRecommendationResponse

Defined in Amazonka.CostExplorer.GetSavingsPlansPurchaseRecommendation

Methods

(==) :: GetSavingsPlansPurchaseRecommendationResponse -> GetSavingsPlansPurchaseRecommendationResponse -> Bool

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

type Rep GetSavingsPlansPurchaseRecommendationResponse

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

Arguments

:: Int

$sel:httpStatus:GetSavingsPlansPurchaseRecommendationResponse'

-> 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: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_metadata :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe SavingsPlansPurchaseRecommendationMetadata)

Information that regards this specific recommendation set.

getSavingsPlansPurchaseRecommendationResponse_nextPageToken :: Lens' GetSavingsPlansPurchaseRecommendationResponse (Maybe Text)

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)

Contains your request parameters, Savings Plan Recommendations Summary, and Details.

getSavingsPlansPurchaseRecommendationResponse_httpStatus :: Lens' GetSavingsPlansPurchaseRecommendationResponse Int

The response's http status code.