RecommendationPreferencesDetail
Describes a recommendation preference.
Contents
- enhancedInfrastructureMetrics
-
The status of the enhanced infrastructure metrics recommendation preference.
When the recommendations page is refreshed, a status of
Active
confirms that the preference is applied to the recommendations, and a status ofInactive
confirms that the preference isn't yet applied to recommendations.For more information, see Enhanced infrastructure metrics in the Amazon Compute Optimizer User Guide.
Type: String
Valid Values:
Active | Inactive
Required: No
- externalMetricsPreference
-
An object that describes the external metrics recommendation preference.
If the preference is applied in the latest recommendation refresh, an object with a valid
source
value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.Type: ExternalMetricsPreference object
Required: No
- inferredWorkloadTypes
-
The status of the inferred workload types recommendation preference.
When the recommendations page is refreshed, a status of
Active
confirms that the preference is applied to the recommendations, and a status ofInactive
confirms that the preference isn't yet applied to recommendations.Type: String
Valid Values:
Active | Inactive
Required: No
- lookBackPeriod
-
The preference to control the number of days the utilization metrics of the Amazon resource are analyzed. If the preference isn’t set, this object is null.
Type: String
Valid Values:
DAYS_14 | DAYS_32 | DAYS_93
Required: No
- preferredResources
-
The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.
Type: Array of EffectivePreferredResource objects
Required: No
- resourceType
-
The target resource type of the recommendation preference to create.
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.Type: String
Valid Values:
Ec2Instance | AutoScalingGroup | RdsDBInstance
Required: No
- savingsEstimationMode
-
Describes the savings estimation mode used for calculating savings opportunity.
Only the account manager or delegated administrator of your organization can activate this preference.
Type: String
Valid Values:
AfterDiscounts | BeforeDiscounts
Required: No
- scope
-
An object that describes the scope of the recommendation preference.
Recommendation preferences can be 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 Amazon Compute Optimizer User Guide.
Type: Scope object
Required: No
- utilizationPreferences
-
The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. If the preference isn’t set, this object is null.
Note
This preference is only available for the Amazon EC2 instance resource type.
Type: Array of UtilizationPreference objects
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: