AWS CLI Command Reference

[ aws . compute-optimizer-automation ]

list-automation-rules

Description

Lists the automation rules that match specified filters.

See also: AWS API Documentation

list-automation-rules 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: automationRules

Synopsis

  list-automation-rules
[--filters <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

--filters (list)

The filters to apply to the list of automation rules.

(structure)

A filter used to narrow down results based on specific criteria.

name -> (string) [required]

The name of the filter field to apply.

Possible values:

  • Name
  • RecommendedActionType
  • Status
  • RuleType
  • OrganizationConfigurationRuleApplyOrder
  • AccountId

values -> (list) [required]

The list of values to filter by for the specified filter field.

(string)

Constraints:

  • min: 1
  • max: 255
  • pattern: [a-zA-Z0-9\-_\.\*\?\s]+

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "name": "Name"|"RecommendedActionType"|"Status"|"RuleType"|"OrganizationConfigurationRuleApplyOrder"|"AccountId",
    "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

automationRules -> (list)

The list of automation rules that match the specified criteria.

(structure)

Represents a complete automation rule configuration including criteria, schedule, and execution settings.

ruleArn -> (string)

The Amazon Resource Name (ARN) of the automation rule.

Constraints:

  • pattern: arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+

ruleId -> (string)

The unique identifier of the automation rule.

Constraints:

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

name -> (string)

The name of the automation rule.

Constraints:

  • min: 0
  • max: 128
  • pattern: [a-zA-Z0-9_-]*

description -> (string)

A description of the automation rule.

ruleType -> (string)

The type of automation rule (OrganizationRule or AccountRule).

Possible values:

  • OrganizationRule
  • AccountRule

ruleRevision -> (long)

The revision number of the automation rule.

accountId -> (string)

The 12-digit Amazon Web Services account ID that owns this automation rule.

Constraints:

  • pattern: [0-9]{12}

organizationConfiguration -> (structure)

Configuration settings for organization-wide rules.

ruleApplyOrder -> (string)

Specifies when organization rules should be applied relative to account rules.

Possible values:

  • BeforeAccountRules
  • AfterAccountRules

accountIds -> (list)

List of specific Amazon Web Services account IDs where the organization rule should be applied.

Constraints:

  • min: 1
  • max: 50

(string)

Constraints:

  • pattern: [0-9]{12}

priority -> (string)

A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.

recommendedActionTypes -> (list)

List of recommended action types that this rule can execute.

(string)

Recommended action type enumeration

Possible values:

  • SnapshotAndDeleteUnattachedEbsVolume
  • UpgradeEbsVolumeType

schedule -> (structure)

The schedule configuration for when the automation rule should execute.

scheduleExpression -> (string)

The expression that defines when the schedule runs. cron expression is supported. A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year )

Note

You can schedule rules to run at most once per day. Your cron expression must use specific values (not wildcards) for the minutes and hours fields. For example: (30 12 * * * ) runs daily at 12:30 PM UTC.

scheduleExpressionTimezone -> (string)

The timezone to use when interpreting the schedule expression.

executionWindowInMinutes -> (integer)

The time window in minutes during which the automation rule can start implementing recommended actions.

Constraints:

  • min: 60
  • max: 1440

status -> (string)

The current status of the automation rule (Active or Inactive).

Possible values:

  • Active
  • Inactive

createdTimestamp -> (timestamp)

The timestamp when the automation rule was created.

lastUpdatedTimestamp -> (timestamp)

The timestamp when the automation rule was last updated.

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+/=]+
© Copyright 2025, Amazon Web Services. Created using Sphinx.