amazonka-compute-optimizer-2.0: Amazon Compute Optimizer SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Description

Returns Auto Scaling group recommendations.

Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups 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 GetAutoScalingGroupRecommendations Source #

See: newGetAutoScalingGroupRecommendations smart constructor.

Constructors

GetAutoScalingGroupRecommendations' 

Fields

  • accountIds :: Maybe [Text]

    The ID of the Amazon Web Services account for which to return Auto Scaling group 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 Auto Scaling group recommendations.

    Only one account ID can be specified per request.

  • autoScalingGroupArns :: Maybe [Text]

    The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

  • filters :: Maybe [Filter]

    An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

  • maxResults :: Maybe Natural

    The maximum number of Auto Scaling group 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 Auto Scaling group recommendations.

  • recommendationPreferences :: Maybe RecommendationPreferences

    An object to specify the preferences for the Auto Scaling group recommendations to return in the response.

Instances

Instances details
ToJSON GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

toJSON :: GetAutoScalingGroupRecommendations -> Value #

toEncoding :: GetAutoScalingGroupRecommendations -> Encoding #

toJSONList :: [GetAutoScalingGroupRecommendations] -> Value #

toEncodingList :: [GetAutoScalingGroupRecommendations] -> Encoding #

ToHeaders GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

toHeaders :: GetAutoScalingGroupRecommendations -> [Header] #

ToPath GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

toPath :: GetAutoScalingGroupRecommendations -> ByteString #

ToQuery GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

toQuery :: GetAutoScalingGroupRecommendations -> QueryString #

AWSRequest GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Associated Types

type AWSResponse GetAutoScalingGroupRecommendations #

Methods

request :: (Service -> Service) -> GetAutoScalingGroupRecommendations -> Request GetAutoScalingGroupRecommendations #

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

Generic GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Associated Types

type Rep GetAutoScalingGroupRecommendations :: Type -> Type #

Methods

from :: GetAutoScalingGroupRecommendations -> Rep GetAutoScalingGroupRecommendations x #

to :: Rep GetAutoScalingGroupRecommendations x -> GetAutoScalingGroupRecommendations #

Read GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

readsPrec :: Int -> ReadS GetAutoScalingGroupRecommendations #

readList :: ReadS [GetAutoScalingGroupRecommendations] #

readPrec :: ReadPrec GetAutoScalingGroupRecommendations #

readListPrec :: ReadPrec [GetAutoScalingGroupRecommendations] #

Show GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

showsPrec :: Int -> GetAutoScalingGroupRecommendations -> ShowS #

show :: GetAutoScalingGroupRecommendations -> String #

showList :: [GetAutoScalingGroupRecommendations] -> ShowS #

NFData GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

rnf :: GetAutoScalingGroupRecommendations -> () #

Eq GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

(==) :: GetAutoScalingGroupRecommendations -> GetAutoScalingGroupRecommendations -> Bool #

(/=) :: GetAutoScalingGroupRecommendations -> GetAutoScalingGroupRecommendations -> Bool #

Hashable GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

hashWithSalt :: Int -> GetAutoScalingGroupRecommendations -> Int #

hash :: GetAutoScalingGroupRecommendations -> Int #

type AWSResponse GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

type AWSResponse GetAutoScalingGroupRecommendations = GetAutoScalingGroupRecommendationsResponse
type Rep GetAutoScalingGroupRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

