Skip to content

ECSServiceRecommendation

Source code in docs_src/capo_compute_optimizer/types/ecs_service_recommendation.py
class ECSServiceRecommendation(TypedDict, closed=True):
    service_arn: NotRequired["capo_compute_optimizer.types.service_arn.ServiceArn"]
    """<p> The Amazon Resource Name (ARN) of the current Amazon ECS service. </p> <p> The following is the format of the ARN: </p> <p> <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code> </p>"""
    account_id: NotRequired["capo_compute_optimizer.types.account_id.AccountId"]
    """<p> The Amazon Web Services account ID of the Amazon ECS service. </p>"""
    current_service_configuration: NotRequired[
        "capo_compute_optimizer.types.service_configuration.ServiceConfiguration"
    ]
    """<p> The configuration of the current Amazon ECS service. </p>"""
    utilization_metrics: NotRequired[
        "capo_compute_optimizer.types.ecs_service_utilization_metrics.ECSServiceUtilizationMetrics"
    ]
    """<p> An array of objects that describe the utilization metrics of the Amazon ECS service. </p>"""
    lookback_period_in_days: (
        "capo_compute_optimizer.types.look_back_period_in_days.LookBackPeriodInDays"
    )
    """<p> The number of days the Amazon ECS service utilization metrics were analyzed. </p>"""
    launch_type: NotRequired[
        "capo_compute_optimizer.types.ecs_service_launch_type.ECSServiceLaunchType"
    ]
    """<p> The launch type the Amazon ECS service is using. </p> <note> <p>Compute Optimizer only supports the Fargate launch type.</p> </note>"""
    last_refresh_timestamp: NotRequired[
        "capo_compute_optimizer.types.last_refresh_timestamp.LastRefreshTimestamp"
    ]
    """<p> The timestamp of when the Amazon ECS service recommendation was last generated. </p>"""
    finding: NotRequired[
        "capo_compute_optimizer.types.ecs_service_recommendation_finding.ECSServiceRecommendationFinding"
    ]
    """<p> The finding classification of an Amazon ECS service. </p> <p>Findings for Amazon ECS services include:</p> <ul> <li> <p> <b> <code>Underprovisioned</code> </b> — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.</p> </li> <li> <p> <b> <code>Overprovisioned</code> </b> — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs. </p> </li> <li> <p> <b> <code>Optimized</code> </b> — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.</p> </li> </ul>"""
    finding_reason_codes: NotRequired[
        "capo_compute_optimizer.types.ecs_service_recommendation_finding_reason_codes.ECSServiceRecommendationFindingReasonCodes"
    ]
    """<p> The reason for the finding classification of an Amazon ECS service. </p> <p>Finding reason codes for Amazon ECS services include:</p> <ul> <li> <p> <b> <code>CPUUnderprovisioned</code> </b> — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the <code>CPUUtilization</code> metric of the current service during the look-back period.</p> </li> <li> <p> <b> <code>CPUOverprovisioned</code> </b> — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the <code>CPUUtilization</code> metric of the current service during the look-back period. </p> </li> <li> <p> <b> <code>MemoryUnderprovisioned</code> </b> — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the <code>MemoryUtilization</code> metric of the current service during the look-back period.</p> </li> <li> <p> <b> <code>MemoryOverprovisioned</code> </b> — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the <code>MemoryUtilization</code> metric of the current service during the look-back period.</p> </li> </ul>"""
    service_recommendation_options: NotRequired[
        "capo_compute_optimizer.types.ecs_service_recommendation_options.ECSServiceRecommendationOptions"
    ]
    """<p> An array of objects that describe the recommendation options for the Amazon ECS service. </p>"""
    current_performance_risk: NotRequired[
        "capo_compute_optimizer.types.current_performance_risk.CurrentPerformanceRisk"
    ]
    """<p> The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload. </p>"""
    effective_recommendation_preferences: NotRequired[
        "capo_compute_optimizer.types.ecs_effective_recommendation_preferences.ECSEffectiveRecommendationPreferences"
    ]
    """<p> Describes the effective recommendation preferences for Amazon ECS services. </p>"""
    tags: NotRequired["capo_compute_optimizer.types.tags.Tags"]
    """<p> A list of tags assigned to your Amazon ECS service recommendations. </p>"""

account_id instance-attribute

account_id: NotRequired[AccountId]

The Amazon Web Services account ID of the Amazon ECS service.

current_performance_risk instance-attribute

current_performance_risk: NotRequired[CurrentPerformanceRisk]

The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.

current_service_configuration instance-attribute

current_service_configuration: NotRequired[ServiceConfiguration]

The configuration of the current Amazon ECS service.

effective_recommendation_preferences instance-attribute

effective_recommendation_preferences: NotRequired[ECSEffectiveRecommendationPreferences]

Describes the effective recommendation preferences for Amazon ECS services.

finding instance-attribute

finding: NotRequired[ECSServiceRecommendationFinding]

The finding classification of an Amazon ECS service.

Findings for Amazon ECS services include:

  • Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an Amazon ECS service is considered under-provisioned. An under-provisioned service might result in poor application performance.

  • Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an Amazon ECS service is considered over-provisioned. An over-provisioned service might result in additional infrastructure costs.

  • Optimized — When both the CPU and memory of your Amazon ECS service meet the performance requirements of your workload, the service is considered optimized.

finding_reason_codes instance-attribute

finding_reason_codes: NotRequired[ECSServiceRecommendationFindingReasonCodes]

The reason for the finding classification of an Amazon ECS service.

Finding reason codes for Amazon ECS services include:

  • CPUUnderprovisioned — The service CPU configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

  • CPUOverprovisioned — The service CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current service during the look-back period.

  • MemoryUnderprovisioned — The service memory configuration can be sized up to enhance the performance of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

  • MemoryOverprovisioned — The service memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the MemoryUtilization metric of the current service during the look-back period.

last_refresh_timestamp instance-attribute

last_refresh_timestamp: NotRequired[LastRefreshTimestamp]

The timestamp of when the Amazon ECS service recommendation was last generated.

launch_type instance-attribute

launch_type: NotRequired[ECSServiceLaunchType]

The launch type the Amazon ECS service is using.

Compute Optimizer only supports the Fargate launch type.

lookback_period_in_days instance-attribute

lookback_period_in_days: LookBackPeriodInDays

The number of days the Amazon ECS service utilization metrics were analyzed.

service_arn instance-attribute

service_arn: NotRequired[ServiceArn]

The Amazon Resource Name (ARN) of the current Amazon ECS service.

The following is the format of the ARN:

arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

service_recommendation_options instance-attribute

service_recommendation_options: NotRequired[ECSServiceRecommendationOptions]

An array of objects that describe the recommendation options for the Amazon ECS service.

tags instance-attribute

tags: NotRequired[Tags]

A list of tags assigned to your Amazon ECS service recommendations.

utilization_metrics instance-attribute

utilization_metrics: NotRequired[ECSServiceUtilizationMetrics]

An array of objects that describe the utilization metrics of the Amazon ECS service.