Get Rds Database Recommendations

computeoptimizer_get_rds_database_recommendations

R Documentation

Returns Amazon RDS recommendations

Description

Returns Amazon RDS recommendations.

Compute Optimizer generates recommendations for Amazon RDS 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_rds_database_recommendations(resourceArns,
  nextToken, maxResults, filters, accountIds, recommendationPreferences)

Arguments

resourceArns

The ARN that identifies the Amazon RDS.

The following is the format of the ARN:

arn:aws:rds:{region}:{accountId}:db:{resourceName}

The following is the format of a DB Cluster ARN:

arn:aws:rds:{region}:{accountId}:cluster:{resourceName}

nextToken

The token to advance to the next page of Amazon RDS recommendations.

maxResults

The maximum number of Amazon RDS 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 Amazon RDS recommendations.

accountIds

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

You can only specify one account ID per request.

recommendationPreferences

Value

A list with the following syntax:

list(
  nextToken = "string",
  rdsDBRecommendations = list(
    list(
      resourceArn = "string",
      accountId = "string",
      engine = "string",
      engineVersion = "string",
      currentDBInstanceClass = "string",
      currentStorageConfiguration = list(
        storageType = "string",
        allocatedStorage = 123,
        iops = 123,
        maxAllocatedStorage = 123,
        storageThroughput = 123
      ),
      idle = "True"|"False",
      instanceFinding = "Optimized"|"Underprovisioned"|"Overprovisioned",
      storageFinding = "Optimized"|"Underprovisioned"|"Overprovisioned",
      instanceFindingReasonCodes = list(
        "CPUOverprovisioned"|"NetworkBandwidthOverprovisioned"|"EBSIOPSOverprovisioned"|"EBSThroughputOverprovisioned"|"CPUUnderprovisioned"|"NetworkBandwidthUnderprovisioned"|"EBSThroughputUnderprovisioned"|"NewGenerationDBInstanceClassAvailable"|"NewEngineVersionAvailable"
      ),
      storageFindingReasonCodes = list(
        "EBSVolumeAllocatedStorageUnderprovisioned"|"EBSVolumeThroughputUnderprovisioned"|"EBSVolumeIOPSOverprovisioned"|"EBSVolumeThroughputOverprovisioned"|"NewGenerationStorageTypeAvailable"
      ),
      instanceRecommendationOptions = list(
        list(
          dbInstanceClass = "string",
          projectedUtilizationMetrics = list(
            list(
              name = "CPU"|"Memory"|"EBSVolumeStorageSpaceUtilization"|"NetworkReceiveThroughput"|"NetworkTransmitThroughput"|"EBSVolumeReadIOPS"|"EBSVolumeWriteIOPS"|"EBSVolumeReadThroughput"|"EBSVolumeWriteThroughput"|"DatabaseConnections",
              statistic = "Maximum"|"Minimum"|"Average",
              value = 123.0
            )
          ),
          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
            )
          )
        )
      ),
      storageRecommendationOptions = list(
        list(
          storageConfiguration = list(
            storageType = "string",
            allocatedStorage = 123,
            iops = 123,
            maxAllocatedStorage = 123,
            storageThroughput = 123
          ),
          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
            )
          )
        )
      ),
      utilizationMetrics = list(
        list(
          name = "CPU"|"Memory"|"EBSVolumeStorageSpaceUtilization"|"NetworkReceiveThroughput"|"NetworkTransmitThroughput"|"EBSVolumeReadIOPS"|"EBSVolumeWriteIOPS"|"EBSVolumeReadThroughput"|"EBSVolumeWriteThroughput"|"DatabaseConnections",
          statistic = "Maximum"|"Minimum"|"Average",
          value = 123.0
        )
      ),
      effectiveRecommendationPreferences = list(
        cpuVendorArchitectures = list(
          "AWS_ARM64"|"CURRENT"
        ),
        enhancedInfrastructureMetrics = "Active"|"Inactive",
        lookBackPeriod = "DAYS_14"|"DAYS_32"|"DAYS_93",
        savingsEstimationMode = list(
          source = "PublicPricing"|"CostExplorerRightsizing"|"CostOptimizationHub"
        )
      ),
      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"
    )
  )
)

Request syntax

svc$get_rds_database_recommendations(
  resourceArns = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123,
  filters = list(
    list(
      name = "InstanceFinding"|"InstanceFindingReasonCode"|"StorageFinding"|"StorageFindingReasonCode"|"Idle",
      values = list(
        "string"
      )
    )
  ),
  accountIds = list(
    "string"
  ),
  recommendationPreferences = list(
    cpuVendorArchitectures = list(
      "AWS_ARM64"|"CURRENT"
    )
  )
)