Amazon Compute Optimizer · JSON Structure

Compute Optimizer Effective Recommendation Preferences Structure

Describes the effective recommendation preferences for a resource.

Type: object Properties: 4
Cost OptimizationFinOpsMachine LearningResource Recommendations

EffectiveRecommendationPreferences is a JSON Structure definition published by Amazon Compute Optimizer, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

cpuVendorArchitectures enhancedInfrastructureMetrics inferredWorkloadTypes externalMetricsPreference

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-compute-optimizer/refs/heads/main/json-structure/compute-optimizer-effective-recommendation-preferences-structure.json",
  "name": "EffectiveRecommendationPreferences",
  "description": "Describes the effective recommendation preferences for a resource.",
  "type": "object",
  "properties": {
    "cpuVendorArchitectures": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CpuVendorArchitectures"
        },
        {
          "description": "<p>Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.</p> <p>For example, when you specify <code>AWS_ARM64</code> with:</p> <ul> <li> <p>A <a>GetEC2InstanceRecommendations</a> or <a>GetAutoScalingGroupRecommendations</a> request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.</p> </li> <li> <p>A <a>GetEC2RecommendationProjectedMetrics</a> request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.</p> </li> <li> <p>A <a>ExportEC2InstanceRecommendations</a> or <a>ExportAutoScalingGroupRecommendations</a> request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.</p> </li> </ul>"
        }
      ]
    },
    "enhancedInfrastructureMetrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnhancedInfrastructureMetrics"
        },
        {
          "description": "<p>Describes the activation status of the enhanced infrastructure metrics preference.</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>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>Describes the activation status of the inferred workload types preference.</p> <p>A status of <code>Active</code> confirms that the preference is applied in the latest recommendation refresh. A status of <code>Inactive</code> confirms that it's not 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>"
        }
      ]
    }
  }
}