list-automation-rule-preview¶

Description¶

Returns a preview of the recommended actions that match your Automation rule’s configuration and criteria.

Synopsis¶

  list-automation-rule-preview
--rule-type <value>
[--organization-scope <value>]
--recommended-action-types <value>
[--criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--rule-type (string) [required]

The type of rule.

Note
Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

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.

Constraints:

min: 1

max: 50

(string)

Constraints:

pattern: [0-9]{12}

Shorthand Syntax:

accountIds=string,string

JSON Syntax:

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

--recommended-action-types (list) [required]

The types of recommended actions to include in the preview.

(string)

Recommended action type enumeration

Possible values:

SnapshotAndDeleteUnattachedEbsVolume

UpgradeEbsVolumeType

Syntax:

"string" "string" ...

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

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

values -> (list)

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

(string)

Constraints:

min: 1

max: 512

pattern: [\w\s\.\-\:\/\=\+\@\*\?]+

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

values -> (list)

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

(string)

Constraints:

min: 1

max: 512

pattern: [\w\s\.\-\:\/\=\+\@\*\?]+

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

values -> (list)

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

(string)

Constraints:

min: 1

max: 512

pattern: [\w\s\.\-\:\/\=\+\@\*\?]+

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

key -> (string)

The tag key to use for comparison when filtering resources.

Constraints:

min: 1

max: 512

pattern: [\w\s\.\-\:\/\=\+\@\*\?]+

values -> (list)

List of tag values to compare against when filtering resources.

(string)

Constraints:

min: 1

max: 512

pattern: [\w\s\.\-\:\/\=\+\@\*\?]+

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

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.

Possible values:

StringEquals

StringNotEquals

StringEqualsIgnoreCase

StringNotEqualsIgnoreCase

StringLike

StringNotLike

NumericEquals

NumericNotEquals

NumericLessThan

NumericLessThanEquals

NumericGreaterThan

NumericGreaterThanEquals

values -> (list)

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

(string)

Constraints:

min: 1

max: 512

pattern: [\w\s\.\-\:\/\=\+\@\*\?]+

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

--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. 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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

previewResults -> (list)

The list of actions that would be taken based on the specified criteria.

(structure)

Contains the results of previewing an automation rule against available recommendations.

recommendedActionId -> (string)

The ID of the recommended action being previewed.

Constraints:

pattern: [0-9A-Za-z]{16}

resourceArn -> (string)

The Amazon Resource Name (ARN) of the resource affected by the recommended action.

Constraints:

pattern: arn:aws[a-z0-9-]*:[a-z0-9-]+:[a-z0-9-]*:[0-9]{0,12}:[a-zA-Z0-9/_.-]+

resourceId -> (string)

The ID of the resource affected by the recommended action.

Constraints:

min: 1

max: 100

pattern: [a-zA-Z0-9_.-]+

accountId -> (string)

The Amazon Web Services account ID associated with the resource.

Constraints:

pattern: [0-9]{12}

region -> (string)

The Amazon Web Services Region where the resource is located.

resourceType -> (string)

The type of resource being evaluated.

Possible values:

EbsVolume

lookBackPeriodInDays -> (integer)

The number of days of historical data used to analyze the resource.

recommendedActionType -> (string)

The type of recommended action being previewed.

Possible values:

SnapshotAndDeleteUnattachedEbsVolume

UpgradeEbsVolumeType

currentResourceSummary -> (string)

A summary of the resource’s current configuration.

currentResourceDetails -> (tagged union structure)

Detailed configuration information for a specific Amazon Web Services resource, with type-specific details.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ebsVolume.

ebsVolume -> (structure)

Detailed configuration information specific to EBS volumes, including volume type, size, IOPS, and throughput settings.

configuration -> (structure)

The configuration details of the EBS volume, including type, size, IOPS, and throughput.

type -> (string)

The EBS volume type, such as gp2, gp3, io1, io2, st1, or sc1.

sizeInGib -> (integer)

The size of the EBS volume in gibibytes (GiB).

iops -> (integer)

The number of I/O operations per second (IOPS) provisioned for the volume.

throughput -> (integer)

The throughput in MiB/s provisioned for the volume (applicable to gp3, io1, and io2bx volumes).

recommendedResourceSummary -> (string)

A summary of the resource’s recommended configuration.

recommendedResourceDetails -> (tagged union structure)

Detailed configuration information for a specific Amazon Web Services resource, with type-specific details.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: ebsVolume.

ebsVolume -> (structure)

Detailed configuration information specific to EBS volumes, including volume type, size, IOPS, and throughput settings.

configuration -> (structure)

The configuration details of the EBS volume, including type, size, IOPS, and throughput.

type -> (string)

The EBS volume type, such as gp2, gp3, io1, io2, st1, or sc1.

sizeInGib -> (integer)

The size of the EBS volume in gibibytes (GiB).

iops -> (integer)

The number of I/O operations per second (IOPS) provisioned for the volume.

throughput -> (integer)

The throughput in MiB/s provisioned for the volume (applicable to gp3, io1, and io2bx volumes).

restartNeeded -> (boolean)

Indicates whether implementing the recommended action requires a resource restart.

estimatedMonthlySavings -> (structure)

Contains information about estimated monthly cost savings.

currency -> (string) [required]

The currency of the estimated savings.

beforeDiscountSavings -> (double) [required]

The estimated monthly savings before applying any discounts.

afterDiscountSavings -> (double) [required]

The estimated monthly savings after applying any discounts.

savingsEstimationMode -> (string) [required]

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

Possible values:

BeforeDiscount

AfterDiscount

resourceTags -> (list)

The tags associated with the resource.

Constraints:

min: 0

max: 200

(structure)

A key-value pair used to categorize and organize Amazon Web Services resources and automation rules.

key -> (string) [required]

The tag key, which can be up to 128 characters long.

Constraints:

min: 1

max: 128

pattern: [\w\s\.\-\:\/\=\+\@]+

value -> (string) [required]

The tag value, which can be up to 256 characters long.

Constraints:

min: 0

max: 256

pattern: [\w\s\.\-\:\/\=\+\@]*

nextToken -> (string)

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

Constraints:

pattern: [A-Za-z0-9+/=]+

Table of Contents

Feedback

User Guide

list-automation-rule-preview¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Output¶

Note

Note