Amazon Compute Optimizer · JSON Structure

Compute Optimizer Get Ec2 Instance Recommendations Request Structure

GetEC2InstanceRecommendationsRequest schema

Type: object Properties: 6
Cost OptimizationFinOpsMachine LearningResource Recommendations

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

Properties

instanceArns nextToken maxResults filters accountIds recommendationPreferences

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-ec2-instance-recommendations-request-structure.json",
  "name": "GetEC2InstanceRecommendationsRequest",
  "description": "GetEC2InstanceRecommendationsRequest schema",
  "type": "object",
  "properties": {
    "instanceArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceArns"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the instances for which to return recommendations."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The token to advance to the next page of instance recommendations."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResults"
        },
        {
          "description": "<p>The maximum number of instance recommendations to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>"
        }
      ]
    },
    "filters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Filters"
        },
        {
          "description": "An array of objects to specify a filter that returns a more specific list of instance recommendations."
        }
      ]
    },
    "accountIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountIds"
        },
        {
          "description": "<p>The ID of the Amazon Web Services account for which to return instance recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.</p> <p>Only one account ID can be specified per request.</p>"
        }
      ]
    },
    "recommendationPreferences": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecommendationPreferences"
        },
        {
          "description": "An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response."
        }
      ]
    }
  }
}