Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CostExplorer.GetReservationPurchaseRecommendation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of normalized units. This way, you can purchase any instance size that you want. For this example, your RI recommendation is for c4.large because that is the smallest size instance in the c4 instance family.

Synopsis

Creating a Request

data GetReservationPurchaseRecommendation Source #

See: newGetReservationPurchaseRecommendation smart constructor.

Constructors

GetReservationPurchaseRecommendation'

Fields

accountId :: Maybe Text
The account ID that's associated with the recommendation.
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
lookbackPeriodInDays :: Maybe LookbackPeriodInDays
The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.
nextPageToken :: Maybe Text
The pagination token that indicates the next set of results that you want to retrieve.
pageSize :: Maybe Natural
The number of recommendations that you want returned in a single response object.
paymentOption :: Maybe PaymentOption
The reservation purchase option that you want recommendations for.
serviceSpecification :: Maybe ServiceSpecification
The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.
termInYears :: Maybe TermInYears
The reservation term that you want recommendations for.
service :: Text
The specific service that you want recommendations for.

Instances

Instances details

ToJSON GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods toJSON :: GetReservationPurchaseRecommendation -> Value # toEncoding :: GetReservationPurchaseRecommendation -> Encoding # toJSONList :: [GetReservationPurchaseRecommendation] -> Value # toEncodingList :: [GetReservationPurchaseRecommendation] -> Encoding #
ToHeaders GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods toHeaders :: GetReservationPurchaseRecommendation -> [Header] #
ToPath GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods toPath :: GetReservationPurchaseRecommendation -> ByteString #
ToQuery GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods toQuery :: GetReservationPurchaseRecommendation -> QueryString #
AWSRequest GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Associated Types type AWSResponse GetReservationPurchaseRecommendation # Methods request :: (Service -> Service) -> GetReservationPurchaseRecommendation -> Request GetReservationPurchaseRecommendation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetReservationPurchaseRecommendation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetReservationPurchaseRecommendation))) #
Generic GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Associated Types type Rep GetReservationPurchaseRecommendation :: Type -> Type # Methods from :: GetReservationPurchaseRecommendation -> Rep GetReservationPurchaseRecommendation x # to :: Rep GetReservationPurchaseRecommendation x -> GetReservationPurchaseRecommendation #
Read GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods readsPrec :: Int -> ReadS GetReservationPurchaseRecommendation # readList :: ReadS [GetReservationPurchaseRecommendation] # readPrec :: ReadPrec GetReservationPurchaseRecommendation # readListPrec :: ReadPrec [GetReservationPurchaseRecommendation] #
Show GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods showsPrec :: Int -> GetReservationPurchaseRecommendation -> ShowS # show :: GetReservationPurchaseRecommendation -> String # showList :: [GetReservationPurchaseRecommendation] -> ShowS #
NFData GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods rnf :: GetReservationPurchaseRecommendation -> () #
Eq GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods (==) :: GetReservationPurchaseRecommendation -> GetReservationPurchaseRecommendation -> Bool # (/=) :: GetReservationPurchaseRecommendation -> GetReservationPurchaseRecommendation -> Bool #
Hashable GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods hashWithSalt :: Int -> GetReservationPurchaseRecommendation -> Int # hash :: GetReservationPurchaseRecommendation -> Int #
type AWSResponse GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation type AWSResponse GetReservationPurchaseRecommendation = GetReservationPurchaseRecommendationResponse
type Rep GetReservationPurchaseRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation type Rep GetReservationPurchaseRecommendation = D1 ('MetaData "GetReservationPurchaseRecommendation" "Amazonka.CostExplorer.GetReservationPurchaseRecommendation" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetReservationPurchaseRecommendation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "accountScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountScope))) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression)) :: (S1 ('MetaSel ('Just "lookbackPeriodInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LookbackPeriodInDays)) :: S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "paymentOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PaymentOption))) :: (S1 ('MetaSel ('Just "serviceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceSpecification)) :: (S1 ('MetaSel ('Just "termInYears") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TermInYears)) :*: S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetReservationPurchaseRecommendation Source #

Arguments

:: Text	`GetReservationPurchaseRecommendation`
-> GetReservationPurchaseRecommendation

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

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_accountId - The account ID that's associated with the recommendation.

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_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':GetReservationPurchaseRecommendation', getReservationPurchaseRecommendation_filter - Undocumented member.

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_lookbackPeriodInDays - The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_nextPageToken - The pagination token that indicates the next set of results that you want to retrieve.

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

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_paymentOption - The reservation purchase option that you want recommendations for.

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_serviceSpecification - The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_termInYears - The reservation term that you want recommendations for.

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendation_service - The specific service that you want recommendations for.

Request Lenses

getReservationPurchaseRecommendation_accountId :: Lens' GetReservationPurchaseRecommendation (Maybe Text) Source #

The account ID that's associated with the recommendation.

getReservationPurchaseRecommendation_accountScope :: Lens' GetReservationPurchaseRecommendation (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.

getReservationPurchaseRecommendation_filter :: Lens' GetReservationPurchaseRecommendation (Maybe Expression) Source #

Undocumented member.

getReservationPurchaseRecommendation_lookbackPeriodInDays :: Lens' GetReservationPurchaseRecommendation (Maybe LookbackPeriodInDays) Source #

The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

getReservationPurchaseRecommendation_nextPageToken :: Lens' GetReservationPurchaseRecommendation (Maybe Text) Source #

The pagination token that indicates the next set of results that you want to retrieve.

getReservationPurchaseRecommendation_pageSize :: Lens' GetReservationPurchaseRecommendation (Maybe Natural) Source #

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

getReservationPurchaseRecommendation_paymentOption :: Lens' GetReservationPurchaseRecommendation (Maybe PaymentOption) Source #

The reservation purchase option that you want recommendations for.

getReservationPurchaseRecommendation_serviceSpecification :: Lens' GetReservationPurchaseRecommendation (Maybe ServiceSpecification) Source #

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

getReservationPurchaseRecommendation_termInYears :: Lens' GetReservationPurchaseRecommendation (Maybe TermInYears) Source #

The reservation term that you want recommendations for.

getReservationPurchaseRecommendation_service :: Lens' GetReservationPurchaseRecommendation Text Source #

The specific service that you want recommendations for.

Destructuring the Response

data GetReservationPurchaseRecommendationResponse Source #

See: newGetReservationPurchaseRecommendationResponse smart constructor.

Constructors

GetReservationPurchaseRecommendationResponse'

Fields

metadata :: Maybe ReservationPurchaseRecommendationMetadata
Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.
nextPageToken :: Maybe Text
The pagination token for the next set of retrievable results.
recommendations :: Maybe [ReservationPurchaseRecommendation]
Recommendations for reservations to purchase.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetReservationPurchaseRecommendationResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Associated Types type Rep GetReservationPurchaseRecommendationResponse :: Type -> Type # Methods from :: GetReservationPurchaseRecommendationResponse -> Rep GetReservationPurchaseRecommendationResponse x # to :: Rep GetReservationPurchaseRecommendationResponse x -> GetReservationPurchaseRecommendationResponse #
Read GetReservationPurchaseRecommendationResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods readsPrec :: Int -> ReadS GetReservationPurchaseRecommendationResponse # readList :: ReadS [GetReservationPurchaseRecommendationResponse] # readPrec :: ReadPrec GetReservationPurchaseRecommendationResponse # readListPrec :: ReadPrec [GetReservationPurchaseRecommendationResponse] #
Show GetReservationPurchaseRecommendationResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods showsPrec :: Int -> GetReservationPurchaseRecommendationResponse -> ShowS # show :: GetReservationPurchaseRecommendationResponse -> String # showList :: [GetReservationPurchaseRecommendationResponse] -> ShowS #
NFData GetReservationPurchaseRecommendationResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods rnf :: GetReservationPurchaseRecommendationResponse -> () #
Eq GetReservationPurchaseRecommendationResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation Methods (==) :: GetReservationPurchaseRecommendationResponse -> GetReservationPurchaseRecommendationResponse -> Bool # (/=) :: GetReservationPurchaseRecommendationResponse -> GetReservationPurchaseRecommendationResponse -> Bool #
type Rep GetReservationPurchaseRecommendationResponse Source #
Instance details Defined in Amazonka.CostExplorer.GetReservationPurchaseRecommendation type Rep GetReservationPurchaseRecommendationResponse = D1 ('MetaData "GetReservationPurchaseRecommendationResponse" "Amazonka.CostExplorer.GetReservationPurchaseRecommendation" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetReservationPurchaseRecommendationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReservationPurchaseRecommendationMetadata)) :: S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "recommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservationPurchaseRecommendation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetReservationPurchaseRecommendationResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetReservationPurchaseRecommendationResponse'`
-> GetReservationPurchaseRecommendationResponse

Create a value of GetReservationPurchaseRecommendationResponse 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:GetReservationPurchaseRecommendationResponse', getReservationPurchaseRecommendationResponse_metadata - Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.

GetReservationPurchaseRecommendation, getReservationPurchaseRecommendationResponse_nextPageToken - The pagination token for the next set of retrievable results.

$sel:recommendations:GetReservationPurchaseRecommendationResponse', getReservationPurchaseRecommendationResponse_recommendations - Recommendations for reservations to purchase.

$sel:httpStatus:GetReservationPurchaseRecommendationResponse', getReservationPurchaseRecommendationResponse_httpStatus - The response's http status code.

Response Lenses

getReservationPurchaseRecommendationResponse_metadata :: Lens' GetReservationPurchaseRecommendationResponse (Maybe ReservationPurchaseRecommendationMetadata) Source #

Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.

getReservationPurchaseRecommendationResponse_nextPageToken :: Lens' GetReservationPurchaseRecommendationResponse (Maybe Text) Source #

The pagination token for the next set of retrievable results.

getReservationPurchaseRecommendationResponse_recommendations :: Lens' GetReservationPurchaseRecommendationResponse (Maybe [ReservationPurchaseRecommendation]) Source #

Recommendations for reservations to purchase.

getReservationPurchaseRecommendationResponse_httpStatus :: Lens' GetReservationPurchaseRecommendationResponse Int Source #

The response's http status code.