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-rules¶

Description¶

Lists the automation rules that match specified filters.

Synopsis¶

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

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

The name of the filter field to apply.

values -> (list)

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

(string)

Shorthand Syntax:

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

JSON Syntax:

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

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.

ruleId -> (string)

The unique identifier of the automation rule.

name -> (string)

The name of the automation rule.

description -> (string)

A description of the automation rule.

ruleType -> (string)

The type of automation rule (OrganizationRule or 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.

organizationConfiguration -> (structure)

Configuration settings for organization-wide rules.

ruleApplyOrder -> (string)

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

accountIds -> (list)

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

(string)

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

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.

status -> (string)

The current status of the automation rule (Active or 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.

Table of Contents

Feedback

User Guide