get-ec2-instance-recommendations¶

Description¶

Returns Amazon EC2 instance recommendations.

AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide .

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>]

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.

This filter is used with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

name -> (string)

The name of the filter.

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

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

values -> (list)

The value of the filter.

The valid values for this parameter are as follows, depending on what you specify for the name parameter and the resource type that you wish to filter results for:

Specify Optimized or NotOptimized if you specified the name parameter as Finding and you want to filter results for Auto Scaling groups.

Specify Underprovisioned , Overprovisioned , or Optimized if you specified the name parameter as Finding and you want to filter results for EC2 instances.

Specify Ec2Instance or AutoScalingGroup if you specified the name parameter as RecommendationSourceType .

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--account-ids (list)

The ID of the AWS account for which to return instance recommendations.

If your account is the management account of an organization, use this parameter to specify the member account 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.

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.

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.

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

name -> (string)

The name of the utilization metric.

The following utilization metrics are available:

Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent

Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance. Units: Percent

Note

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 .

EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: Count

EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: Count

EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: Bytes

EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: Bytes

statistic -> (string)

The statistic of the utilization metric.

The following statistics are available:

Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.

Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

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.

Note

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 .

(structure)

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

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

name -> (string)

The name of the utilization metric.

The following utilization metrics are available:

Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent

Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance. Units: Percent

Note

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 .

EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: Count

EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: Count

EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: Bytes

EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: Bytes

statistic -> (string)

The statistic of the utilization metric.

The following statistics are available:

Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.

Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

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.

Table of Contents

Feedback

User Guide