Get Recommendation Preferences
computeoptimizer_get_recommendation_preferences | R Documentation |
Returns existing recommendation preferences, such as enhanced infrastructure metrics¶
Description¶
Returns existing recommendation preferences, such as enhanced infrastructure metrics.
Use the scope
parameter to specify which preferences to return. You
can specify to return preferences for an organization, a specific
account ID, or a specific EC2 instance or Auto Scaling group Amazon
Resource Name (ARN).
For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
Usage¶
Arguments¶
resourceType
[required] The target resource type of the recommendation preference for which to return preferences.
The
Ec2Instance
option encompasses standalone instances and instances that are part of Auto Scaling groups. TheAutoScalingGroup
option encompasses only instances that are part of an Auto Scaling group.scope
An object that describes the scope of the recommendation preference to return.
You can return recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.
nextToken
The token to advance to the next page of recommendation preferences.
maxResults
The maximum number of recommendation preferences 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",
recommendationPreferencesDetails = list(
list(
scope = list(
name = "Organization"|"AccountId"|"ResourceArn",
value = "string"
),
resourceType = "Ec2Instance"|"AutoScalingGroup"|"EbsVolume"|"LambdaFunction"|"NotApplicable"|"EcsService"|"License"|"RdsDBInstance",
enhancedInfrastructureMetrics = "Active"|"Inactive",
inferredWorkloadTypes = "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"
)
)
),
savingsEstimationMode = "AfterDiscounts"|"BeforeDiscounts"
)
)
)