How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations API

The #X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations API from Amazon Compute Optimizer — 1 operation(s) for #x amz target=computeoptimizerservice.getebsvolumerecommendations.

Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations API is one of 21 APIs that Amazon Compute Optimizer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a getting-started guide, a JSON-LD context, and 2 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://compute-optimizer.{region}.amazonaws.com, https://compute-optimizer.{region}.amazonaws.com, http://compute-optimizer.{region}.amazonaws.com.cn, https://compute-optimizer.{region}.amazonaws.com.cn.

1 operations 1 paths 58 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://compute-optimizer.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations 1
POST
/#X-Amz-Target=ComputeOptimizerService.GetEBSVolumeRecommendations
Amazon Compute Optimizer Get E B S Volume Recommendations
GetEBSVolumeRecommendations 8 params body → 200480481482483484485486

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are VolumeRecommendation (10 properties), VolumeConfiguration (7 properties), GetEBSVolumeRecommendationsRequest (5 properties), VolumeRecommendationOption (4 properties). Each schema is shown below with its type and property counts.

GetEBSVolumeRecommendationsRequest
object
5 properties
GetEBSVolumeRecommendationsResponse
object
3 properties
VolumeBaselineThroughput
integer
EBSUtilizationMetrics
array
MetricValue
number
VolumeRecommendationOption
object
Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.
4 properties
Message
string
Tag
object
A list of tag key and value pairs that you define.
2 properties
NextToken
string
ServiceUnavailableException
Tags
array
EBSFinding
string
Rank
integer
VolumeArns
array
InternalServerException
PerformanceRisk
number
SavingsOpportunity
object
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource. Savings opportunity…
2 properties
InvalidParameterValueException
MissingAuthenticationToken
VolumeSize
integer
MetricStatistic
string
Identifier
string
AccessDeniedException
GetRecommendationError
object
Describes an error experienced when getting recommendations. For example, an error is returned if you request recommendations for an unsupported Auto Scaling g…
3 properties
TagKey
string
ThrottlingException
VolumeType
string
VolumeConfiguration
object
Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.
7 properties
VolumeBurstIOPS
integer
AccountId
string
VolumeBurstThroughput
integer
VolumeRecommendation
object
Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.
10 properties
Code
string
EBSUtilizationMetric
object
Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume. Compare the utilization metric data of your resource against its projected…
3 properties
EBSFilterName
string
VolumeRecommendationOptions
array
GetRecommendationErrors
array
EstimatedMonthlySavings
object
Describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resourc…
2 properties
EBSFilters
array
VolumeRecommendations
array
TagValue
string
OptInRequiredException
VolumeBaselineIOPS
integer
EBSMetricName
string
VolumeArn
string
Currency
string
LookBackPeriodInDays
number
LastRefreshTimestamp
string
RootVolume
boolean
CurrentPerformanceRisk
string
ResourceNotFoundException
EBSFilter
object
Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRe…
2 properties
AccountIds
array
Value
number
SavingsOpportunityPercentage
number
FilterValue
string
FilterValues
array
MaxResults
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-compute-optimizer-x-amz-target-computeoptimizerservice-getebsvolumerecommendations-api-openapi.yml Raw ↑

Other APIs Amazon Compute Optimizer publishes across the network.

Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.DeleteRecommendationPreferences API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.DescribeRecommendationExportJobs API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.ExportAutoScalingGroupRecommendations API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.ExportEBSVolumeRecommendations API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.ExportEC2InstanceRecommendations API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.ExportECSServiceRecommendations API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.ExportLambdaFunctionRecommendations API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetAutoScalingGroupRecommendations API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetEC2InstanceRecommendations API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetEC2RecommendationProjectedMetrics API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetECSServiceRecommendationProjectedMetrics API
Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetECSServiceRecommendations API
Where this information came from

This is an independent, third-party profile of Amazon Compute Optimizer #X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.