2026/06/18 - AWS Compute Optimizer - 2 updated api methods
Changes This release surfaces two new metrics Volume IOPS Exceeded and Volume Throughput Exceeded into EBS volume rightsizing recommendations.
{'fieldsToExport': {'UtilizationMetricsVolumeIOPSExceededMaximum',
'UtilizationMetricsVolumeThroughputExceededMaximum'}}
Exports optimization recommendations for Amazon EBS volumes.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.export_ebs_volume_recommendations(
accountIds=[
'string',
],
filters=[
{
'name': 'Finding',
'values': [
'string',
]
},
],
fieldsToExport=[
'AccountId'|'VolumeArn'|'Finding'|'UtilizationMetricsVolumeReadOpsPerSecondMaximum'|'UtilizationMetricsVolumeWriteOpsPerSecondMaximum'|'UtilizationMetricsVolumeReadBytesPerSecondMaximum'|'UtilizationMetricsVolumeWriteBytesPerSecondMaximum'|'UtilizationMetricsVolumeIOPSExceededMaximum'|'UtilizationMetricsVolumeThroughputExceededMaximum'|'LookbackPeriodInDays'|'CurrentConfigurationVolumeType'|'CurrentConfigurationVolumeBaselineIOPS'|'CurrentConfigurationVolumeBaselineThroughput'|'CurrentConfigurationVolumeBurstIOPS'|'CurrentConfigurationVolumeBurstThroughput'|'CurrentConfigurationVolumeSize'|'CurrentMonthlyPrice'|'RecommendationOptionsConfigurationVolumeType'|'RecommendationOptionsConfigurationVolumeBaselineIOPS'|'RecommendationOptionsConfigurationVolumeBaselineThroughput'|'RecommendationOptionsConfigurationVolumeBurstIOPS'|'RecommendationOptionsConfigurationVolumeBurstThroughput'|'RecommendationOptionsConfigurationVolumeSize'|'RecommendationOptionsMonthlyPrice'|'RecommendationOptionsPerformanceRisk'|'LastRefreshTimestamp'|'CurrentPerformanceRisk'|'RecommendationOptionsSavingsOpportunityPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrency'|'RecommendationOptionsEstimatedMonthlySavingsValue'|'Tags'|'RootVolume'|'CurrentConfigurationRootVolume'|'EffectiveRecommendationPreferencesSavingsEstimationMode'|'RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage'|'RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts'|'RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts'|'EffectiveRecommendationPreferencesLookBackPeriod',
],
s3DestinationConfig={
'bucket': 'string',
'keyPrefix': 'string'
},
fileFormat='Csv',
includeMemberAccounts=True|False
)
list
The IDs of the Amazon Web Services accounts for which to export Amazon EBS 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 export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
(string) --
list
An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
(dict) --
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.
name (string) --
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 (list) --
The value of the filter.
The valid values are Optimized, or NotOptimized.
(string) --
list
The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.
(string) --
dict
[REQUIRED]
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
bucket (string) --
The name of the Amazon S3 bucket to use as the destination for an export job.
keyPrefix (string) --
The Amazon S3 bucket prefix for an export job.
string
The format of the export file.
The only export file format currently supported is Csv.
boolean
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
dict
Response Syntax
{
'jobId': 'string',
's3Destination': {
'bucket': 'string',
'key': 'string',
'metadataKey': 'string'
}
}
Response Structure
(dict) --
jobId (string) --
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
s3Destination (dict) --
Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file.
bucket (string) --
The name of the Amazon S3 bucket used as the destination of an export file.
key (string) --
The Amazon S3 bucket key of an export file.
The key uniquely identifies the object, or export file, in the S3 bucket.
metadataKey (string) --
The Amazon S3 bucket key of a metadata file.
The key uniquely identifies the object, or metadata file, in the S3 bucket.
{'volumeRecommendations': {'utilizationMetrics': {'name': {'VolumeIOPSExceeded',
'VolumeThroughputExceeded'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_ebs_volume_recommendations(
volumeArns=[
'string',
],
nextToken='string',
maxResults=123,
filters=[
{
'name': 'Finding',
'values': [
'string',
]
},
],
accountIds=[
'string',
]
)
list
The Amazon Resource Name (ARN) of the volumes for which to return recommendations.
(string) --
string
The token to advance to the next page of volume recommendations.
integer
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.
list
An array of objects to specify a filter that returns a more specific list of volume recommendations.
(dict) --
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.
name (string) --
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 (list) --
The value of the filter.
The valid values are Optimized, or NotOptimized.
(string) --
list
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.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'volumeRecommendations': [
{
'volumeArn': 'string',
'accountId': 'string',
'currentConfiguration': {
'volumeType': 'string',
'volumeSize': 123,
'volumeBaselineIOPS': 123,
'volumeBurstIOPS': 123,
'volumeBaselineThroughput': 123,
'volumeBurstThroughput': 123,
'rootVolume': True|False
},
'finding': 'Optimized'|'NotOptimized',
'utilizationMetrics': [
{
'name': 'VolumeReadOpsPerSecond'|'VolumeWriteOpsPerSecond'|'VolumeReadBytesPerSecond'|'VolumeWriteBytesPerSecond'|'VolumeIOPSExceeded'|'VolumeThroughputExceeded',
'statistic': 'Maximum'|'Average',
'value': 123.0
},
],
'lookBackPeriodInDays': 123.0,
'volumeRecommendationOptions': [
{
'configuration': {
'volumeType': 'string',
'volumeSize': 123,
'volumeBaselineIOPS': 123,
'volumeBurstIOPS': 123,
'volumeBaselineThroughput': 123,
'volumeBurstThroughput': 123,
'rootVolume': True|False
},
'performanceRisk': 123.0,
'rank': 123,
'savingsOpportunity': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
},
'savingsOpportunityAfterDiscounts': {
'savingsOpportunityPercentage': 123.0,
'estimatedMonthlySavings': {
'currency': 'USD'|'CNY',
'value': 123.0
}
}
},
],
'lastRefreshTimestamp': datetime(2015, 1, 1),
'currentPerformanceRisk': 'VeryLow'|'Low'|'Medium'|'High',
'effectiveRecommendationPreferences': {
'savingsEstimationMode': {
'source': 'PublicPricing'|'CostExplorerRightsizing'|'CostOptimizationHub'
},
'lookBackPeriod': 'DAYS_14'|'DAYS_32'|'DAYS_93'
},
'tags': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'errors': [
{
'identifier': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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 (list) --
An array of objects that describe volume recommendations.
(dict) --
Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.
volumeArn (string) --
The Amazon Resource Name (ARN) of the current volume.
accountId (string) --
The Amazon Web Services account ID of the volume.
currentConfiguration (dict) --
An array of objects that describe the current configuration of the volume.
volumeType (string) --
The volume type.
The volume types can be the following:
General Purpose SSD gp2 and gp3
Provisioned IOPS SSD io1, io2, and io2 Block Express
Throughput Optimized HDD st1
Cold HDD sc1
Magnetic volumes standard
volumeSize (integer) --
The size of the volume, in GiB.
volumeBaselineIOPS (integer) --
The baseline IOPS of the volume.
volumeBurstIOPS (integer) --
The burst IOPS of the volume.
volumeBaselineThroughput (integer) --
The baseline throughput of the volume.
volumeBurstThroughput (integer) --
The burst throughput of the volume.
rootVolume (boolean) --
Contains the image used to boot the instance during launch.
finding (string) --
The finding classification of the volume.
Findings for volumes include:
NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An 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.
utilizationMetrics (list) --
An array of objects that describe the utilization metrics of the volume.
(dict) --
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.
name (string) --
The name of the utilization metric.
The following utilization metrics are available:
VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time. Unit: Count
VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time. Unit: Count
VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time. Unit: Bytes
VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time. Unit: Bytes
VolumeIOPSExceeded - Indicates whether the volume's provisioned IOPS performance was exceeded in a specified period of time. A value of 1 means the provisioned IOPS were exceeded; a value of 0 means they were not. Unit: None
VolumeThroughputExceeded - Indicates whether the volume's provisioned throughput performance was exceeded in a specified period of time. A value of 1 means the provisioned throughput was exceeded; a value of 0 means it was not. Unit: None
statistic (string) --
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 (float) --
The value of the utilization metric.
lookBackPeriodInDays (float) --
The number of days for which utilization metrics were analyzed for the volume.
volumeRecommendationOptions (list) --
An array of objects that describe the recommendation options for the volume.
(dict) --
Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.
configuration (dict) --
An array of objects that describe a volume configuration.
volumeType (string) --
The volume type.
The volume types can be the following:
General Purpose SSD gp2 and gp3
Provisioned IOPS SSD io1, io2, and io2 Block Express
Throughput Optimized HDD st1
Cold HDD sc1
Magnetic volumes standard
volumeSize (integer) --
The size of the volume, in GiB.
volumeBaselineIOPS (integer) --
The baseline IOPS of the volume.
volumeBurstIOPS (integer) --
The burst IOPS of the volume.
volumeBaselineThroughput (integer) --
The baseline throughput of the volume.
volumeBurstThroughput (integer) --
The burst throughput of the volume.
rootVolume (boolean) --
Contains the image used to boot the instance during launch.
performanceRisk (float) --
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 (integer) --
The rank of the volume recommendation option.
The top recommendation option is ranked as 1.
savingsOpportunity (dict) --
An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
estimatedMonthlySavings (dict) --
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..
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
savingsOpportunityAfterDiscounts (dict) --
An object that describes the savings opportunity for the Amazon EBS volume recommendation option with specific discounts. Savings opportunity includes the estimated monthly savings and percentage.
savingsOpportunityPercentage (float) --
The estimated monthly savings possible as a percentage of monthly cost after applying the specific discounts. This saving can be achieved by adopting Compute Optimizer’s Amazon EBS volume recommendations.
estimatedMonthlySavings (dict) --
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon EBS volume recommendations. This saving includes any applicable discounts.
currency (string) --
The currency of the estimated monthly savings.
value (float) --
The value of the estimated monthly savings.
lastRefreshTimestamp (datetime) --
The timestamp of when the volume recommendation was last generated.
currentPerformanceRisk (string) --
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.
effectiveRecommendationPreferences (dict) --
Describes the effective recommendation preferences for Amazon EBS volume.
savingsEstimationMode (dict) --
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon EBS volumes.
source (string) --
Describes the source for calculating the savings opportunity for Amazon EBS volumes.
lookBackPeriod (string) --
The number of days for which utilization metrics were analyzed for the volume.
tags (list) --
A list of tags assigned to your Amazon EBS volume recommendations.
(dict) --
A list of tag key and value pairs that you define.
key (string) --
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 (string) --
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.
errors (list) --
An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported volume.
(dict) --
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.
identifier (string) --
The ID of the error.
code (string) --
The error code.
message (string) --
The message, or reason, for the error.