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 ]

update-automation-rule

Description

Updates an existing automation rule.

See also: AWS API Documentation

Synopsis

  update-automation-rule
--rule-arn <value>
--rule-revision <value>
[--name <value>]
[--description <value>]
[--rule-type <value>]
[--organization-configuration <value>]
[--priority <value>]
[--recommended-action-types <value>]
[--criteria <value>]
[--schedule <value>]
[--status <value>]
[--client-token <value>]
[--cli-input-json <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-arn (string)

The ARN of the rule to update.

--rule-revision (long)

The revision number of the rule to update.

--name (string)

The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.

--description (string)

The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.

--rule-type (string)

The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.

Possible values:

• OrganizationRule
• AccountRule

--organization-configuration (structure)

Updated configuration settings for organization-wide rules, including rule application order and target account IDs.

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)

Shorthand Syntax:

ruleApplyOrder=string,accountIds=string,string

JSON Syntax:

{
  "ruleApplyOrder": "BeforeAccountRules"|"AfterAccountRules",
  "accountIds": ["string", ...]
}

--priority (string)

The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.

--recommended-action-types (list)

Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

(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", ...]
    }
    ...
  ]
}

--schedule (structure)

The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

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.

Shorthand Syntax:

scheduleExpression=string,scheduleExpressionTimezone=string,executionWindowInMinutes=integer

JSON Syntax:

{
  "scheduleExpression": "string",
  "scheduleExpressionTimezone": "string",
  "executionWindowInMinutes": integer
}

--status (string)

The updated status of the automation rule. Can be Active or Inactive.

Possible values:

• Active
• Inactive

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

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

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

ruleArn -> (string)

The ARN of the updated rule.

ruleRevision -> (long)

The new revision number of the updated rule.

name -> (string)

The updated name of the automation rule.

description -> (string)

The updated description of the automation rule.

ruleType -> (string)

The updated type of automation rule.

organizationConfiguration -> (structure)

The updated organization configuration settings.

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)

The updated priority level of the automation rule.

recommendedActionTypes -> (list)

The updated list of recommended action types.

(string)

Recommended action type enumeration

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)

schedule -> (structure)

The updated schedule configuration.

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 updated status of the automation rule.

createdTimestamp -> (timestamp)

The timestamp when the automation rule was originally created.

lastUpdatedTimestamp -> (timestamp)

The timestamp when the automation rule was last updated.