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

Description¶

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

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 Compute Optimizer User Guide.

Usage¶

computeoptimizer_get_ebs_volume_recommendations(volumeArns, nextToken,
  maxResults, filters, accountIds)

Arguments¶

volumeArns

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

The token to advance to the next page of volume recommendations.
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.
filters

An array of objects to specify a filter that returns a more specific list of volume recommendations.
accountIds

The ID of the Amazon Web Services account for which to return volume 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 volume recommendations.

Only one account ID can be specified per request.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  volumeRecommendations = list(
    list(
      volumeArn = "string",
      accountId = "string",
      currentConfiguration = list(
        volumeType = "string",
        volumeSize = 123,
        volumeBaselineIOPS = 123,
        volumeBurstIOPS = 123,
        volumeBaselineThroughput = 123,
        volumeBurstThroughput = 123,
        rootVolume = TRUE|FALSE
      ),
      finding = "Optimized"|"NotOptimized",
      utilizationMetrics = list(
        list(
          name = "VolumeReadOpsPerSecond"|"VolumeWriteOpsPerSecond"|"VolumeReadBytesPerSecond"|"VolumeWriteBytesPerSecond"|"VolumeIOPSExceeded"|"VolumeThroughputExceeded",
          statistic = "Maximum"|"Average",
          value = 123.0
        )
      ),
      lookBackPeriodInDays = 123.0,
      volumeRecommendationOptions = list(
        list(
          configuration = list(
            volumeType = "string",
            volumeSize = 123,
            volumeBaselineIOPS = 123,
            volumeBurstIOPS = 123,
            volumeBaselineThroughput = 123,
            volumeBurstThroughput = 123,
            rootVolume = TRUE|FALSE
          ),
          performanceRisk = 123.0,
          rank = 123,
          savingsOpportunity = list(
            savingsOpportunityPercentage = 123.0,
            estimatedMonthlySavings = list(
              currency = "USD"|"CNY",
              value = 123.0
            )
          ),
          savingsOpportunityAfterDiscounts = list(
            savingsOpportunityPercentage = 123.0,
            estimatedMonthlySavings = list(
              currency = "USD"|"CNY",
              value = 123.0
            )
          )
        )
      ),
      lastRefreshTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      currentPerformanceRisk = "VeryLow"|"Low"|"Medium"|"High",
      effectiveRecommendationPreferences = list(
        savingsEstimationMode = list(
          source = "PublicPricing"|"CostExplorerRightsizing"|"CostOptimizationHub"
        ),
        lookBackPeriod = "DAYS_14"|"DAYS_32"|"DAYS_93"
      ),
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  ),
  errors = list(
    list(
      identifier = "string",
      code = "string",
      message = "string"
    )
  )
)

Request syntax¶

svc$get_ebs_volume_recommendations(
  volumeArns = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123,
  filters = list(
    list(
      name = "Finding",
      values = list(
        "string"
      )
    )
  ),
  accountIds = list(
    "string"
  )
)