Amazon Compute Optimizer · JSON Structure

Compute Optimizer Volume Recommendation Structure

Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.

Type: object Properties: 10
Cost OptimizationFinOpsMachine LearningResource Recommendations

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

Properties

volumeArn accountId currentConfiguration finding utilizationMetrics lookBackPeriodInDays volumeRecommendationOptions lastRefreshTimestamp currentPerformanceRisk tags

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-volume-recommendation-structure.json",
  "name": "VolumeRecommendation",
  "description": "Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.",
  "type": "object",
  "properties": {
    "volumeArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the current volume."
        }
      ]
    },
    "accountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountId"
        },
        {
          "description": "The Amazon Web Services account ID of the volume."
        }
      ]
    },
    "currentConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeConfiguration"
        },
        {
          "description": "An array of objects that describe the current configuration of the volume."
        }
      ]
    },
    "finding": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EBSFinding"
        },
        {
          "description": "<p>The finding classification of the volume.</p> <p>Findings for volumes include:</p> <ul> <li> <p> <b> <code>NotOptimized</code> </b>\u2014A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.</p> </li> <li> <p> <b> <code>Optimized</code> </b>\u2014An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.</p> </li> </ul>"
        }
      ]
    },
    "utilizationMetrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EBSUtilizationMetrics"
        },
        {
          "description": "An array of objects that describe the utilization metrics of the volume."
        }
      ]
    },
    "lookBackPeriodInDays": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LookBackPeriodInDays"
        },
        {
          "description": "The number of days for which utilization metrics were analyzed for the volume."
        }
      ]
    },
    "volumeRecommendationOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeRecommendationOptions"
        },
        {
          "description": "An array of objects that describe the recommendation options for the volume."
        }
      ]
    },
    "lastRefreshTimestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LastRefreshTimestamp"
        },
        {
          "description": "The timestamp of when the volume recommendation was last generated."
        }
      ]
    },
    "currentPerformanceRisk": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CurrentPerformanceRisk"
        },
        {
          "description": "The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "description": " A list of tags assigned to your Amazon EBS volume recommendations. "
        }
      ]
    }
  }
}