getEC2InstanceRecommendations method

Future<GetEC2InstanceRecommendationsResponse> getEC2InstanceRecommendations({ List<String>? accountIds, List<Filter>? filters, List<String>? instanceArns, int? maxResults, String? nextToken, RecommendationPreferences? recommendationPreferences, })

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.

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

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

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

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

Parameter nextToken : The token to advance to the next page of instance recommendations.

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

Implementation

Future<GetEC2InstanceRecommendationsResponse> getEC2InstanceRecommendations({
  List<String>? accountIds,
  List<Filter>? filters,
  List<String>? instanceArns,
  int? maxResults,
  String? nextToken,
  RecommendationPreferences? recommendationPreferences,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    0,
    1000,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'ComputeOptimizerService.GetEC2InstanceRecommendations'
  };
  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 (instanceArns != null) 'instanceArns': instanceArns,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
      if (recommendationPreferences != null)
        'recommendationPreferences': recommendationPreferences,
    },
  );

  return GetEC2InstanceRecommendationsResponse.fromJson(jsonResponse.body);
}