Get Effective Recommendation Preferences

computeoptimizer_get_effective_recommendation_preferences

R Documentation

Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics¶

Description¶

Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level.

When you create a recommendation preference, you can set its status to Active or Inactive. Use this action to view the recommendation preferences that are in effect, or Active.

Usage¶

computeoptimizer_get_effective_recommendation_preferences(resourceArn)

Arguments¶

resourceArn: [required] The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.

Value¶

A list with the following syntax:

list(
  enhancedInfrastructureMetrics = "Active"|"Inactive",
  externalMetricsPreference = list(
    source = "Datadog"|"Dynatrace"|"NewRelic"|"Instana"
  ),
  lookBackPeriod = "DAYS_14"|"DAYS_32"|"DAYS_93",
  utilizationPreferences = list(
    list(
      metricName = "CpuUtilization"|"MemoryUtilization",
      metricParameters = list(
        threshold = "P90"|"P95"|"P99_5",
        headroom = "PERCENT_30"|"PERCENT_20"|"PERCENT_10"|"PERCENT_0"
      )
    )
  ),
  preferredResources = list(
    list(
      name = "Ec2InstanceTypes",
      includeList = list(
        "string"
      ),
      effectiveIncludeList = list(
        "string"
      ),
      excludeList = list(
        "string"
      )
    )
  )
)

Request syntax¶

svc$get_effective_recommendation_preferences(
  resourceArn = "string"
)