[ aws . compute-optimizer ]

get-ec2-instance-recommendations

Description

Returns Amazon EC2 instance recommendations.

AWS Compute Optimizer currently generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) and Amazon EC2 Auto Scaling. It generates recommendations for M, C, R, T, and X instance families. For more information, see the AWS Compute Optimizer User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-ec2-instance-recommendations
[--instance-arns <value>]
[--next-token <value>]
[--max-results <value>]
[--filters <value>]
[--account-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--instance-arns (list)

The Amazon Resource Name (ARN) of the instances for which to return recommendations.

(string)

Syntax:

"string" "string" ...

--next-token (string)

The token to advance to the next page of instance recommendations.

--max-results (integer)

The maximum number of instance recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned NextToken value.

--filters (list)

An array of objects that describe a filter that returns a more specific list of instance recommendations.

(structure)

Describes a filter that returns a more specific list of recommendations.

name -> (string)

The name of the filter.

Specify Finding to return recommendations with a specific findings classification (e.g., Overprovisioned ).

Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup ).

values -> (list)

The value of the filter.

If you specify the name parameter as Finding , and you request recommendations for an instance , then the valid values are Underprovisioned , Overprovisioned , NotOptimized , or Optimized .

If you specify the name parameter as Finding , and you request recommendations for an Auto Scaling group , then the valid values are Optimized , or NotOptimized .

If you specify the name parameter as RecommendationSourceType , then the valid values are Ec2Instance , or AutoScalingGroup .

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "Finding"|"RecommendationSourceType",
    "values": ["string", ...]
  }
  ...
]

--account-ids (list)

The IDs of the AWS accounts for which to return instance recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to return instance recommendations.

Only one account ID can be specified per request.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

nextToken -> (string)

The token to use to advance to the next page of instance recommendations.

This value is null when there are no more pages of instance recommendations to return.

instanceRecommendations -> (list)

An array of objects that describe instance recommendations.

(structure)

Describes an Amazon EC2 instance recommendation.

instanceArn -> (string)

The Amazon Resource Name (ARN) of the current instance.

accountId -> (string)

The AWS account ID of the instance.

instanceName -> (string)

The name of the current instance.

currentInstanceType -> (string)

The instance type of the current instance.

finding -> (string)

The finding classification for the instance.

Findings for instances include:

• **Underprovisioned ** —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.

• **Overprovisioned ** —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.

• **Optimized ** —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.

Note

The values that are returned might be UNDER_PROVISIONED , OVER_PROVISIONED , or OPTIMIZED .

utilizationMetrics -> (list)

An array of objects that describe the utilization metrics of the instance.

(structure)

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

name -> (string)

The name of the utilization metric.

Note

Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .

statistic -> (string)

The statistic of the utilization metric.

value -> (double)

The value of the utilization metric.

lookBackPeriodInDays -> (double)

The number of days for which utilization metrics were analyzed for the instance.

recommendationOptions -> (list)

An array of objects that describe the recommendation options for the instance.

(structure)

Describes a recommendation option for an Amazon EC2 instance.

instanceType -> (string)

The instance type of the instance recommendation.

projectedUtilizationMetrics -> (list)

An array of objects that describe the projected utilization metrics of the instance recommendation option.

(structure)

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

name -> (string)

The name of the utilization metric.

Note

Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent .

statistic -> (string)

The statistic of the utilization metric.

value -> (double)

The value of the utilization metric.

performanceRisk -> (double)

The performance risk of the instance recommendation option.

Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload.

The lowest performance risk is categorized as 0 , and the highest as 5 .

rank -> (integer)

The rank of the instance recommendation option.

The top recommendation option is ranked as 1 .

recommendationSources -> (list)

An array of objects that describe the source resource of the recommendation.

(structure)

Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.

recommendationSourceArn -> (string)

The Amazon Resource Name (ARN) of the recommendation source.

recommendationSourceType -> (string)

The resource type of the recommendation source.

lastRefreshTimestamp -> (timestamp)

The time stamp of when the instance recommendation was last refreshed.

errors -> (list)

An array of objects that describe errors of the request.

For example, an error is returned if you request recommendations for an instance of an unsupported instance family.

(structure)

Describes an error experienced when getting recommendations.

For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.

identifier -> (string)

The ID of the error.

code -> (string)

The error code.

message -> (string)

The message, or reason, for the error.