Skip to content

AutoScalingGroupRecommendationOption

Source code in docs_src/capo_compute_optimizer/types/auto_scaling_group_recommendation_option.py
class AutoScalingGroupRecommendationOption(TypedDict, closed=True):
    configuration: NotRequired[
        "capo_compute_optimizer.types.auto_scaling_group_configuration.AutoScalingGroupConfiguration"
    ]
    """<p>An array of objects that describe an Auto Scaling group configuration.</p>"""
    instance_gpu_info: NotRequired["capo_compute_optimizer.types.gpu_info.GpuInfo"]
    """<p> Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group. </p>"""
    projected_utilization_metrics: NotRequired[
        "capo_compute_optimizer.types.projected_utilization_metrics.ProjectedUtilizationMetrics"
    ]
    """<p>An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.</p> <note> <p>The <code>Cpu</code> and <code>Memory</code> metrics are the only projected utilization metrics returned. Additionally, the <code>Memory</code> metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent">Enabling Memory Utilization with the CloudWatch Agent</a>.</p> </note>"""
    performance_risk: "capo_compute_optimizer.types.performance_risk.PerformanceRisk"
    """<p>The performance risk of the Auto Scaling group configuration recommendation.</p> <p>Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.</p> <p>The value ranges from <code>0</code> - <code>4</code>, with <code>0</code> 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.</p>"""
    rank: "capo_compute_optimizer.types.rank.Rank"
    """<p>The rank of the Auto Scaling group recommendation option.</p> <p>The top recommendation option is ranked as <code>1</code>.</p>"""
    savings_opportunity: NotRequired[
        "capo_compute_optimizer.types.savings_opportunity.SavingsOpportunity"
    ]
    """<p>An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.</p>"""
    savings_opportunity_after_discounts: NotRequired[
        "capo_compute_optimizer.types.auto_scaling_group_savings_opportunity_after_discounts.AutoScalingGroupSavingsOpportunityAfterDiscounts"
    ]
    """<p> An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage. </p>"""
    migration_effort: NotRequired[
        "capo_compute_optimizer.types.migration_effort.MigrationEffort"
    ]
    """<p>The level of effort required to migrate from the current instance type to the recommended instance type.</p> <p>For example, the migration effort is <code>Low</code> if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is <code>Medium</code> if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is <code>VeryLow</code> if both the current and recommended instance types are of the same CPU architecture.</p>"""

configuration instance-attribute

configuration: NotRequired[AutoScalingGroupConfiguration]

An array of objects that describe an Auto Scaling group configuration.

instance_gpu_info instance-attribute

instance_gpu_info: NotRequired[GpuInfo]

Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.

migration_effort instance-attribute

migration_effort: NotRequired[MigrationEffort]

The level of effort required to migrate from the current instance type to the recommended instance type.

For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.

performance_risk instance-attribute

performance_risk: PerformanceRisk

The performance risk of the Auto Scaling group configuration recommendation.

Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

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.

projected_utilization_metrics instance-attribute

projected_utilization_metrics: NotRequired[ProjectedUtilizationMetrics]

An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

rank instance-attribute

rank: Rank

The rank of the Auto Scaling group recommendation option.

The top recommendation option is ranked as 1.

savings_opportunity instance-attribute

savings_opportunity: NotRequired[SavingsOpportunity]

An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

savings_opportunity_after_discounts instance-attribute

savings_opportunity_after_discounts: NotRequired[
    AutoScalingGroupSavingsOpportunityAfterDiscounts
]

An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.