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.GetRightsizingRecommendation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.

Synopsis

Creating a Request

data GetRightsizingRecommendation Source #

See: newGetRightsizingRecommendation smart constructor.

Constructors

GetRightsizingRecommendation'

Fields

configuration :: Maybe RightsizingRecommendationConfiguration
You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
filter' :: Maybe Expression
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.
service :: Text
The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2".

Instances

Instances details

ToJSON GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods toJSON :: GetRightsizingRecommendation -> Value # toEncoding :: GetRightsizingRecommendation -> Encoding # toJSONList :: [GetRightsizingRecommendation] -> Value # toEncodingList :: [GetRightsizingRecommendation] -> Encoding #
ToHeaders GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods toHeaders :: GetRightsizingRecommendation -> [Header] #
ToPath GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods toPath :: GetRightsizingRecommendation -> ByteString #
ToQuery GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods toQuery :: GetRightsizingRecommendation -> QueryString #
AWSRequest GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Associated Types type AWSResponse GetRightsizingRecommendation # Methods request :: (Service -> Service) -> GetRightsizingRecommendation -> Request GetRightsizingRecommendation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRightsizingRecommendation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRightsizingRecommendation))) #
Generic GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Associated Types type Rep GetRightsizingRecommendation :: Type -> Type # Methods from :: GetRightsizingRecommendation -> Rep GetRightsizingRecommendation x # to :: Rep GetRightsizingRecommendation x -> GetRightsizingRecommendation #
Read GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods readsPrec :: Int -> ReadS GetRightsizingRecommendation # readList :: ReadS [GetRightsizingRecommendation] # readPrec :: ReadPrec GetRightsizingRecommendation # readListPrec :: ReadPrec [GetRightsizingRecommendation] #
Show GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods showsPrec :: Int -> GetRightsizingRecommendation -> ShowS # show :: GetRightsizingRecommendation -> String # showList :: [GetRightsizingRecommendation] -> ShowS #
NFData GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods rnf :: GetRightsizingRecommendation -> () #
Eq GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods (==) :: GetRightsizingRecommendation -> GetRightsizingRecommendation -> Bool # (/=) :: GetRightsizingRecommendation -> GetRightsizingRecommendation -> Bool #
Hashable GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation Methods hashWithSalt :: Int -> GetRightsizingRecommendation -> Int # hash :: GetRightsizingRecommendation -> Int #
type AWSResponse GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation type AWSResponse GetRightsizingRecommendation = GetRightsizingRecommendationResponse
type Rep GetRightsizingRecommendation Source #
Instance details Defined in Amazonka.CostExplorer.GetRightsizingRecommendation type Rep GetRightsizingRecommendation = D1 ('MetaData "GetRightsizingRecommendation" "Amazonka.CostExplorer.GetRightsizingRecommendation" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetRightsizingRecommendation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RightsizingRecommendationConfiguration)) :: 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 "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetRightsizingRecommendation Source #

Arguments

:: Text	`GetRightsizingRecommendation`
-> GetRightsizingRecommendation

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

GetRightsizingRecommendation, getRightsizingRecommendation_configuration - You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

$sel:filter':GetRightsizingRecommendation', getRightsizingRecommendation_filter - Undocumented member.

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

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

GetRightsizingRecommendation, getRightsizingRecommendation_service - The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2".

Request Lenses

getRightsizingRecommendation_configuration :: Lens' GetRightsizingRecommendation (Maybe RightsizingRecommendationConfiguration) Source #

You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

getRightsizingRecommendation_filter :: Lens' GetRightsizingRecommendation (Maybe Expression) Source #

Undocumented member.

getRightsizingRecommendation_nextPageToken :: Lens' GetRightsizingRecommendation (Maybe Text) Source #

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

getRightsizingRecommendation_pageSize :: Lens' GetRightsizingRecommendation (Maybe Natural) Source #

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

getRightsizingRecommendation_service :: Lens' GetRightsizingRecommendation Text Source #

The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2".

Destructuring the Response

data GetRightsizingRecommendationResponse Source #

See: newGetRightsizingRecommendationResponse smart constructor.

Constructors

GetRightsizingRecommendationResponse'

Fields

configuration :: Maybe RightsizingRecommendationConfiguration
You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.
metadata :: Maybe RightsizingRecommendationMetadata
Information regarding this specific recommendation set.
nextPageToken :: Maybe Text
The token to retrieve the next set of results.
rightsizingRecommendations :: Maybe [RightsizingRecommendation]
Recommendations to rightsize resources.
summary :: Maybe RightsizingRecommendationSummary
Summary of this recommendation set.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetRightsizingRecommendationResponse Source #

Arguments

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

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

GetRightsizingRecommendation, getRightsizingRecommendationResponse_configuration - You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

$sel:metadata:GetRightsizingRecommendationResponse', getRightsizingRecommendationResponse_metadata - Information regarding this specific recommendation set.

GetRightsizingRecommendation, getRightsizingRecommendationResponse_nextPageToken - The token to retrieve the next set of results.

$sel:rightsizingRecommendations:GetRightsizingRecommendationResponse', getRightsizingRecommendationResponse_rightsizingRecommendations - Recommendations to rightsize resources.

$sel:summary:GetRightsizingRecommendationResponse', getRightsizingRecommendationResponse_summary - Summary of this recommendation set.

$sel:httpStatus:GetRightsizingRecommendationResponse', getRightsizingRecommendationResponse_httpStatus - The response's http status code.

Response Lenses

getRightsizingRecommendationResponse_configuration :: Lens' GetRightsizingRecommendationResponse (Maybe RightsizingRecommendationConfiguration) Source #

You can use Configuration to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings that are associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

getRightsizingRecommendationResponse_metadata :: Lens' GetRightsizingRecommendationResponse (Maybe RightsizingRecommendationMetadata) Source #

Information regarding this specific recommendation set.

getRightsizingRecommendationResponse_nextPageToken :: Lens' GetRightsizingRecommendationResponse (Maybe Text) Source #

The token to retrieve the next set of results.

getRightsizingRecommendationResponse_rightsizingRecommendations :: Lens' GetRightsizingRecommendationResponse (Maybe [RightsizingRecommendation]) Source #

Recommendations to rightsize resources.

getRightsizingRecommendationResponse_summary :: Lens' GetRightsizingRecommendationResponse (Maybe RightsizingRecommendationSummary) Source #

Summary of this recommendation set.

getRightsizingRecommendationResponse_httpStatus :: Lens' GetRightsizingRecommendationResponse Int Source #

The response's http status code.