Get License Recommendations

computeoptimizer_get_license_recommendations

R Documentation

Returns license recommendations for Amazon EC2 instances that run on a specific license

Description

Returns license recommendations for Amazon EC2 instances that run on a specific license.

Compute Optimizer generates recommendations for licenses 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_license_recommendations(resourceArns, nextToken,
  maxResults, filters, accountIds)

Arguments

resourceArns

The ARN that identifies the Amazon EC2 instance.

The following is the format of the ARN:

arn:aws:ec2:region:aws_account_id:instance/instance-id

nextToken

The token to advance to the next page of license recommendations.

maxResults

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

accountIds

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

Only one account ID can be specified per request.

Value

A list with the following syntax:

list(
  nextToken = "string",
  licenseRecommendations = list(
    list(
      resourceArn = "string",
      accountId = "string",
      currentLicenseConfiguration = list(
        numberOfCores = 123,
        instanceType = "string",
        operatingSystem = "string",
        licenseEdition = "Enterprise"|"Standard"|"Free"|"NoLicenseEditionFound",
        licenseName = "SQLServer",
        licenseModel = "LicenseIncluded"|"BringYourOwnLicense",
        licenseVersion = "string",
        metricsSource = list(
          list(
            provider = "CloudWatchApplicationInsights",
            providerArn = "string"
          )
        )
      ),
      lookbackPeriodInDays = 123.0,
      lastRefreshTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      finding = "InsufficientMetrics"|"Optimized"|"NotOptimized",
      findingReasonCodes = list(
        "InvalidCloudWatchApplicationInsightsSetup"|"CloudWatchApplicationInsightsError"|"LicenseOverprovisioned"|"Optimized"
      ),
      licenseRecommendationOptions = list(
        list(
          rank = 123,
          operatingSystem = "string",
          licenseEdition = "Enterprise"|"Standard"|"Free"|"NoLicenseEditionFound",
          licenseModel = "LicenseIncluded"|"BringYourOwnLicense",
          savingsOpportunity = list(
            savingsOpportunityPercentage = 123.0,
            estimatedMonthlySavings = list(
              currency = "USD"|"CNY",
              value = 123.0
            )
          )
        )
      ),
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  ),
  errors = list(
    list(
      identifier = "string",
      code = "string",
      message = "string"
    )
  )
)

Request syntax

svc$get_license_recommendations(
  resourceArns = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123,
  filters = list(
    list(
      name = "Finding"|"FindingReasonCode"|"LicenseName",
      values = list(
        "string"
      )
    )
  ),
  accountIds = list(
    "string"
  )
)