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

Description

Returns the optimization findings for an account.

It returns the number of:

  • Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized.
  • Auto Scaling groups in an account that are NotOptimized, or Optimized.
  • Amazon EBS volumes in an account that are NotOptimized, or Optimized.
  • Lambda functions in an account that are NotOptimized, or Optimized.
  • Amazon ECS services in an account that are Underprovisioned, Overprovisioned, or Optimized.

This operation returns paginated results.

Synopsis

Creating a Request

data GetRecommendationSummaries Source #

See: newGetRecommendationSummaries smart constructor.

Constructors

GetRecommendationSummaries' 

Fields

  • accountIds :: Maybe [Text]

    The ID of the Amazon Web Services account for which to return recommendation summaries.

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

    Only one account ID can be specified per request.

  • maxResults :: Maybe Natural

    The maximum number of recommendation summaries 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 recommendation summaries.

Instances

Instances details
ToJSON GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

ToHeaders GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

ToPath GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

ToQuery GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

AWSPager GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

AWSRequest GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Generic GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Associated Types

type Rep GetRecommendationSummaries :: Type -> Type #

Read GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Show GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

NFData GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Eq GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Hashable GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

type AWSResponse GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

type Rep GetRecommendationSummaries Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

type Rep GetRecommendationSummaries = D1 ('MetaData "GetRecommendationSummaries" "Amazonka.ComputeOptimizer.GetRecommendationSummaries" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetRecommendationSummaries'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountIds") '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)))))

newGetRecommendationSummaries :: GetRecommendationSummaries Source #

Create a value of GetRecommendationSummaries 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:GetRecommendationSummaries', getRecommendationSummaries_accountIds - The ID of the Amazon Web Services account for which to return recommendation summaries.

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

Only one account ID can be specified per request.

$sel:maxResults:GetRecommendationSummaries', getRecommendationSummaries_maxResults - The maximum number of recommendation summaries to return with a single request.

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

GetRecommendationSummaries, getRecommendationSummaries_nextToken - The token to advance to the next page of recommendation summaries.

Request Lenses

getRecommendationSummaries_accountIds :: Lens' GetRecommendationSummaries (Maybe [Text]) Source #

The ID of the Amazon Web Services account for which to return recommendation summaries.

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

Only one account ID can be specified per request.

getRecommendationSummaries_maxResults :: Lens' GetRecommendationSummaries (Maybe Natural) Source #

The maximum number of recommendation summaries to return with a single request.

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

getRecommendationSummaries_nextToken :: Lens' GetRecommendationSummaries (Maybe Text) Source #

The token to advance to the next page of recommendation summaries.

Destructuring the Response

data GetRecommendationSummariesResponse Source #

Constructors

GetRecommendationSummariesResponse' 

Fields

Instances

Instances details
Generic GetRecommendationSummariesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Associated Types

type Rep GetRecommendationSummariesResponse :: Type -> Type #

Read GetRecommendationSummariesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Show GetRecommendationSummariesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

NFData GetRecommendationSummariesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

Eq GetRecommendationSummariesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

type Rep GetRecommendationSummariesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetRecommendationSummaries

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

newGetRecommendationSummariesResponse Source #

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

GetRecommendationSummaries, getRecommendationSummariesResponse_nextToken - The token to use to advance to the next page of recommendation summaries.

This value is null when there are no more pages of recommendation summaries to return.

$sel:recommendationSummaries:GetRecommendationSummariesResponse', getRecommendationSummariesResponse_recommendationSummaries - An array of objects that summarize a recommendation.

$sel:httpStatus:GetRecommendationSummariesResponse', getRecommendationSummariesResponse_httpStatus - The response's http status code.

Response Lenses

getRecommendationSummariesResponse_nextToken :: Lens' GetRecommendationSummariesResponse (Maybe Text) Source #

The token to use to advance to the next page of recommendation summaries.

This value is null when there are no more pages of recommendation summaries to return.