openapi: 3.0.0 info: version: '2019-11-01' x-release: v4 title: 'AWS Compute Optimizer #X Amz Target=ComputeOptimizerService.DeleteRecommendationPreferences #X Amz Target=ComputeOptimizerService.DeleteRecommendationPreferences #X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations API' description: Compute Optimizer is a service that analyzes the configuration and utilization metrics of your Amazon Web Services compute resources, such as Amazon EC2 instances, Amazon EC2 Auto Scaling groups, Lambda functions, Amazon EBS volumes, and Amazon ECS services on Fargate. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, in addition to projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the Compute Optimizer User Guide. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: compute-optimizer x-aws-signingName: compute-optimizer x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/compute-optimizer-2019-11-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://compute-optimizer.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Compute Optimizer multi-region endpoint - url: https://compute-optimizer.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Compute Optimizer multi-region endpoint - url: http://compute-optimizer.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Compute Optimizer endpoint for China (Beijing) and China (Ningxia) - url: https://compute-optimizer.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Compute Optimizer endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations' paths: /#X-Amz-Target=ComputeOptimizerService.GetEBSVolumeRecommendations: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: GetEBSVolumeRecommendations description:

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEBSVolumeRecommendationsResponse' examples: GetEBSVolumeRecommendations200Example: summary: Default GetEBSVolumeRecommendations 200 x-microcks-default: true value: nextToken: example volumeRecommendations: example errors: example '480': description: OptInRequiredException content: application/json: schema: $ref: '#/components/schemas/OptInRequiredException' examples: GetEBSVolumeRecommendations480Example: summary: Default GetEBSVolumeRecommendations 480 x-microcks-default: true value: example '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: GetEBSVolumeRecommendations481Example: summary: Default GetEBSVolumeRecommendations 481 x-microcks-default: true value: example '482': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: GetEBSVolumeRecommendations482Example: summary: Default GetEBSVolumeRecommendations 482 x-microcks-default: true value: example '483': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: GetEBSVolumeRecommendations483Example: summary: Default GetEBSVolumeRecommendations 483 x-microcks-default: true value: example '484': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' examples: GetEBSVolumeRecommendations484Example: summary: Default GetEBSVolumeRecommendations 484 x-microcks-default: true value: example '485': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: GetEBSVolumeRecommendations485Example: summary: Default GetEBSVolumeRecommendations 485 x-microcks-default: true value: example '486': description: MissingAuthenticationToken content: application/json: schema: $ref: '#/components/schemas/MissingAuthenticationToken' examples: GetEBSVolumeRecommendations486Example: summary: Default GetEBSVolumeRecommendations 486 x-microcks-default: true value: example '487': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: GetEBSVolumeRecommendations487Example: summary: Default GetEBSVolumeRecommendations 487 x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetEBSVolumeRecommendationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - ComputeOptimizerService.GetEBSVolumeRecommendations summary: Amazon Compute Optimizer Get E B S Volume Recommendations x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=ComputeOptimizerService.GetEBSVolumeRecommendations' components: schemas: EBSMetricName: type: string enum: - VolumeReadOpsPerSecond - VolumeWriteOpsPerSecond - VolumeReadBytesPerSecond - VolumeWriteBytesPerSecond VolumeType: type: string InternalServerException: {} ThrottlingException: {} Message: type: string ServiceUnavailableException: {} VolumeRecommendation: 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:

The finding classification of the volume.

Findings for volumes include:

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. ' description: Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation. LookBackPeriodInDays: type: number format: double AccountId: type: string TagValue: type: string EBSUtilizationMetric: type: object properties: name: allOf: - $ref: '#/components/schemas/EBSMetricName' - description: '

The name of the utilization metric.

The following utilization metrics are available:

' statistic: allOf: - $ref: '#/components/schemas/MetricStatistic' - description:

The statistic of the utilization metric.

The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

value: allOf: - $ref: '#/components/schemas/MetricValue' - description: The value of the utilization metric. description:

Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

Currency: type: string enum: - USD - CNY Tag: type: object properties: key: allOf: - $ref: '#/components/schemas/TagKey' - description: ' One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values. ' value: allOf: - $ref: '#/components/schemas/TagValue' - description: ' One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null. ' description: ' A list of tag key and value pairs that you define. ' MissingAuthenticationToken: {} MetricValue: type: number format: double VolumeConfiguration: type: object properties: volumeType: allOf: - $ref: '#/components/schemas/VolumeType' - description:

The volume type.

This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

volumeSize: allOf: - $ref: '#/components/schemas/VolumeSize' - description: The size of the volume, in GiB. volumeBaselineIOPS: allOf: - $ref: '#/components/schemas/VolumeBaselineIOPS' - description: The baseline IOPS of the volume. volumeBurstIOPS: allOf: - $ref: '#/components/schemas/VolumeBurstIOPS' - description: The burst IOPS of the volume. volumeBaselineThroughput: allOf: - $ref: '#/components/schemas/VolumeBaselineThroughput' - description: The baseline throughput of the volume. volumeBurstThroughput: allOf: - $ref: '#/components/schemas/VolumeBurstThroughput' - description: The burst throughput of the volume. rootVolume: allOf: - $ref: '#/components/schemas/RootVolume' - description: ' Contains the image used to boot the instance during launch. ' description: Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume. VolumeBaselineIOPS: type: integer RootVolume: type: boolean VolumeRecommendationOption: type: object properties: configuration: allOf: - $ref: '#/components/schemas/VolumeConfiguration' - description: An array of objects that describe a volume configuration. performanceRisk: allOf: - $ref: '#/components/schemas/PerformanceRisk' - description:

