getEBSVolumeRecommendations method

Future<GetEBSVolumeRecommendationsResponse> getEBSVolumeRecommendations({ List<String>? accountIds, List<EBSFilter>? filters, int? maxResults, String? nextToken, List<String>? volumeArns, })

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

AWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

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

Parameter accountIds : The IDs of the AWS accounts for which to return volume recommendations.

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

Only one account ID can be specified per request.

Parameter filters : An array of objects that describe a filter that returns a more specific list of volume recommendations.

Parameter maxResults : The maximum number of volume 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 volume recommendations.

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

Implementation

Future<GetEBSVolumeRecommendationsResponse> getEBSVolumeRecommendations({
  List<String>? accountIds,
  List<EBSFilter>? filters,
  int? maxResults,
  String? nextToken,
  List<String>? volumeArns,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'ComputeOptimizerService.GetEBSVolumeRecommendations'
  };
  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 (volumeArns != null) 'volumeArns': volumeArns,
    },
  );

  return GetEBSVolumeRecommendationsResponse.fromJson(jsonResponse.body);
}