Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ce ]

get-rightsizing-recommendation

Description

Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-rightsizing-recommendation
[--filter <value>]
--service <value>
[--page-size <value>]
[--next-page-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--filter (structure)

Use Expression to filter by cost or by usage. There are two patterns:

  • Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . The Expression for that looks like this: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.
  • Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

Note

Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.

{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

Note

For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .

JSON Syntax:

{
  "Or": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION",
        "Values": ["string", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...]
      }
    }
    ...
  ],
  "And": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION",
        "Values": ["string", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...]
      }
    }
    ...
  ],
  "Not": {
    "Or": [
      { ... recursive ... }
      ...
    ],
    "And": [
      { ... recursive ... }
      ...
    ],
    "Not": { ... recursive ... },
    "Dimensions": {
      "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION",
      "Values": ["string", ...]
    },
    "Tags": {
      "Key": "string",
      "Values": ["string", ...]
    }
  },
  "Dimensions": {
    "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION",
    "Values": ["string", ...]
  },
  "Tags": {
    "Key": "string",
    "Values": ["string", ...]
  }
}

--service (string)

The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is "AmazonEC2 ".

--page-size (integer)

The number of recommendations that you want returned in a single response object.

--next-page-token (string)

The pagination token that indicates the next set of results that you want to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Metadata -> (structure)

Information regarding this specific recommendation set.

RecommendationId -> (string)

The ID for this specific recommendation.

GenerationTimestamp -> (string)

The time stamp for when Amazon Web Services made this recommendation.

LookbackPeriodInDays -> (string)

How many days of previous usage that Amazon Web Services considers when making this recommendation.

Summary -> (structure)

Summary of this recommendation set.

TotalRecommendationCount -> (string)

Total number of instance recommendations.

EstimatedTotalMonthlySavingsAmount -> (string)

Estimated total savings resulting from modifications, on a monthly basis.

SavingsCurrencyCode -> (string)

The currency code that Amazon Web Services used to calculate the savings.

SavingsPercentage -> (string)

Savings percentage based on the recommended modifications, relative to the total On Demand costs associated with these instances.

RightsizingRecommendations -> (list)

Recommendations to rightsize resources.

(structure)

Recommendations to rightsize resources.

AccountId -> (string)

The account that this recommendation is for.

CurrentInstance -> (structure)

Context regarding the current instance.

ResourceId -> (string)

Resource ID of the current instance.

Tags -> (list)

Cost allocation resource tags applied to the instance.

(structure)

The values that are available for a tag.

Key -> (string)

The key for the tag.

Values -> (list)

The specific value of the tag.

(string)

ResourceDetails -> (structure)

Details about the resource and utilization.

EC2ResourceDetails -> (structure)

Details on the Amazon EC2 resource.

HourlyOnDemandRate -> (string)

Hourly public On Demand rate for the instance type.

InstanceType -> (string)

The type of Amazon Web Services instance.

Platform -> (string)

The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.

Region -> (string)

The Amazon Web Services Region of the instance.

Sku -> (string)

The SKU of the product.

Memory -> (string)

Memory capacity of Amazon Web Services instance.

NetworkPerformance -> (string)

Network performance capacity of the Amazon Web Services instance.

Storage -> (string)

The disk storage of the Amazon Web Services instance (Not EBS storage).

Vcpu -> (string)

Number of VCPU cores in the Amazon Web Services instance type.

ResourceUtilization -> (structure)

Utilization information of the current instance during the lookback period.

EC2ResourceUtilization -> (structure)

Utilization of current Amazon EC2 Instance

MaxCpuUtilizationPercentage -> (string)

Maximum observed or expected CPU utilization of the instance.

MaxMemoryUtilizationPercentage -> (string)

Maximum observed or expected memory utilization of the instance.

MaxStorageUtilizationPercentage -> (string)

Maximum observed or expected storage utilization of the instance (does not measure EBS storage).

ReservationCoveredHoursInLookbackPeriod -> (string)

Number of hours during the lookback period covered by reservations.

SavingsPlansCoveredHoursInLookbackPeriod -> (string)

Number of hours during the lookback period covered by Savings Plans.

OnDemandHoursInLookbackPeriod -> (string)

Number of hours during the lookback period billed at On Demand rates.

TotalRunningHoursInLookbackPeriod -> (string)

The total number of hours the instance ran during the lookback period.

MonthlyCost -> (string)

Current On Demand cost of operating this instance on a monthly basis.

CurrencyCode -> (string)

The currency code that Amazon Web Services used to calculate the costs for this instance.

RightsizingType -> (string)

Recommendation to either terminate or modify the resource.

ModifyRecommendationDetail -> (structure)

Details for modification recommendations.

TargetInstances -> (list)

Identifies whether this instance type is the Amazon Web Services default recommendation.

(structure)

Details on recommended instance.

EstimatedMonthlyCost -> (string)

Expected cost to operate this instance type on a monthly basis.

EstimatedMonthlySavings -> (string)

Estimated savings resulting from modification, on a monthly basis.

CurrencyCode -> (string)

The currency code that Amazon Web Services used to calculate the costs for this instance.

DefaultTargetInstance -> (boolean)

Indicates whether or not this recommendation is the defaulted Amazon Web Services recommendation.

ResourceDetails -> (structure)

Details on the target instance type.

EC2ResourceDetails -> (structure)

Details on the Amazon EC2 resource.

HourlyOnDemandRate -> (string)

Hourly public On Demand rate for the instance type.

InstanceType -> (string)

The type of Amazon Web Services instance.

Platform -> (string)

The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.

Region -> (string)

The Amazon Web Services Region of the instance.

Sku -> (string)

The SKU of the product.

Memory -> (string)

Memory capacity of Amazon Web Services instance.

NetworkPerformance -> (string)

Network performance capacity of the Amazon Web Services instance.

Storage -> (string)

The disk storage of the Amazon Web Services instance (Not EBS storage).

Vcpu -> (string)

Number of VCPU cores in the Amazon Web Services instance type.

ExpectedResourceUtilization -> (structure)

Expected utilization metrics for target instance type.

EC2ResourceUtilization -> (structure)

Utilization of current Amazon EC2 Instance

MaxCpuUtilizationPercentage -> (string)

Maximum observed or expected CPU utilization of the instance.

MaxMemoryUtilizationPercentage -> (string)

Maximum observed or expected memory utilization of the instance.

MaxStorageUtilizationPercentage -> (string)

Maximum observed or expected storage utilization of the instance (does not measure EBS storage).

TerminateRecommendationDetail -> (structure)

Details for termination recommendations.

EstimatedMonthlySavings -> (string)

Estimated savings resulting from modification, on a monthly basis.

CurrencyCode -> (string)

The currency code that Amazon Web Services used to calculate the costs for this instance.

NextPageToken -> (string)

The token to retrieve the next set of results.