Amazon Compute Optimizer · JSON Structure

Compute Optimizer Get Ebs Volume Recommendations Request Structure

GetEBSVolumeRecommendationsRequest schema

Type: object Properties: 5
Cost OptimizationFinOpsMachine LearningResource Recommendations

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

Properties

volumeArns nextToken maxResults filters accountIds

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-ebs-volume-recommendations-request-structure.json",
  "name": "GetEBSVolumeRecommendationsRequest",
  "description": "GetEBSVolumeRecommendationsRequest schema",
  "type": "object",
  "properties": {
    "volumeArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeArns"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the volumes for which to return recommendations."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The token to advance to the next page of volume recommendations."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxResults"
        },
        {
          "description": "<p>The maximum number of volume 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/EBSFilters"
        },
        {
          "description": "An array of objects to specify a filter that returns a more specific list of volume recommendations."
        }
      ]
    },
    "accountIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountIds"
        },
        {
          "description": "<p>The ID of the Amazon Web Services account for which to return volume 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 volume recommendations.</p> <p>Only one account ID can be specified per request.</p>"
        }
      ]
    }
  }
}