GetEffectiveRecommendationPreferencesResponse

GetEffectiveRecommendationPreferencesResponse schema

Cost OptimizationFinOpsMachine LearningResource Recommendations

Properties

Name Type Description
enhancedInfrastructureMetrics object
externalMetricsPreference object
View JSON Schema on GitHub

JSON Schema

compute-optimizer-get-effective-recommendation-preferences-response-schema.json Raw ↑
{
  "$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-get-effective-recommendation-preferences-response-schema.json",
  "title": "GetEffectiveRecommendationPreferencesResponse",
  "description": "GetEffectiveRecommendationPreferencesResponse schema",
  "type": "object",
  "properties": {
    "enhancedInfrastructureMetrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnhancedInfrastructureMetrics"
        },
        {
          "description": "<p>The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.</p> <p>A status of <code>Active</code> confirms that the preference is applied in the latest recommendation refresh, and a status of <code>Inactive</code> confirms that it's not yet applied to recommendations.</p> <p>To validate whether the preference is applied to your last generated set of recommendations, review the <code>effectiveRecommendationPreferences</code> value in the response of the <a>GetAutoScalingGroupRecommendations</a> and <a>GetEC2InstanceRecommendations</a> actions.</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>"
        }
      ]
    },
    "externalMetricsPreference": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExternalMetricsPreference"
        },
        {
          "description": "<p>The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.</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> <p>To validate whether the preference is applied to your last generated set of recommendations, review the <code>effectiveRecommendationPreferences</code> value in the response of the <a>GetEC2InstanceRecommendations</a> actions.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/external-metrics-ingestion.html\">Enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>"
        }
      ]
    }
  }
}