Skip to content

VolumeRecommendation

Source code in docs_src/capo_compute_optimizer/types/volume_recommendation.py
class VolumeRecommendation(TypedDict, closed=True):
    volume_arn: NotRequired["capo_compute_optimizer.types.volume_arn.VolumeArn"]
    """<p>The Amazon Resource Name (ARN) of the current volume.</p>"""
    account_id: NotRequired["capo_compute_optimizer.types.account_id.AccountId"]
    """<p>The Amazon Web Services account ID of the volume.</p>"""
    current_configuration: NotRequired[
        "capo_compute_optimizer.types.volume_configuration.VolumeConfiguration"
    ]
    """<p>An array of objects that describe the current configuration of the volume.</p>"""
    finding: NotRequired["capo_compute_optimizer.types.ebs_finding.EBSFinding"]
    """<p>The finding classification of the volume.</p> <p>Findings for volumes include:</p> <ul> <li> <p> <b> <code>NotOptimized</code> </b>—A 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>—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.</p> </li> </ul>"""
    utilization_metrics: NotRequired[
        "capo_compute_optimizer.types.ebs_utilization_metrics.EBSUtilizationMetrics"
    ]
    """<p>An array of objects that describe the utilization metrics of the volume.</p>"""
    look_back_period_in_days: (
        "capo_compute_optimizer.types.look_back_period_in_days.LookBackPeriodInDays"
    )
    """<p>The number of days for which utilization metrics were analyzed for the volume.</p>"""
    volume_recommendation_options: NotRequired[
        "capo_compute_optimizer.types.volume_recommendation_options.VolumeRecommendationOptions"
    ]
    """<p>An array of objects that describe the recommendation options for the volume.</p>"""
    last_refresh_timestamp: NotRequired[
        "capo_compute_optimizer.types.last_refresh_timestamp.LastRefreshTimestamp"
    ]
    """<p>The timestamp of when the volume recommendation was last generated.</p>"""
    current_performance_risk: NotRequired[
        "capo_compute_optimizer.types.current_performance_risk.CurrentPerformanceRisk"
    ]
    """<p>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.</p>"""
    effective_recommendation_preferences: NotRequired[
        "capo_compute_optimizer.types.ebs_effective_recommendation_preferences.EBSEffectiveRecommendationPreferences"
    ]
    """<p> Describes the effective recommendation preferences for Amazon EBS volume. </p>"""
    tags: NotRequired["capo_compute_optimizer.types.tags.Tags"]
    """<p> A list of tags assigned to your Amazon EBS volume recommendations. </p>"""

account_id instance-attribute

account_id: NotRequired[AccountId]

The Amazon Web Services account ID of the volume.

current_configuration instance-attribute

current_configuration: NotRequired[VolumeConfiguration]

An array of objects that describe the current configuration of the volume.

current_performance_risk instance-attribute

current_performance_risk: NotRequired[CurrentPerformanceRisk]

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.

effective_recommendation_preferences instance-attribute

effective_recommendation_preferences: NotRequired[EBSEffectiveRecommendationPreferences]

Describes the effective recommendation preferences for Amazon EBS volume.

finding instance-attribute

finding: NotRequired[EBSFinding]

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.

last_refresh_timestamp instance-attribute

last_refresh_timestamp: NotRequired[LastRefreshTimestamp]

The timestamp of when the volume recommendation was last generated.

look_back_period_in_days instance-attribute

look_back_period_in_days: LookBackPeriodInDays

The number of days for which utilization metrics were analyzed for the volume.

tags instance-attribute

tags: NotRequired[Tags]

A list of tags assigned to your Amazon EBS volume recommendations.

utilization_metrics instance-attribute

utilization_metrics: NotRequired[EBSUtilizationMetrics]

An array of objects that describe the utilization metrics of the volume.

volume_arn instance-attribute

volume_arn: NotRequired[VolumeArn]

The Amazon Resource Name (ARN) of the current volume.

volume_recommendation_options instance-attribute

volume_recommendation_options: NotRequired[VolumeRecommendationOptions]

An array of objects that describe the recommendation options for the volume.