Skip to content

Get Recommendation Summaries

computeoptimizer_get_recommendation_summaries R Documentation

Returns the optimization findings for an account

Description

Returns the optimization findings for an account.

It returns the number of:

  • Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized.

  • Auto Scaling groups in an account that are NotOptimized, or Optimized.

  • Amazon EBS volumes in an account that are NotOptimized, or Optimized.

  • Lambda functions in an account that are NotOptimized, or Optimized.

  • Amazon ECS services in an account that are Underprovisioned, Overprovisioned, or Optimized.

Usage

computeoptimizer_get_recommendation_summaries(accountIds, nextToken,
  maxResults)

Arguments

accountIds

The ID of the Amazon Web Services account for which to return recommendation summaries.

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

Only one account ID can be specified per request.

nextToken

The token to advance to the next page of recommendation summaries.

maxResults

The maximum number of recommendation summaries to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

Value

A list with the following syntax:

list(
  nextToken = "string",
  recommendationSummaries = list(
    list(
      summaries = list(
        list(
          name = "Underprovisioned"|"Overprovisioned"|"Optimized"|"NotOptimized",
          value = 123.0,
          reasonCodeSummaries = list(
            list(
              name = "MemoryOverprovisioned"|"MemoryUnderprovisioned",
              value = 123.0
            )
          )
        )
      ),
      recommendationResourceType = "Ec2Instance"|"AutoScalingGroup"|"EbsVolume"|"LambdaFunction"|"EcsService"|"License"|"RdsDBInstance"|"RdsDBInstanceStorage",
      accountId = "string",
      savingsOpportunity = list(
        savingsOpportunityPercentage = 123.0,
        estimatedMonthlySavings = list(
          currency = "USD"|"CNY",
          value = 123.0
        )
      ),
      currentPerformanceRiskRatings = list(
        high = 123,
        medium = 123,
        low = 123,
        veryLow = 123
      ),
      inferredWorkloadSavings = list(
        list(
          inferredWorkloadTypes = list(
            "AmazonEmr"|"ApacheCassandra"|"ApacheHadoop"|"Memcached"|"Nginx"|"PostgreSql"|"Redis"|"Kafka"|"SQLServer"
          ),
          estimatedMonthlySavings = list(
            currency = "USD"|"CNY",
            value = 123.0
          )
        )
      )
    )
  )
)

Request syntax

svc$get_recommendation_summaries(
  accountIds = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123
)