| Column Name | Column Data Type |
|---|
account_ids Input Column
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. | VARCHAR[] |
Show child fields- account_ids[]
|
filters Input Column
An array of objects to specify a filter that returns a more specific list of volume recommendations. | STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[] |
Show child fields- filters[]
Show child fields- filters[].name
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. - filters[].values[]
|
max_results Input Column
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. | BIGINT |
next_token Input Column
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. | VARCHAR |
volume_arns Input Column
The Amazon Resource Name (ARN) of the volumes for which to return recommendations. | VARCHAR[] |
Show child fields- volume_arns[]
|
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
errors
An array of objects that describe errors of the request. For example, an error is returned if you request recommendations for an unsupported volume. | STRUCT(
"identifier" VARCHAR,
"code" VARCHAR,
"message" VARCHAR
)[] |
Show child fields- errors[]
Show child fields- errors[].code
The error code. - errors[].identifier
The ID of the error. - errors[].message
The message, or reason, for the error.
|
volume_recommendations
An array of objects that describe volume recommendations. | STRUCT(
"volume_arn" VARCHAR,
"account_id" VARCHAR,
"current_configuration" STRUCT(
"volume_type" VARCHAR,
"volume_size" BIGINT,
"volume_baseline_iops" BIGINT,
"volume_burst_iops" BIGINT,
"volume_baseline_throughput" BIGINT,
"volume_burst_throughput" BIGINT,
"root_volume" BOOLEAN
),
"finding" VARCHAR,
"utilization_metrics" STRUCT(
"name" VARCHAR,
"statistic" VARCHAR,
"value" DOUBLE
)[],
"look_back_period_in_days" DOUBLE,
"volume_recommendation_options" STRUCT(
"configuration" STRUCT(
"volume_type" VARCHAR,
"volume_size" BIGINT,
"volume_baseline_iops" BIGINT,
"volume_burst_iops" BIGINT,
"volume_baseline_throughput" BIGINT,
"volume_burst_throughput" BIGINT,
"root_volume" BOOLEAN
),
"performance_risk" DOUBLE,
"rank" BIGINT,
"savings_opportunity" STRUCT(
"savings_opportunity_percentage" DOUBLE,
"estimated_monthly_savings" STRUCT(
"currency" VARCHAR,
"value" DOUBLE
)
),
"savings_opportunity_after_discounts" STRUCT(
"savings_opportunity_percentage" DOUBLE,
"estimated_monthly_savings" STRUCT(
"currency" VARCHAR,
"value" DOUBLE
)
)
)[],
"last_refresh_timestamp" TIMESTAMP_S,
"current_performance_risk" VARCHAR,
"effective_recommendation_preferences" STRUCT(
"savings_estimation_mode" STRUCT(
"source" VARCHAR
)
),
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[] |
Show child fields- volume_recommendations[]
Show child fields- volume_recommendations[].account_id
The Amazon Web Services account ID of the volume. - volume_recommendations[].current_configuration
An array of objects that describe the current configuration of the volume. Show child fields- volume_recommendations[].current_configuration.root_volume
Contains the image used to boot the instance during launch. - volume_recommendations[].current_configuration.volume_baseline_iops
The baseline IOPS of the volume. - volume_recommendations[].current_configuration.volume_baseline_throughput
The baseline throughput of the volume. - volume_recommendations[].current_configuration.volume_burst_iops
The burst IOPS of the volume. - volume_recommendations[].current_configuration.volume_burst_throughput
The burst throughput of the volume. - volume_recommendations[].current_configuration.volume_size
The size of the volume, in GiB. - volume_recommendations[].current_configuration.volume_type
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.
- volume_recommendations[].current_performance_risk
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. - volume_recommendations[].effective_recommendation_preferences
Describes the effective recommendation preferences for Amazon EBS volume. Show child fields- volume_recommendations[].effective_recommendation_preferences.savings_estimation_mode
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon EBS volumes. Show child fields- volume_recommendations[].effective_recommendation_preferences.savings_estimation_mode.source
Describes the source for calculating the savings opportunity for Amazon EBS volumes.
- volume_recommendations[].finding
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. - volume_recommendations[].last_refresh_timestamp
The timestamp of when the volume recommendation was last generated. - volume_recommendations[].look_back_period_in_days
The number of days for which utilization metrics were analyzed for the volume. - volume_recommendations[].tags[]
Show child fields- volume_recommendations[].tags[].key
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. - volume_recommendations[].tags[].value
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.
- volume_recommendations[].utilization_metrics[]
Show child fields- volume_recommendations[].utilization_metrics[].name
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 - volume_recommendations[].utilization_metrics[].statistic
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. - volume_recommendations[].utilization_metrics[].value
The value of the utilization metric.
- volume_recommendations[].volume_arn
The Amazon Resource Name (ARN) of the current volume. - volume_recommendations[].volume_recommendation_options[]
Show child fields- volume_recommendations[].volume_recommendation_options[].configuration
An array of objects that describe a volume configuration. Show child fields- volume_recommendations[].volume_recommendation_options[].configuration.root_volume
Contains the image used to boot the instance during launch. - volume_recommendations[].volume_recommendation_options[].configuration.volume_baseline_iops
The baseline IOPS of the volume. - volume_recommendations[].volume_recommendation_options[].configuration.volume_baseline_throughput
The baseline throughput of the volume. - volume_recommendations[].volume_recommendation_options[].configuration.volume_burst_iops
The burst IOPS of the volume. - volume_recommendations[].volume_recommendation_options[].configuration.volume_burst_throughput
The burst throughput of the volume. - volume_recommendations[].volume_recommendation_options[].configuration.volume_size
The size of the volume, in GiB. - volume_recommendations[].volume_recommendation_options[].configuration.volume_type
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.
- volume_recommendations[].volume_recommendation_options[].performance_risk
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. - volume_recommendations[].volume_recommendation_options[].rank
The rank of the volume recommendation option. The top recommendation option is ranked as 1. - volume_recommendations[].volume_recommendation_options[].savings_opportunity
An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage. Show child fields- volume_recommendations[].volume_recommendation_options[].savings_opportunity.estimated_monthly_savings
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.. Show child fields- volume_recommendations[].volume_recommendation_options[].savings_opportunity.estimated_monthly_savings.currency
The currency of the estimated monthly savings. - volume_recommendations[].volume_recommendation_options[].savings_opportunity.estimated_monthly_savings.value
The value of the estimated monthly savings.
- volume_recommendations[].volume_recommendation_options[].savings_opportunity.savings_opportunity_percentage
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
- volume_recommendations[].volume_recommendation_options[].savings_opportunity_after_discounts
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. Show child fields- volume_recommendations[].volume_recommendation_options[].savings_opportunity_after_discounts.estimated_monthly_savings
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. Show child fields- volume_recommendations[].volume_recommendation_options[].savings_opportunity_after_discounts.estimated_monthly_savings.currency
The currency of the estimated monthly savings. - volume_recommendations[].volume_recommendation_options[].savings_opportunity_after_discounts.estimated_monthly_savings.value
The value of the estimated monthly savings.
- volume_recommendations[].volume_recommendation_options[].savings_opportunity_after_discounts.savings_opportunity_percentage
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.
|