| Column Name | Column Data Type |
|---|
account_ids Input Column
Return the Amazon ECS service recommendations to the specified Amazon Web Services account IDs. If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon ECS service recommendations to specific member accounts. You can only specify one account ID per request. | VARCHAR[] |
Show child fields- account_ids[]
|
filters Input Column
An array of objects to specify a filter that returns a more specific list of Amazon ECS service recommendations. | STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[] |
Show child fields- filters[]
Show child fields- filters[].name
The name of the filter. Specify Finding to return recommendations with a specific finding classification. Specify FindingReasonCode to return recommendations with a specific finding reason code. You can filter your Amazon ECS service recommendations by tag:key and tag-key tags. A tag:key is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value. A tag-key is the key of a tag assigned to your Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service recommendations with a tag key value of Owner or without any tag keys assigned. - filters[].values[]
|
max_results Input Column
The maximum number of Amazon ECS service recommendations to return with a single request. To retrieve the remaining results, make another request with the returned nextToken value. | BIGINT |
next_token Input Column
The token to advance to the next page of Amazon ECS service recommendations. | VARCHAR |
service_arns Input Column
The ARN that identifies the Amazon ECS service. The following is the format of the ARN: arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name | VARCHAR[] |
Show child fields- service_arns[]
|
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
ecs_service_recommendations
An array of objects that describe the Amazon ECS service recommendations. | STRUCT(
"service_arn" VARCHAR,
"account_id" VARCHAR,
"current_service_configuration" STRUCT(
"memory" BIGINT,
"cpu" BIGINT,
"container_configurations" STRUCT(
"container_name" VARCHAR,
"memory_size_configuration" STRUCT(
"memory" BIGINT,
"memory_reservation" BIGINT
),
"cpu" BIGINT
)[],
"auto_scaling_configuration" VARCHAR,
"task_definition_arn" VARCHAR
),
"utilization_metrics" STRUCT(
"name" VARCHAR,
"statistic" VARCHAR,
"value" DOUBLE
)[],
"lookback_period_in_days" DOUBLE,
"launch_type" VARCHAR,
"last_refresh_timestamp" TIMESTAMP_S,
"finding" VARCHAR,
"finding_reason_codes" VARCHAR[],
"service_recommendation_options" STRUCT(
"memory" BIGINT,
"cpu" BIGINT,
"savings_opportunity" STRUCT(
"savings_opportunity_percentage" DOUBLE,
"estimated_monthly_savings" STRUCT(
"currency" VARCHAR,
"value" DOUBLE
)
),
"savings_opportunity_after_discounts" STRUCT(
"savings_opportunity_percentage" DOUBLE,
"estimated_monthly_savings" STRUCT(
"currency" VARCHAR,
"value" DOUBLE
)
),
"projected_utilization_metrics" STRUCT(
"name" VARCHAR,
"statistic" VARCHAR,
"lower_bound_value" DOUBLE,
"upper_bound_value" DOUBLE
)[],
"container_recommendations" STRUCT(
"container_name" VARCHAR,
"memory_size_configuration" STRUCT(
"memory" BIGINT,
"memory_reservation" BIGINT
),
"cpu" BIGINT
)[]
)[],
"current_performance_risk" VARCHAR,
"effective_recommendation_preferences" STRUCT(
"savings_estimation_mode" STRUCT(
"source" VARCHAR
)
),
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[] |
Show child fields- ecs_service_recommendations[]
Show child fields- ecs_service_recommendations[].account_id
The Amazon Web Services account ID of the Amazon ECS service. - ecs_service_recommendations[].current_performance_risk
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. - ecs_service_recommendations[].current_service_configuration
The configuration of the current Amazon ECS service. Show child fields- ecs_service_recommendations[].current_service_configuration.auto_scaling_configuration
Describes the Auto Scaling configuration methods for an Amazon ECS service. This affects the generated recommendations. For example, if Auto Scaling is configured on a service’s CPU, then Compute Optimizer doesn’t generate CPU size recommendations. The Auto Scaling configuration methods include: -
TARGET_TRACKING_SCALING_CPU — If the Amazon ECS service is configured to use target scaling on CPU, Compute Optimizer doesn't generate CPU recommendations. -
TARGET_TRACKING_SCALING_MEMORY — If the Amazon ECS service is configured to use target scaling on memory, Compute Optimizer doesn't generate memory recommendations. For more information about step scaling and target scaling, see Step scaling policies for Application Auto Scaling and Target tracking scaling policies for Application Auto Scaling in the Application Auto Scaling User Guide. - ecs_service_recommendations[].current_service_configuration.container_configurations[]
Show child fields- ecs_service_recommendations[].current_service_configuration.container_configurations[].container_name
The name of the container. - ecs_service_recommendations[].current_service_configuration.container_configurations[].cpu
The number of CPU units reserved for the container. - ecs_service_recommendations[].current_service_configuration.container_configurations[].memory_size_configuration
The memory size configurations for the container. Show child fields- ecs_service_recommendations[].current_service_configuration.container_configurations[].memory_size_configuration.memory
The amount of memory in the container. - ecs_service_recommendations[].current_service_configuration.container_configurations[].memory_size_configuration.memory_reservation
The limit of memory reserve for the container.
- ecs_service_recommendations[].current_service_configuration.cpu
The number of CPU units used by the tasks in the Amazon ECS service. - ecs_service_recommendations[].current_service_configuration.memory
The amount of memory used by the tasks in the Amazon ECS service. - ecs_service_recommendations[].current_service_configuration.task_definition_arn
The task definition ARN used by the tasks in the Amazon ECS service.
- ecs_service_recommendations[].effective_recommendation_preferences
Describes the effective recommendation preferences for Amazon ECS services. Show child fields- ecs_service_recommendations[].effective_recommendation_preferences.savings_estimation_mode
Describes the savings estimation mode preference applied for calculating savings opportunity for Amazon ECS services. Show child fields- ecs_service_recommendations[].effective_recommendation_preferences.savings_estimation_mode.source
Describes the source for calculating the savings opportunity for Amazon ECS services.
- ecs_service_recommendations[].finding
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. - ecs_service_recommendations[].finding_reason_codes[]
- ecs_service_recommendations[].last_refresh_timestamp
The timestamp of when the Amazon ECS service recommendation was last generated. - ecs_service_recommendations[].launch_type
The launch type the Amazon ECS service is using. Compute Optimizer only supports the Fargate launch type. - ecs_service_recommendations[].lookback_period_in_days
The number of days the Amazon ECS service utilization metrics were analyzed. - ecs_service_recommendations[].service_arn
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 - ecs_service_recommendations[].service_recommendation_options[]
Show child fields- ecs_service_recommendations[].service_recommendation_options[].container_recommendations[]
Show child fields- ecs_service_recommendations[].service_recommendation_options[].container_recommendations[].container_name
The name of the container. - ecs_service_recommendations[].service_recommendation_options[].container_recommendations[].cpu
The recommended number of CPU units reserved for the container. - ecs_service_recommendations[].service_recommendation_options[].container_recommendations[].memory_size_configuration
The recommended memory size configurations for the container. Show child fields- ecs_service_recommendations[].service_recommendation_options[].container_recommendations[].memory_size_configuration.memory
The amount of memory in the container. - ecs_service_recommendations[].service_recommendation_options[].container_recommendations[].memory_size_configuration.memory_reservation
The limit of memory reserve for the container.
- ecs_service_recommendations[].service_recommendation_options[].cpu
The CPU size of the Amazon ECS service recommendation option. - ecs_service_recommendations[].service_recommendation_options[].memory
The memory size of the Amazon ECS service recommendation option. - ecs_service_recommendations[].service_recommendation_options[].projected_utilization_metrics[]
Show child fields- ecs_service_recommendations[].service_recommendation_options[].projected_utilization_metrics[].lower_bound_value
The lower bound values for the projected utilization metrics. - ecs_service_recommendations[].service_recommendation_options[].projected_utilization_metrics[].name
The name of the projected utilization metric. The following utilization metrics are available: - ecs_service_recommendations[].service_recommendation_options[].projected_utilization_metrics[].statistic
The statistic of the projected 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. - ecs_service_recommendations[].service_recommendation_options[].projected_utilization_metrics[].upper_bound_value
The upper bound values for the projected utilization metrics.
- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity
Describes the savings opportunity for recommendations of a given resource type or for the recommendation option of an individual resource. Savings opportunity represents the estimated monthly savings you can achieve by implementing a given Compute Optimizer recommendation. Savings opportunity data requires that you opt in to Cost Explorer, as well as activate Receive Amazon EC2 resource recommendations in the Cost Explorer preferences page. That creates a connection between Cost Explorer and Compute Optimizer. With this connection, Cost Explorer generates savings estimates considering the price of existing resources, the price of recommended resources, and historical usage data. Estimated monthly savings reflects the projected dollar savings associated with each of the recommendations generated. For more information, see Enabling Cost Explorer and Optimizing your cost with Rightsizing Recommendations in the Cost Management User Guide. Show child fields- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity.estimated_monthly_savings
An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.. Show child fields- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity.estimated_monthly_savings.currency
The currency of the estimated monthly savings. - ecs_service_recommendations[].service_recommendation_options[].savings_opportunity.estimated_monthly_savings.value
The value of the estimated monthly savings.
- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity.savings_opportunity_percentage
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer recommendations for a given resource.
- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity_after_discounts
Describes the savings opportunity for Amazon ECS service recommendations or for the recommendation option. Savings opportunity represents the estimated monthly savings after applying Savings Plans discounts. You can achieve this by implementing a given Compute Optimizer recommendation. Show child fields- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity_after_discounts.estimated_monthly_savings
The estimated monthly savings possible by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts. Show child fields- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity_after_discounts.estimated_monthly_savings.currency
The currency of the estimated monthly savings. - ecs_service_recommendations[].service_recommendation_options[].savings_opportunity_after_discounts.estimated_monthly_savings.value
The value of the estimated monthly savings for Amazon ECS services.
- ecs_service_recommendations[].service_recommendation_options[].savings_opportunity_after_discounts.savings_opportunity_percentage
The estimated monthly savings possible as a percentage of monthly cost by adopting Compute Optimizer’s Amazon ECS service recommendations. This includes any applicable Savings Plans discounts.
- ecs_service_recommendations[].tags[]
Show child fields- ecs_service_recommendations[].tags[].key
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values. - ecs_service_recommendations[].tags[].value
One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
- ecs_service_recommendations[].utilization_metrics[]
Show child fields- ecs_service_recommendations[].utilization_metrics[].name
The name of the utilization metric. The following utilization metrics are available: - ecs_service_recommendations[].utilization_metrics[].statistic
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. - ecs_service_recommendations[].utilization_metrics[].value
The value of the utilization metric.
|
errors
An array of objects that describe errors of the request. | STRUCT(
"identifier" VARCHAR,
"code" VARCHAR,
"message" VARCHAR
)[] |
Show child fields- errors[]
Show child fields- errors[].code
The error code. - errors[].identifier
The ID of the error. - errors[].message
The message, or reason, for the error.
|