AutomationRule - AWS Compute Optimizer

AutomationRule

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

Contents

accountId

The 12-digit AWS account ID that owns this automation rule.

Type: String

Pattern: [0-9]{12}

Required: No

createdTimestamp

The timestamp when the automation rule was created.

Type: Timestamp

Required: No

description

A description of the automation rule.

Type: String

Required: No

lastUpdatedTimestamp

The timestamp when the automation rule was last updated.

Type: Timestamp

Required: No

name

The name of the automation rule.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9_-]*

Required: No

organizationConfiguration

Configuration settings for organization-wide rules.

Type: OrganizationConfiguration object

Required: No

priority

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.

Type: String

Required: No

recommendedActionTypes

List of recommended action types that this rule can execute.

Type: Array of strings

Valid Values: SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType

Required: No

ruleArn

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

Type: String

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

Required: No

ruleId

The unique identifier of the automation rule.

Type: String

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

Required: No

ruleRevision

The revision number of the automation rule.

Type: Long

Required: No

ruleType

The type of automation rule (OrganizationRule or AccountRule).

Type: String

Valid Values: OrganizationRule | AccountRule

Required: No

schedule

The schedule configuration for when the automation rule should execute.

Type: Schedule object

Required: No

status

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

Type: String

Valid Values: Active | Inactive

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: