Skip to content

EBSUtilizationMetric

Source code in docs_src/capo_compute_optimizer/types/ebs_utilization_metric.py
class EBSUtilizationMetric(TypedDict, closed=True):
    name: NotRequired["capo_compute_optimizer.types.ebs_metric_name.EBSMetricName"]
    """<p>The name of the utilization metric.</p> <p>The following utilization metrics are available:</p> <ul> <li> <p> <code>VolumeReadOpsPerSecond</code> - The completed read operations per second from the volume in a specified period of time.</p> <p>Unit: Count</p> </li> <li> <p> <code>VolumeWriteOpsPerSecond</code> - The completed write operations per second to the volume in a specified period of time.</p> <p>Unit: Count</p> </li> <li> <p> <code>VolumeReadBytesPerSecond</code> - The bytes read per second from the volume in a specified period of time.</p> <p>Unit: Bytes</p> </li> <li> <p> <code>VolumeWriteBytesPerSecond</code> - The bytes written to the volume in a specified period of time.</p> <p>Unit: Bytes</p> </li> <li> <p> <code>VolumeIOPSExceeded</code> - Indicates whether the volume's provisioned IOPS performance was exceeded in a specified period of time. A value of <code>1</code> means the provisioned IOPS were exceeded; a value of <code>0</code> means they were not.</p> <p>Unit: None</p> </li> <li> <p> <code>VolumeThroughputExceeded</code> - Indicates whether the volume's provisioned throughput performance was exceeded in a specified period of time. A value of <code>1</code> means the provisioned throughput was exceeded; a value of <code>0</code> means it was not.</p> <p>Unit: None</p> </li> </ul>"""
    statistic: NotRequired[
        "capo_compute_optimizer.types.metric_statistic.MetricStatistic"
    ]
    """<p>The statistic of the utilization metric.</p> <p>The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the <code>Maximum</code> statistic, which is the highest value observed during the specified period.</p> <p>The Compute Optimizer console displays graphs for some utilization metrics using the <code>Average</code> statistic, which is the value of <code>Sum</code> / <code>SampleCount</code> during the specified period. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html">Viewing resource recommendations</a> in the <i>Compute Optimizer User Guide</i>. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>.</p>"""
    value: "capo_compute_optimizer.types.metric_value.MetricValue"
    """<p>The value of the utilization metric.</p>"""

name instance-attribute

name: NotRequired[EBSMetricName]

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 instance-attribute

statistic: NotRequired[MetricStatistic]

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 instance-attribute

value: MetricValue

The value of the utilization metric.