type Rep GetAutoScalingGroupRecommendations = D1 ('MetaData "GetAutoScalingGroupRecommendations" "Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetAutoScalingGroupRecommendations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "autoScalingGroupArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :*: (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))))))

newGetAutoScalingGroupRecommendations :: GetAutoScalingGroupRecommendations Source #

Create a value of GetAutoScalingGroupRecommendations 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:GetAutoScalingGroupRecommendations', getAutoScalingGroupRecommendations_accountIds - The ID of the Amazon Web Services account for which to return Auto Scaling group 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 Auto Scaling group recommendations.

Only one account ID can be specified per request.

$sel:autoScalingGroupArns:GetAutoScalingGroupRecommendations', getAutoScalingGroupRecommendations_autoScalingGroupArns - The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

$sel:filters:GetAutoScalingGroupRecommendations', getAutoScalingGroupRecommendations_filters - An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

$sel:maxResults:GetAutoScalingGroupRecommendations', getAutoScalingGroupRecommendations_maxResults - The maximum number of Auto Scaling group recommendations to return with a single request.

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

GetAutoScalingGroupRecommendations, getAutoScalingGroupRecommendations_nextToken - The token to advance to the next page of Auto Scaling group recommendations.

$sel:recommendationPreferences:GetAutoScalingGroupRecommendations', getAutoScalingGroupRecommendations_recommendationPreferences - An object to specify the preferences for the Auto Scaling group recommendations to return in the response.

Request Lenses

getAutoScalingGroupRecommendations_accountIds :: Lens' GetAutoScalingGroupRecommendations (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return Auto Scaling group 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 Auto Scaling group recommendations.

Only one account ID can be specified per request.

getAutoScalingGroupRecommendations_autoScalingGroupArns :: Lens' GetAutoScalingGroupRecommendations (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.

getAutoScalingGroupRecommendations_filters :: Lens' GetAutoScalingGroupRecommendations (Maybe [Filter]) Source #

An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

getAutoScalingGroupRecommendations_maxResults :: Lens' GetAutoScalingGroupRecommendations (Maybe Natural) Source #

The maximum number of Auto Scaling group recommendations to return with a single request.

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

getAutoScalingGroupRecommendations_nextToken :: Lens' GetAutoScalingGroupRecommendations (Maybe Text) Source #

The token to advance to the next page of Auto Scaling group recommendations.

getAutoScalingGroupRecommendations_recommendationPreferences :: Lens' GetAutoScalingGroupRecommendations (Maybe RecommendationPreferences) Source #

An object to specify the preferences for the Auto Scaling group recommendations to return in the response.

Destructuring the Response

data GetAutoScalingGroupRecommendationsResponse Source #

See: newGetAutoScalingGroupRecommendationsResponse smart constructor.

Constructors

GetAutoScalingGroupRecommendationsResponse' 

Fields

Instances

Instances details
Generic GetAutoScalingGroupRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Associated Types

type Rep GetAutoScalingGroupRecommendationsResponse :: Type -> Type #

Methods

from :: GetAutoScalingGroupRecommendationsResponse -> Rep GetAutoScalingGroupRecommendationsResponse x #

to :: Rep GetAutoScalingGroupRecommendationsResponse x -> GetAutoScalingGroupRecommendationsResponse #

Read GetAutoScalingGroupRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

readsPrec :: Int -> ReadS GetAutoScalingGroupRecommendationsResponse #

readList :: ReadS [GetAutoScalingGroupRecommendationsResponse] #

readPrec :: ReadPrec GetAutoScalingGroupRecommendationsResponse #

readListPrec :: ReadPrec [GetAutoScalingGroupRecommendationsResponse] #

Show GetAutoScalingGroupRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

showsPrec :: Int -> GetAutoScalingGroupRecommendationsResponse -> ShowS #

show :: GetAutoScalingGroupRecommendationsResponse -> String #

showList :: [GetAutoScalingGroupRecommendationsResponse] -> ShowS #

NFData GetAutoScalingGroupRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

rnf :: GetAutoScalingGroupRecommendationsResponse -> () #

Eq GetAutoScalingGroupRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

Methods

(==) :: GetAutoScalingGroupRecommendationsResponse -> GetAutoScalingGroupRecommendationsResponse -> Bool #

(/=) :: GetAutoScalingGroupRecommendationsResponse -> GetAutoScalingGroupRecommendationsResponse -> Bool #

type Rep GetAutoScalingGroupRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations

type Rep GetAutoScalingGroupRecommendationsResponse = D1 ('MetaData "GetAutoScalingGroupRecommendationsResponse" "Amazonka.ComputeOptimizer.GetAutoScalingGroupRecommendations" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetAutoScalingGroupRecommendationsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoScalingGroupRecommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AutoScalingGroupRecommendation])) :*: S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GetRecommendationError]))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetAutoScalingGroupRecommendationsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetAutoScalingGroupRecommendationsResponse'

-> GetAutoScalingGroupRecommendationsResponse 

Create a value of GetAutoScalingGroupRecommendationsResponse 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:autoScalingGroupRecommendations:GetAutoScalingGroupRecommendationsResponse', getAutoScalingGroupRecommendationsResponse_autoScalingGroupRecommendations - An array of objects that describe Auto Scaling group recommendations.

$sel:errors:GetAutoScalingGroupRecommendationsResponse', getAutoScalingGroupRecommendationsResponse_errors - An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.

GetAutoScalingGroupRecommendations, getAutoScalingGroupRecommendationsResponse_nextToken - The token to use to advance to the next page of Auto Scaling group recommendations.

This value is null when there are no more pages of Auto Scaling group recommendations to return.

$sel:httpStatus:GetAutoScalingGroupRecommendationsResponse', getAutoScalingGroupRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

getAutoScalingGroupRecommendationsResponse_autoScalingGroupRecommendations :: Lens' GetAutoScalingGroupRecommendationsResponse (Maybe [AutoScalingGroupRecommendation]) Source #

An array of objects that describe Auto Scaling group recommendations.

getAutoScalingGroupRecommendationsResponse_errors :: Lens' GetAutoScalingGroupRecommendationsResponse (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 unsupported Auto Scaling group.

getAutoScalingGroupRecommendationsResponse_nextToken :: Lens' GetAutoScalingGroupRecommendationsResponse (Maybe Text) Source #

The token to use to advance to the next page of Auto Scaling group recommendations.

This value is null when there are no more pages of Auto Scaling group recommendations to return.

getAutoScalingGroupRecommendationsResponse_httpStatus :: Lens' GetAutoScalingGroupRecommendationsResponse Int Source #

The response's http status code.