AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . compute-optimizer-automation ]

list-automation-rule-preview-summaries

Description

Returns a summary of the recommended actions that match your rule preview configuration and criteria.

See also: AWS API Documentation

list-automation-rule-preview-summaries is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: previewResultSummaries

Synopsis

  list-automation-rule-preview-summaries
--rule-type <value>
[--organization-scope <value>]
--recommended-action-types <value>
[--criteria <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--rule-type (string)

The type of rule.

Possible values:

  • OrganizationRule
  • AccountRule

--organization-scope (structure)

The organizational scope for the rule preview.

accountIds -> (list)

List of Amazon Web Services account IDs to include in the organization scope.

(string)

Shorthand Syntax:

accountIds=string,string

JSON Syntax:

{
  "accountIds": ["string", ...]
}

--recommended-action-types (list)

The types of recommended actions to include in the preview.

(string)

Recommended action type enumeration

Syntax:

"string" "string" ...

Where valid values are:
  SnapshotAndDeleteUnattachedEbsVolume
  UpgradeEbsVolumeType

--criteria (structure)

A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.

region -> (list)

Filter criteria for Amazon Web Services regions where resources must be located.

(structure)

Criteria condition for filtering based on string values, including comparison operators and target values.

comparison -> (string)

The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

values -> (list)

List of string values to compare against when applying the criteria condition.

(string)

resourceArn -> (list)

Filter criteria for specific resource ARNs to include or exclude.

(structure)

Criteria condition for filtering based on string values, including comparison operators and target values.

comparison -> (string)

The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

values -> (list)

List of string values to compare against when applying the criteria condition.

(string)

ebsVolumeType -> (list)

Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1.

(structure)

Criteria condition for filtering based on string values, including comparison operators and target values.

comparison -> (string)

The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

values -> (list)

List of string values to compare against when applying the criteria condition.

(string)

ebsVolumeSizeInGib -> (list)

Filter criteria for EBS volume sizes in gibibytes (GiB).

(structure)

Defines a condition for filtering based on integer values with comparison operators.

comparison -> (string)

The comparison operator to use, such as equals, greater than, less than, etc.

values -> (list)

The list of integer values to compare against using the specified comparison operator.

(integer)

estimatedMonthlySavings -> (list)

Filter criteria for estimated monthly cost savings from the recommended action.

(structure)

Defines a condition for filtering based on double/floating-point numeric values with comparison operators.

comparison -> (string)

The comparison operator to use, such as equals, greater than, less than, etc.

values -> (list)

The list of double values to compare against using the specified comparison operator.

(double)

resourceTag -> (list)

Filter criteria for resource tags, allowing filtering by tag key and value combinations.

(structure)

Criteria condition for filtering resources based on their tags, including comparison operators and values.

comparison -> (string)

The comparison operator used to evaluate the tag criteria, such as equals, not equals, or contains.

key -> (string)

The tag key to use for comparison when filtering resources.

values -> (list)

List of tag values to compare against when filtering resources.

(string)

lookBackPeriodInDays -> (list)

Filter criteria for the lookback period in days used to analyze resource utilization.

(structure)

Defines a condition for filtering based on integer values with comparison operators.

comparison -> (string)

The comparison operator to use, such as equals, greater than, less than, etc.

values -> (list)

The list of integer values to compare against using the specified comparison operator.

(integer)

restartNeeded -> (list)

Filter criteria indicating whether the recommended action requires a resource restart.

(structure)

Criteria condition for filtering based on string values, including comparison operators and target values.

comparison -> (string)

The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.

values -> (list)

List of string values to compare against when applying the criteria condition.

(string)

JSON Syntax:

{
  "region": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "values": ["string", ...]
    }
    ...
  ],
  "resourceArn": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "values": ["string", ...]
    }
    ...
  ],
  "ebsVolumeType": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "values": ["string", ...]
    }
    ...
  ],
  "ebsVolumeSizeInGib": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "values": [integer, ...]
    }
    ...
  ],
  "estimatedMonthlySavings": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "values": [double, ...]
    }
    ...
  ],
  "resourceTag": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "key": "string",
      "values": ["string", ...]
    }
    ...
  ],
  "lookBackPeriodInDays": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "values": [integer, ...]
    }
    ...
  ],
  "restartNeeded": [
    {
      "comparison": "StringEquals"|"StringNotEquals"|"StringEqualsIgnoreCase"|"StringNotEqualsIgnoreCase"|"StringLike"|"StringNotLike"|"NumericEquals"|"NumericNotEquals"|"NumericLessThan"|"NumericLessThanEquals"|"NumericGreaterThan"|"NumericGreaterThanEquals",
      "values": ["string", ...]
    }
    ...
  ]
}

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

previewResultSummaries -> (list)

The list of automation rule preview summaries that match the specified criteria.

(structure)

Contains a summary of preview results for an automation rule.

key -> (string)

The key identifier for this preview result summary.

total -> (structure)

Aggregate totals for automation rule preview results, including count and estimated savings.

recommendedActionCount -> (integer)

The total number of recommended actions matching the rule preview configuration.

estimatedMonthlySavings -> (structure)

Contains information about estimated monthly cost savings.

currency -> (string)

The currency of the estimated savings.

beforeDiscountSavings -> (double)

The estimated monthly savings before applying any discounts.

afterDiscountSavings -> (double)

The estimated monthly savings after applying any discounts.

savingsEstimationMode -> (string)

The mode used to calculate savings, either BeforeDiscount or AfterDiscount.

nextToken -> (string)

A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.