get-automation-rule¶

Description¶

Retrieves details about a specific automation rule.

Synopsis¶

  get-automation-rule
--rule-arn <value>
[--cli-input-json | --cli-input-yaml]
[--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-arn (string) [required]

The ARN of the rule to retrieve.

Constraints:

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

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

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

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.

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

recommendedActionTypes -> (list)

List of recommended action types that this rule can execute.

(string)

Recommended action type enumeration

Possible values:

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.

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\.\-\:\/\=\+\@\*\?]+

schedule -> (structure)

Configuration for scheduling when automation rules should execute, including timing and execution windows.

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

tags -> (list)

The tags associated with the automation rule.

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\.\-\:\/\=\+\@]*

createdTimestamp -> (timestamp)

The timestamp when the automation rule was created.

lastUpdatedTimestamp -> (timestamp)

The timestamp when the automation rule was last updated.

Table of Contents

Feedback

User Guide