getECSServiceRecommendations method

Future<GetECSServiceRecommendationsResponse> getECSServiceRecommendations({ List<String>? accountIds, List<ECSServiceRecommendationFilter>? filters, int? maxResults, String? nextToken, List<String>? serviceArns, })

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.

May throw AccessDeniedException. May throw InternalServerException. May throw InvalidParameterValueException. May throw MissingAuthenticationToken. May throw OptInRequiredException. May throw ResourceNotFoundException. May throw ServiceUnavailableException. May throw ThrottlingException.

Parameter accountIds : Return the Amazon 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 Amazon ECS service recommendations to specific member accounts.

You can only specify one account ID per request.

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

Parameter maxResults : The maximum number of Amazon ECS service recommendations to return with a single request.

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

Parameter nextToken : The token to advance to the next page of Amazon ECS service recommendations.

Parameter serviceArns : The ARN that identifies the Amazon ECS service.

The following is the format of the ARN:

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

Implementation

Future<GetECSServiceRecommendationsResponse> getECSServiceRecommendations({
  List<String>? accountIds,
  List<ECSServiceRecommendationFilter>? filters,
  int? maxResults,
  String? nextToken,
  List<String>? serviceArns,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    0,
    1000,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'ComputeOptimizerService.GetECSServiceRecommendations'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (accountIds != null) 'accountIds': accountIds,
      if (filters != null) 'filters': filters,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
      if (serviceArns != null) 'serviceArns': serviceArns,
    },
  );

  return GetECSServiceRecommendationsResponse.fromJson(jsonResponse.body);
}