Amazon Compute Optimizer · JSON Structure

Compute Optimizer Get Recommendation Preferences Request Structure

GetRecommendationPreferencesRequest schema

Type: object Properties: 4 Required: 1
Cost OptimizationFinOpsMachine LearningResource Recommendations

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

Properties

resourceType scope nextToken maxResults

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-get-recommendation-preferences-request-structure.json",
  "name": "GetRecommendationPreferencesRequest",
  "description": "GetRecommendationPreferencesRequest schema",
  "type": "object",
  "properties": {
    "resourceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceType"
        },
        {
          "description": "<p>The target resource type of the recommendation preference for which to return preferences.</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> <note> <p>The valid values for this parameter are <code>Ec2Instance</code> and <code>AutoScalingGroup</code>.</p> </note>"
        }
      ]
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        },
        {
          "description": "<p>An object that describes the scope of the recommendation preference to return.</p> <p>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 <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>"
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The token to advance to the next page of recommendation preferences."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResults"
        },
        {
          "description": "<p>The maximum number of recommendation preferences to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>"
        }
      ]
    }
  },
  "required": [
    "resourceType"
  ]
}