The performance risk of the volume recommendation option.

Performance risk is the likelihood of the recommended volume type meeting the performance requirement of your workload.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

rank: allOf: - $ref: '#/components/schemas/Rank' - description:

The rank of the volume recommendation option.

The top recommendation option is ranked as 1.

savingsOpportunity: allOf: - $ref: '#/components/schemas/SavingsOpportunity' - description: An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage. description: Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance. GetEBSVolumeRecommendationsRequest: type: object title: GetEBSVolumeRecommendationsRequest 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:

The maximum number of volume recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

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:

The ID of the Amazon Web Services account for which to return volume recommendations.

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.

Only one account ID can be specified per request.

VolumeBaselineThroughput: type: integer AccountIds: type: array items: $ref: '#/components/schemas/AccountId' VolumeArns: type: array items: $ref: '#/components/schemas/VolumeArn' FilterValues: type: array items: $ref: '#/components/schemas/FilterValue' MetricStatistic: type: string enum: - Maximum - Average VolumeBurstIOPS: type: integer MaxResults: type: integer minimum: 0 maximum: 1000 VolumeRecommendations: type: array items: $ref: '#/components/schemas/VolumeRecommendation' SavingsOpportunity: type: object properties: savingsOpportunityPercentage: allOf: - $ref: '#/components/schemas/SavingsOpportunityPercentage' - description: The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource. estimatedMonthlySavings: allOf: - $ref: '#/components/schemas/EstimatedMonthlySavings' - description: An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.. description:

Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource.

Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation.

Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide.

Value: type: number format: double InvalidParameterValueException: {} OptInRequiredException: {} CurrentPerformanceRisk: type: string enum: - VeryLow - Low - Medium - High GetEBSVolumeRecommendationsResponse: type: object properties: nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description:

The token to use to advance to the next page of volume recommendations.

This value is null when there are no more pages of volume recommendations to return.

volumeRecommendations: allOf: - $ref: '#/components/schemas/VolumeRecommendations' - description: An array of objects that describe volume recommendations. errors: allOf: - $ref: '#/components/schemas/GetRecommendationErrors' - description:

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an unsupported volume.

EstimatedMonthlySavings: type: object properties: currency: allOf: - $ref: '#/components/schemas/Currency' - description: The currency of the estimated monthly savings. value: allOf: - $ref: '#/components/schemas/Value' - description: The value of the estimated monthly savings. description:

Describes the estimated monthly savings amount possible, based on On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given resource.

For more information, see Estimated monthly savings and savings opportunities in the Compute Optimizer User Guide.

EBSUtilizationMetrics: type: array items: $ref: '#/components/schemas/EBSUtilizationMetric' ResourceNotFoundException: {} VolumeArn: type: string LastRefreshTimestamp: type: string format: date-time AccessDeniedException: {} Code: type: string VolumeBurstThroughput: type: integer GetRecommendationError: type: object properties: identifier: allOf: - $ref: '#/components/schemas/Identifier' - description: The ID of the error. code: allOf: - $ref: '#/components/schemas/Code' - description: The error code. message: allOf: - $ref: '#/components/schemas/Message' - description: The message, or reason, for the error. description:

Describes an error experienced when getting recommendations.

For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.

SavingsOpportunityPercentage: type: number format: double NextToken: type: string VolumeRecommendationOptions: type: array items: $ref: '#/components/schemas/VolumeRecommendationOption' Tags: type: array items: $ref: '#/components/schemas/Tag' EBSFilter: type: object properties: name: allOf: - $ref: '#/components/schemas/EBSFilterName' - description:

The name of the filter.

Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).

You can filter your Amazon EBS volume recommendations by tag:key and tag-key tags.

A tag:key is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

A tag-key is the key of a tag assigned to your Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value of Owner or without any tag keys assigned.

values: allOf: - $ref: '#/components/schemas/FilterValues' - description:

The value of the filter.

The valid values are Optimized, or NotOptimized.

description:

Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.

You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

EBSFilterName: type: string enum: - Finding GetRecommendationErrors: type: array items: $ref: '#/components/schemas/GetRecommendationError' Identifier: type: string EBSFilters: type: array items: $ref: '#/components/schemas/EBSFilter' FilterValue: type: string TagKey: type: string Rank: type: integer EBSFinding: type: string enum: - Optimized - NotOptimized PerformanceRisk: type: number format: double minimum: 0 maximum: 4 VolumeSize: type: integer parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/compute-optimizer/ x-hasEquivalentPaths: true