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

Description

Returns Amazon ECS service recommendations.

Compute Optimizer generates recommendations for Amazon ECS services on Fargate 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 GetECSServiceRecommendations Source #

See: newGetECSServiceRecommendations smart constructor.

Constructors

GetECSServiceRecommendations' 

Fields

  • accountIds :: Maybe [Text]

    Return the ECS service recommendations to the specified Amazon Web Services account IDs.

    If your account is the management account or the delegated administrator of an organization, use this parameter to return the ECS service recommendations to specific member accounts.

    You can only specify one account ID per request.

  • filters :: Maybe [ECSServiceRecommendationFilter]

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

  • maxResults :: Maybe Natural

    The maximum number of ECS service 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 ECS service recommendations.

  • serviceArns :: Maybe [Text]

    The ARN that identifies the ECS service.

    The following is the format of the ARN:

    arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

Instances

Instances details
ToJSON GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

toJSON :: GetECSServiceRecommendations -> Value #

toEncoding :: GetECSServiceRecommendations -> Encoding #

toJSONList :: [GetECSServiceRecommendations] -> Value #

toEncodingList :: [GetECSServiceRecommendations] -> Encoding #

ToHeaders GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

toHeaders :: GetECSServiceRecommendations -> [Header] #

ToPath GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

toPath :: GetECSServiceRecommendations -> ByteString #

ToQuery GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

toQuery :: GetECSServiceRecommendations -> QueryString #

AWSRequest GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Associated Types

type AWSResponse GetECSServiceRecommendations #

Methods

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

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

Generic GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Associated Types

type Rep GetECSServiceRecommendations :: Type -> Type #

Methods

from :: GetECSServiceRecommendations -> Rep GetECSServiceRecommendations x #

to :: Rep GetECSServiceRecommendations x -> GetECSServiceRecommendations #

Read GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

readsPrec :: Int -> ReadS GetECSServiceRecommendations #

readList :: ReadS [GetECSServiceRecommendations] #

readPrec :: ReadPrec GetECSServiceRecommendations #

readListPrec :: ReadPrec [GetECSServiceRecommendations] #

Show GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

showsPrec :: Int -> GetECSServiceRecommendations -> ShowS #

show :: GetECSServiceRecommendations -> String #

showList :: [GetECSServiceRecommendations] -> ShowS #

NFData GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

rnf :: GetECSServiceRecommendations -> () #

Eq GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

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

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

Hashable GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

hashWithSalt :: Int -> GetECSServiceRecommendations -> Int #

hash :: GetECSServiceRecommendations -> Int #

type AWSResponse GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

type AWSResponse GetECSServiceRecommendations = GetECSServiceRecommendationsResponse
type Rep GetECSServiceRecommendations Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

type Rep GetECSServiceRecommendations = D1 ('MetaData "GetECSServiceRecommendations" "Amazonka.ComputeOptimizer.GetECSServiceRecommendations" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetECSServiceRecommendations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ECSServiceRecommendationFilter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newGetECSServiceRecommendations :: GetECSServiceRecommendations Source #

Create a value of GetECSServiceRecommendations 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:GetECSServiceRecommendations', getECSServiceRecommendations_accountIds - Return the ECS service recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the ECS service recommendations to specific member accounts.

You can only specify one account ID per request.

$sel:filters:GetECSServiceRecommendations', getECSServiceRecommendations_filters - An array of objects to specify a filter that returns a more specific list of ECS service recommendations.

$sel:maxResults:GetECSServiceRecommendations', getECSServiceRecommendations_maxResults - The maximum number of ECS service recommendations to return with a single request.

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

GetECSServiceRecommendations, getECSServiceRecommendations_nextToken - The token to advance to the next page of ECS service recommendations.

$sel:serviceArns:GetECSServiceRecommendations', getECSServiceRecommendations_serviceArns - The ARN that identifies the ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

Request Lenses

getECSServiceRecommendations_accountIds :: Lens' GetECSServiceRecommendations (Maybe [Text]) Source #

Return the ECS service recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the ECS service recommendations to specific member accounts.

You can only specify one account ID per request.

getECSServiceRecommendations_filters :: Lens' GetECSServiceRecommendations (Maybe [ECSServiceRecommendationFilter]) Source #

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

getECSServiceRecommendations_maxResults :: Lens' GetECSServiceRecommendations (Maybe Natural) Source #

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

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

getECSServiceRecommendations_nextToken :: Lens' GetECSServiceRecommendations (Maybe Text) Source #

The token to advance to the next page of ECS service recommendations.

getECSServiceRecommendations_serviceArns :: Lens' GetECSServiceRecommendations (Maybe [Text]) Source #

The ARN that identifies the ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

Destructuring the Response

data GetECSServiceRecommendationsResponse Source #

See: newGetECSServiceRecommendationsResponse smart constructor.

Constructors

GetECSServiceRecommendationsResponse' 

Fields

Instances

Instances details
Generic GetECSServiceRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Associated Types

type Rep GetECSServiceRecommendationsResponse :: Type -> Type #

Methods

from :: GetECSServiceRecommendationsResponse -> Rep GetECSServiceRecommendationsResponse x #

to :: Rep GetECSServiceRecommendationsResponse x -> GetECSServiceRecommendationsResponse #

Read GetECSServiceRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

readsPrec :: Int -> ReadS GetECSServiceRecommendationsResponse #

readList :: ReadS [GetECSServiceRecommendationsResponse] #

readPrec :: ReadPrec GetECSServiceRecommendationsResponse #

readListPrec :: ReadPrec [GetECSServiceRecommendationsResponse] #

Show GetECSServiceRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

showsPrec :: Int -> GetECSServiceRecommendationsResponse -> ShowS #

show :: GetECSServiceRecommendationsResponse -> String #

showList :: [GetECSServiceRecommendationsResponse] -> ShowS #

NFData GetECSServiceRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

rnf :: GetECSServiceRecommendationsResponse -> () #

Eq GetECSServiceRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

Methods

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

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

type Rep GetECSServiceRecommendationsResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetECSServiceRecommendations

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

newGetECSServiceRecommendationsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetECSServiceRecommendationsResponse'

-> GetECSServiceRecommendationsResponse 

Create a value of GetECSServiceRecommendationsResponse 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:ecsServiceRecommendations:GetECSServiceRecommendationsResponse', getECSServiceRecommendationsResponse_ecsServiceRecommendations - An array of objects that describe the ECS service recommendations.

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

GetECSServiceRecommendations, getECSServiceRecommendationsResponse_nextToken - The token to advance to the next page of ECS service recommendations.

$sel:httpStatus:GetECSServiceRecommendationsResponse', getECSServiceRecommendationsResponse_httpStatus - The response's http status code.

Response Lenses

getECSServiceRecommendationsResponse_ecsServiceRecommendations :: Lens' GetECSServiceRecommendationsResponse (Maybe [ECSServiceRecommendation]) Source #

An array of objects that describe the ECS service recommendations.

getECSServiceRecommendationsResponse_errors :: Lens' GetECSServiceRecommendationsResponse (Maybe [GetRecommendationError]) Source #

An array of objects that describe errors of the request.

getECSServiceRecommendationsResponse_nextToken :: Lens' GetECSServiceRecommendationsResponse (Maybe Text) Source #

The token to advance to the next page of ECS service recommendations.

getECSServiceRecommendationsResponse_httpStatus :: Lens' GetECSServiceRecommendationsResponse Int Source #

The response's http status code.