Amazon Compute Optimizer · Schema
RecommendationPreferencesDetail
Describes a recommendation preference.
Cost OptimizationFinOpsMachine LearningResource Recommendations
Properties
| Name | Type | Description |
|---|---|---|
| scope | object | |
| resourceType | object | |
| enhancedInfrastructureMetrics | object | |
| inferredWorkloadTypes | object | |
| externalMetricsPreference | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-compute-optimizer/refs/heads/main/json-schema/compute-optimizer-recommendation-preferences-detail-schema.json",
"title": "RecommendationPreferencesDetail",
"description": "Describes a recommendation preference.",
"type": "object",
"properties": {
"scope": {
"allOf": [
{
"$ref": "#/components/schemas/Scope"
},
{
"description": "<p>An object that describes the scope of the recommendation preference.</p> <p>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 <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html\">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>"
}
]
},
"resourceType": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceType"
},
{
"description": "<p>The target resource type of the recommendation preference to create.</p> <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Auto Scaling group.</p>"
}
]
},
"enhancedInfrastructureMetrics": {
"allOf": [
{
"$ref": "#/components/schemas/EnhancedInfrastructureMetrics"
},
{
"description": "<p>The status of the enhanced infrastructure metrics recommendation preference.</p> <p>When the recommendations page is refreshed, a status of <code>Active</code> confirms that the preference is applied to the recommendations, and a status of <code>Inactive</code> confirms that the preference isn't yet applied to recommendations.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html\">Enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>"
}
]
},
"inferredWorkloadTypes": {
"allOf": [
{
"$ref": "#/components/schemas/InferredWorkloadTypesPreference"
},
{
"description": "<p>The status of the inferred workload types recommendation preference.</p> <p>When the recommendations page is refreshed, a status of <code>Active</code> confirms that the preference is applied to the recommendations, and a status of <code>Inactive</code> confirms that the preference isn't yet applied to recommendations.</p>"
}
]
},
"externalMetricsPreference": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalMetricsPreference"
},
{
"description": "<p> An object that describes the external metrics recommendation preference. </p> <p> If the preference is applied in the latest recommendation refresh, an object with a valid <code>source</code> value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response. </p>"
}
]
}
}
}