Documentation

Describes an Amazon ECS service recommendation.

See: newECSServiceRecommendation smart constructor.

Create a value of ECSServiceRecommendation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:ECSServiceRecommendation', eCSServiceRecommendation_accountId - The Amazon Web Services account ID of the ECS service.

$sel:currentPerformanceRisk:ECSServiceRecommendation', eCSServiceRecommendation_currentPerformanceRisk - The risk of the current 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.

$sel:currentServiceConfiguration:ECSServiceRecommendation', eCSServiceRecommendation_currentServiceConfiguration - The configuration of the current ECS service.

$sel:finding:ECSServiceRecommendation', eCSServiceRecommendation_finding - The finding classification of an ECS service.

Findings for ECS services include:

• Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an ECS service is considered under-provisioned. An under-provisioned ECS service might result in poor application performance.
• Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an ECS service is considered over-provisioned. An over-provisioned ECS service might result in additional infrastructure costs.
• Optimized — When both the CPU and memory of your ECS service meet the performance requirements of your workload, the service is considered optimized.

$sel:findingReasonCodes:ECSServiceRecommendation', eCSServiceRecommendation_findingReasonCodes - The reason for the finding classification of an ECS service.

Finding reason codes for ECS services include:

• CPUUnderprovisioned — The ECS 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 ECS 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 ECS 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 ECS 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.

$sel:lastRefreshTimestamp:ECSServiceRecommendation', eCSServiceRecommendation_lastRefreshTimestamp - The timestamp of when the ECS service recommendation was last generated.

$sel:launchType:ECSServiceRecommendation', eCSServiceRecommendation_launchType - The launch type the ECS service is using.

Compute Optimizer only supports the Fargate launch type.

$sel:lookbackPeriodInDays:ECSServiceRecommendation', eCSServiceRecommendation_lookbackPeriodInDays - The number of days the ECS service utilization metrics were analyzed.

$sel:serviceArn:ECSServiceRecommendation', eCSServiceRecommendation_serviceArn - The Amazon Resource Name (ARN) of the current ECS service.

The following is the format of the ARN:

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

$sel:serviceRecommendationOptions:ECSServiceRecommendation', eCSServiceRecommendation_serviceRecommendationOptions - An array of objects that describe the recommendation options for the ECS service.

$sel:utilizationMetrics:ECSServiceRecommendation', eCSServiceRecommendation_utilizationMetrics - An array of objects that describe the utilization metrics of the ECS service.

The Amazon Web Services account ID of the ECS service.

The risk of the current 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.

The configuration of the current ECS service.

The finding classification of an ECS service.

Findings for ECS services include:

• Underprovisioned — When Compute Optimizer detects that there’s not enough memory or CPU, an ECS service is considered under-provisioned. An under-provisioned ECS service might result in poor application performance.
• Overprovisioned — When Compute Optimizer detects that there’s excessive memory or CPU, an ECS service is considered over-provisioned. An over-provisioned ECS service might result in additional infrastructure costs.
• Optimized — When both the CPU and memory of your ECS service meet the performance requirements of your workload, the service is considered optimized.

The reason for the finding classification of an ECS service.

Finding reason codes for ECS services include:

• CPUUnderprovisioned — The ECS 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 ECS 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 ECS 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 ECS 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.

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

The launch type the ECS service is using.

Compute Optimizer only supports the Fargate launch type.

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

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

The following is the format of the ARN:

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

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

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