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.ComputeOptimizer.GetEC2InstanceRecommendations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns Amazon EC2 instance recommendations.

Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

Synopsis

Creating a Request

data GetEC2InstanceRecommendations Source #

See: newGetEC2InstanceRecommendations smart constructor.

Constructors

GetEC2InstanceRecommendations'

Fields

accountIds :: Maybe [Text]
The ID of the Amazon Web Services account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
filters :: Maybe [Filter]
An array of objects to specify a filter that returns a more specific list of instance recommendations.
instanceArns :: Maybe [Text]
The Amazon Resource Name (ARN) of the instances for which to return recommendations.
maxResults :: Maybe Natural
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
nextToken :: Maybe Text
The token to advance to the next page of instance recommendations.
recommendationPreferences :: Maybe RecommendationPreferences
An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.

Instances

Instances details

ToJSON GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods toJSON :: GetEC2InstanceRecommendations -> Value # toEncoding :: GetEC2InstanceRecommendations -> Encoding # toJSONList :: [GetEC2InstanceRecommendations] -> Value # toEncodingList :: [GetEC2InstanceRecommendations] -> Encoding #
ToHeaders GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods toHeaders :: GetEC2InstanceRecommendations -> [Header] #
ToPath GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods toPath :: GetEC2InstanceRecommendations -> ByteString #
ToQuery GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods toQuery :: GetEC2InstanceRecommendations -> QueryString #
AWSRequest GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Associated Types type AWSResponse GetEC2InstanceRecommendations # Methods request :: (Service -> Service) -> GetEC2InstanceRecommendations -> Request GetEC2InstanceRecommendations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetEC2InstanceRecommendations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEC2InstanceRecommendations))) #
Generic GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Associated Types type Rep GetEC2InstanceRecommendations :: Type -> Type # Methods from :: GetEC2InstanceRecommendations -> Rep GetEC2InstanceRecommendations x # to :: Rep GetEC2InstanceRecommendations x -> GetEC2InstanceRecommendations #
Read GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods readsPrec :: Int -> ReadS GetEC2InstanceRecommendations # readList :: ReadS [GetEC2InstanceRecommendations] # readPrec :: ReadPrec GetEC2InstanceRecommendations # readListPrec :: ReadPrec [GetEC2InstanceRecommendations] #
Show GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods showsPrec :: Int -> GetEC2InstanceRecommendations -> ShowS # show :: GetEC2InstanceRecommendations -> String # showList :: [GetEC2InstanceRecommendations] -> ShowS #
NFData GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods rnf :: GetEC2InstanceRecommendations -> () #
Eq GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods (==) :: GetEC2InstanceRecommendations -> GetEC2InstanceRecommendations -> Bool # (/=) :: GetEC2InstanceRecommendations -> GetEC2InstanceRecommendations -> Bool #
Hashable GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods hashWithSalt :: Int -> GetEC2InstanceRecommendations -> Int # hash :: GetEC2InstanceRecommendations -> Int #
type AWSResponse GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations type AWSResponse GetEC2InstanceRecommendations = GetEC2InstanceRecommendationsResponse
type Rep GetEC2InstanceRecommendations Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations type Rep GetEC2InstanceRecommendations = D1 ('MetaData "GetEC2InstanceRecommendations" "Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetEC2InstanceRecommendations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "instanceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recommendationPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationPreferences))))))

newGetEC2InstanceRecommendations :: GetEC2InstanceRecommendations Source #

Create a value of GetEC2InstanceRecommendations 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:accountIds:GetEC2InstanceRecommendations', getEC2InstanceRecommendations_accountIds - The ID of the Amazon Web Services account for which to return instance recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.

Only one account ID can be specified per request.

$sel:filters:GetEC2InstanceRecommendations', getEC2InstanceRecommendations_filters - An array of objects to specify a filter that returns a more specific list of instance recommendations.

$sel:instanceArns:GetEC2InstanceRecommendations', getEC2InstanceRecommendations_instanceArns - The Amazon Resource Name (ARN) of the instances for which to return recommendations.

$sel:maxResults:GetEC2InstanceRecommendations', getEC2InstanceRecommendations_maxResults - The maximum number of instance recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

GetEC2InstanceRecommendations, getEC2InstanceRecommendations_nextToken - The token to advance to the next page of instance recommendations.

$sel:recommendationPreferences:GetEC2InstanceRecommendations', getEC2InstanceRecommendations_recommendationPreferences - An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.

Request Lenses

getEC2InstanceRecommendations_accountIds :: Lens' GetEC2InstanceRecommendations (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return instance recommendations.

If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.

Only one account ID can be specified per request.

getEC2InstanceRecommendations_filters :: Lens' GetEC2InstanceRecommendations (Maybe [Filter]) Source #

An array of objects to specify a filter that returns a more specific list of instance recommendations.

getEC2InstanceRecommendations_instanceArns :: Lens' GetEC2InstanceRecommendations (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the instances for which to return recommendations.

getEC2InstanceRecommendations_maxResults :: Lens' GetEC2InstanceRecommendations (Maybe Natural) Source #

The maximum number of instance recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

getEC2InstanceRecommendations_nextToken :: Lens' GetEC2InstanceRecommendations (Maybe Text) Source #

The token to advance to the next page of instance recommendations.

getEC2InstanceRecommendations_recommendationPreferences :: Lens' GetEC2InstanceRecommendations (Maybe RecommendationPreferences) Source #

An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.

Destructuring the Response

data GetEC2InstanceRecommendationsResponse Source #

See: newGetEC2InstanceRecommendationsResponse smart constructor.

Constructors

GetEC2InstanceRecommendationsResponse'

Fields

errors :: Maybe [GetRecommendationError]
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an instance of an unsupported instance family.
instanceRecommendations :: Maybe [InstanceRecommendation]
An array of objects that describe instance recommendations.
nextToken :: Maybe Text
The token to use to advance to the next page of instance recommendations.
This value is null when there are no more pages of instance recommendations to return.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetEC2InstanceRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Associated Types type Rep GetEC2InstanceRecommendationsResponse :: Type -> Type # Methods from :: GetEC2InstanceRecommendationsResponse -> Rep GetEC2InstanceRecommendationsResponse x # to :: Rep GetEC2InstanceRecommendationsResponse x -> GetEC2InstanceRecommendationsResponse #
Read GetEC2InstanceRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods readsPrec :: Int -> ReadS GetEC2InstanceRecommendationsResponse # readList :: ReadS [GetEC2InstanceRecommendationsResponse] # readPrec :: ReadPrec GetEC2InstanceRecommendationsResponse # readListPrec :: ReadPrec [GetEC2InstanceRecommendationsResponse] #
Show GetEC2InstanceRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods showsPrec :: Int -> GetEC2InstanceRecommendationsResponse -> ShowS # show :: GetEC2InstanceRecommendationsResponse -> String # showList :: [GetEC2InstanceRecommendationsResponse] -> ShowS #
NFData GetEC2InstanceRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods rnf :: GetEC2InstanceRecommendationsResponse -> () #
Eq GetEC2InstanceRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations Methods (==) :: GetEC2InstanceRecommendationsResponse -> GetEC2InstanceRecommendationsResponse -> Bool # (/=) :: GetEC2InstanceRecommendationsResponse -> GetEC2InstanceRecommendationsResponse -> Bool #
type Rep GetEC2InstanceRecommendationsResponse Source #
Instance details Defined in Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations type Rep GetEC2InstanceRecommendationsResponse = D1 ('MetaData "GetEC2InstanceRecommendationsResponse" "Amazonka.ComputeOptimizer.GetEC2InstanceRecommendations" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetEC2InstanceRecommendationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GetRecommendationError])) :: S1 ('MetaSel ('Just "instanceRecommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceRecommendation]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetEC2InstanceRecommendationsResponse Source #

Arguments

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

Create a value of GetEC2InstanceRecommendationsResponse 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:errors:GetEC2InstanceRecommendationsResponse', getEC2InstanceRecommendationsResponse_errors - An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an instance of an unsupported instance family.

$sel:instanceRecommendations:GetEC2InstanceRecommendationsResponse', getEC2InstanceRecommendationsResponse_instanceRecommendations - An array of objects that describe instance recommendations.

GetEC2InstanceRecommendations, getEC2InstanceRecommendationsResponse_nextToken - The token to use to advance to the next page of instance recommendations.

This value is null when there are no more pages of instance recommendations to return.

$sel:httpStatus:GetEC2InstanceRecommendationsResponse', getEC2InstanceRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

getEC2InstanceRecommendationsResponse_errors :: Lens' GetEC2InstanceRecommendationsResponse (Maybe [GetRecommendationError]) Source #

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an instance of an unsupported instance family.

getEC2InstanceRecommendationsResponse_instanceRecommendations :: Lens' GetEC2InstanceRecommendationsResponse (Maybe [InstanceRecommendation]) Source #

An array of objects that describe instance recommendations.

getEC2InstanceRecommendationsResponse_nextToken :: Lens' GetEC2InstanceRecommendationsResponse (Maybe Text) Source #

The token to use to advance to the next page of instance recommendations.

This value is null when there are no more pages of instance recommendations to return.

getEC2InstanceRecommendationsResponse_httpStatus :: Lens' GetEC2InstanceRecommendationsResponse Int Source #

The response's http status code.