Get Idle Recommendations

computeoptimizer_get_idle_recommendations

R Documentation

Returns idle resource recommendations

Description

Returns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the Compute Optimizer User Guide

Usage

computeoptimizer_get_idle_recommendations(resourceArns, nextToken,
  maxResults, filters, accountIds, orderBy)

Arguments

resourceArns

The ARN that identifies the idle resource.

nextToken

The token to advance to the next page of idle resource recommendations.

maxResults

The maximum number of idle resource 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 idle resource recommendations.

accountIds

Return the idle resource 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 idle resource recommendations to specific member accounts.

You can only specify one account ID per request.

orderBy

The order to sort the idle resource recommendations.

Value

A list with the following syntax:

list(
  nextToken = "string",
  idleRecommendations = list(
    list(
      resourceArn = "string",
      resourceId = "string",
      resourceType = "EC2Instance"|"AutoScalingGroup"|"EBSVolume"|"ECSService"|"RDSDBInstance",
      accountId = "string",
      finding = "Idle"|"Unattached",
      findingDescription = "string",
      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
        )
      ),
      utilizationMetrics = list(
        list(
          name = "CPU"|"Memory"|"NetworkOutBytesPerSecond"|"NetworkInBytesPerSecond"|"DatabaseConnections"|"EBSVolumeReadIOPS"|"EBSVolumeWriteIOPS"|"VolumeReadOpsPerSecond"|"VolumeWriteOpsPerSecond",
          statistic = "Maximum"|"Average",
          value = 123.0
        )
      ),
      lookBackPeriodInDays = 123.0,
      lastRefreshTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  ),
  errors = list(
    list(
      identifier = "string",
      code = "string",
      message = "string",
      resourceType = "EC2Instance"|"AutoScalingGroup"|"EBSVolume"|"ECSService"|"RDSDBInstance"
    )
  )
)

Request syntax

svc$get_idle_recommendations(
  resourceArns = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123,
  filters = list(
    list(
      name = "Finding"|"ResourceType",
      values = list(
        "string"
      )
    )
  ),
  accountIds = list(
    "string"
  ),
  orderBy = list(
    dimension = "SavingsValue"|"SavingsValueAfterDiscount",
    order = "Asc"|"Desc"
  )
)