# Compute Optimizer Automation
<a name="API_Operations_Compute_Optimizer_Automation"></a>

The following actions are supported by Compute Optimizer Automation:
+  [AssociateAccounts](API_automation_AssociateAccounts.md) 
+  [CreateAutomationRule](API_automation_CreateAutomationRule.md) 
+  [DeleteAutomationRule](API_automation_DeleteAutomationRule.md) 
+  [DisassociateAccounts](API_automation_DisassociateAccounts.md) 
+  [GetAutomationEvent](API_automation_GetAutomationEvent.md) 
+  [GetAutomationRule](API_automation_GetAutomationRule.md) 
+  [GetEnrollmentConfiguration](API_automation_GetEnrollmentConfiguration.md) 
+  [ListAccounts](API_automation_ListAccounts.md) 
+  [ListAutomationEvents](API_automation_ListAutomationEvents.md) 
+  [ListAutomationEventSteps](API_automation_ListAutomationEventSteps.md) 
+  [ListAutomationEventSummaries](API_automation_ListAutomationEventSummaries.md) 
+  [ListAutomationRulePreview](API_automation_ListAutomationRulePreview.md) 
+  [ListAutomationRulePreviewSummaries](API_automation_ListAutomationRulePreviewSummaries.md) 
+  [ListAutomationRules](API_automation_ListAutomationRules.md) 
+  [ListRecommendedActions](API_automation_ListRecommendedActions.md) 
+  [ListRecommendedActionSummaries](API_automation_ListRecommendedActionSummaries.md) 
+  [ListTagsForResource](API_automation_ListTagsForResource.md) 
+  [RollbackAutomationEvent](API_automation_RollbackAutomationEvent.md) 
+  [StartAutomationEvent](API_automation_StartAutomationEvent.md) 
+  [TagResource](API_automation_TagResource.md) 
+  [UntagResource](API_automation_UntagResource.md) 
+  [UpdateAutomationRule](API_automation_UpdateAutomationRule.md) 
+  [UpdateEnrollmentConfiguration](API_automation_UpdateEnrollmentConfiguration.md) 

# AssociateAccounts
<a name="API_automation_AssociateAccounts"></a>

Associates one or more member accounts with your organization's management account, enabling centralized implementation of optimization actions across those accounts. Once associated, the management account (or a delegated administrator) can apply recommended actions to the member account. When you associate a member account, its organization rule mode is automatically set to "Any allowed," which permits the management account to create Automation rules that automatically apply actions to that account. If the member account has not previously enabled the Automation feature, the association process automatically enables it.

**Note**  
Only the management account or a delegated administrator can perform this action.

## Request Syntax
<a name="API_automation_AssociateAccounts_RequestSyntax"></a>

```
{
   "accountIds": [ "string" ],
   "clientToken": "string"
}
```

## Request Parameters
<a name="API_automation_AssociateAccounts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [accountIds](#API_automation_AssociateAccounts_RequestSyntax) **   <a name="computeoptimizer-automation_AssociateAccounts-request-accountIds"></a>
 The IDs of the member accounts to associate. You can specify up to 50 account IDs.   
Type: Array of strings  
Pattern: `[0-9]{12}`   
Required: Yes

 ** [clientToken](#API_automation_AssociateAccounts_RequestSyntax) **   <a name="computeoptimizer-automation_AssociateAccounts-request-clientToken"></a>
 A unique identifier to ensure idempotency of the request. Valid for 24 hours after creation.   
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

## Response Syntax
<a name="API_automation_AssociateAccounts_ResponseSyntax"></a>

```
{
   "accountIds": [ "string" ],
   "errors": [ "string" ]
}
```

## Response Elements
<a name="API_automation_AssociateAccounts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountIds](#API_automation_AssociateAccounts_ResponseSyntax) **   <a name="computeoptimizer-automation_AssociateAccounts-response-accountIds"></a>
 The IDs of the member accounts that were successfully associated.   
Type: Array of strings  
Pattern: `[0-9]{12}` 

 ** [errors](#API_automation_AssociateAccounts_ResponseSyntax) **   <a name="computeoptimizer-automation_AssociateAccounts-response-errors"></a>
 Any errors that occurred during the association process.   
Type: Array of strings

## Errors
<a name="API_automation_AssociateAccounts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** NotManagementAccountException **   
 The operation can only be performed by a management account.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_AssociateAccounts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/AssociateAccounts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/AssociateAccounts) 

# CreateAutomationRule
<a name="API_automation_CreateAutomationRule"></a>

 Creates a new automation rule to apply recommended actions to resources based on specified criteria. 

## Request Syntax
<a name="API_automation_CreateAutomationRule_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "criteria": { 
      "ebsVolumeSizeInGib": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "ebsVolumeType": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "estimatedMonthlySavings": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "lookBackPeriodInDays": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "region": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceArn": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceTag": [ 
         { 
            "comparison": "string",
            "key": "string",
            "values": [ "string" ]
         }
      ],
      "restartNeeded": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ]
   },
   "description": "string",
   "name": "string",
   "organizationConfiguration": { 
      "accountIds": [ "string" ],
      "ruleApplyOrder": "string"
   },
   "priority": "string",
   "recommendedActionTypes": [ "string" ],
   "ruleType": "string",
   "schedule": { 
      "executionWindowInMinutes": number,
      "scheduleExpression": "string",
      "scheduleExpressionTimezone": "string"
   },
   "status": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_automation_CreateAutomationRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-clientToken"></a>
 A unique identifier to ensure idempotency of the request.   
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [criteria](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-criteria"></a>
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.   
Type: [Criteria](API_automation_Criteria.md) object  
Required: No

 ** [description](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-description"></a>
 A description of the automation rule.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9_\-\s@\.]*`   
Required: No

 ** [name](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-name"></a>
 The name of the automation rule.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_-]*`   
Required: Yes

 ** [organizationConfiguration](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-organizationConfiguration"></a>
 Configuration for organization-level rules. Required for OrganizationRule type.   
Type: [OrganizationConfiguration](API_automation_OrganizationConfiguration.md) object  
Required: No

 ** [priority](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-priority"></a>
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](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-recommendedActionTypes"></a>
 The types of recommended actions this rule will automate.   
Type: Array of strings  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType`   
Required: Yes

 ** [ruleType](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-ruleType"></a>
 The type of rule.   
Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.
Type: String  
Valid Values: `OrganizationRule | AccountRule`   
Required: Yes

 ** [schedule](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-schedule"></a>
 The schedule for when the rule should run.   
Type: [Schedule](API_automation_Schedule.md) object  
Required: Yes

 ** [status](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-status"></a>
The status of the rule   
Type: String  
Valid Values: `Active | Inactive`   
Required: Yes

 ** [tags](#API_automation_CreateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-request-tags"></a>
 The tags to associate with the rule.   
Type: Array of [Tag](API_automation_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_automation_CreateAutomationRule_ResponseSyntax"></a>

```
{
   "createdTimestamp": number,
   "criteria": { 
      "ebsVolumeSizeInGib": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "ebsVolumeType": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "estimatedMonthlySavings": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "lookBackPeriodInDays": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "region": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceArn": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceTag": [ 
         { 
            "comparison": "string",
            "key": "string",
            "values": [ "string" ]
         }
      ],
      "restartNeeded": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ]
   },
   "description": "string",
   "name": "string",
   "organizationConfiguration": { 
      "accountIds": [ "string" ],
      "ruleApplyOrder": "string"
   },
   "priority": "string",
   "recommendedActionTypes": [ "string" ],
   "ruleArn": "string",
   "ruleId": "string",
   "ruleRevision": number,
   "ruleType": "string",
   "schedule": { 
      "executionWindowInMinutes": number,
      "scheduleExpression": "string",
      "scheduleExpressionTimezone": "string"
   },
   "status": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_automation_CreateAutomationRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdTimestamp](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-createdTimestamp"></a>
The timestamp when the automation rule was created.  
Type: Timestamp

 ** [criteria](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-criteria"></a>
 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.   
Type: [Criteria](API_automation_Criteria.md) object

 ** [description](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-description"></a>
A description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.  
Type: String

 ** [name](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-name"></a>
The name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_-]*` 

 ** [organizationConfiguration](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-organizationConfiguration"></a>
Configuration settings for organization-wide rules, including rule application order and target account IDs.  
Type: [OrganizationConfiguration](API_automation_OrganizationConfiguration.md) object

 ** [priority](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-priority"></a>
The priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.  
Type: String

 ** [recommendedActionTypes](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-recommendedActionTypes"></a>
List of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.  
Type: Array of strings  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType` 

 ** [ruleArn](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-ruleArn"></a>
 The Amazon Resource Name (ARN) of the created rule.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+` 

 ** [ruleId](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-ruleId"></a>
 The unique identifier of the created rule.   
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

 ** [ruleRevision](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-ruleRevision"></a>
The revision number of the automation rule. This is incremented each time the rule is updated.  
Type: Long

 ** [ruleType](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-ruleType"></a>
The type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.  
Type: String  
Valid Values: `OrganizationRule | AccountRule` 

 ** [schedule](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-schedule"></a>
The schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.  
Type: [Schedule](API_automation_Schedule.md) object

 ** [status](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-status"></a>
The current status of the automation rule. Can be Active or Inactive.  
Type: String  
Valid Values: `Active | Inactive` 

 ** [tags](#API_automation_CreateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_CreateAutomationRule-response-tags"></a>
A list of key-value pairs used to categorize and organize the automation rule. Maximum of 200 tags allowed.  
Type: Array of [Tag](API_automation_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_automation_CreateAutomationRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The request would exceed service quotas.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_CreateAutomationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/CreateAutomationRule) 

# DeleteAutomationRule
<a name="API_automation_DeleteAutomationRule"></a>

 Deletes an existing automation rule. 

## Request Syntax
<a name="API_automation_DeleteAutomationRule_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "ruleArn": "string",
   "ruleRevision": number
}
```

## Request Parameters
<a name="API_automation_DeleteAutomationRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_DeleteAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_DeleteAutomationRule-request-clientToken"></a>
 A unique identifier to ensure idempotency of the request.   
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [ruleArn](#API_automation_DeleteAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_DeleteAutomationRule-request-ruleArn"></a>
 The ARN of the rule to delete.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+`   
Required: Yes

 ** [ruleRevision](#API_automation_DeleteAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_DeleteAutomationRule-request-ruleRevision"></a>
 The revision number of the rule to delete.   
Type: Long  
Required: Yes

## Response Elements
<a name="API_automation_DeleteAutomationRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_automation_DeleteAutomationRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_DeleteAutomationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/DeleteAutomationRule) 

# DisassociateAccounts
<a name="API_automation_DisassociateAccounts"></a>

 Disassociates member accounts from your organization's management account, removing centralized automation capabilities. Once disassociated, organization rules no longer apply to the member account, and the management account (or delegated administrator) cannot create Automation rules for that account. 

**Note**  
Only the management account or a delegated administrator can perform this action.

## Request Syntax
<a name="API_automation_DisassociateAccounts_RequestSyntax"></a>

```
{
   "accountIds": [ "string" ],
   "clientToken": "string"
}
```

## Request Parameters
<a name="API_automation_DisassociateAccounts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [accountIds](#API_automation_DisassociateAccounts_RequestSyntax) **   <a name="computeoptimizer-automation_DisassociateAccounts-request-accountIds"></a>
 The IDs of the member accounts to disassociate.   
Type: Array of strings  
Pattern: `[0-9]{12}`   
Required: Yes

 ** [clientToken](#API_automation_DisassociateAccounts_RequestSyntax) **   <a name="computeoptimizer-automation_DisassociateAccounts-request-clientToken"></a>
 A unique identifier to ensure idempotency of the request.   
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

## Response Syntax
<a name="API_automation_DisassociateAccounts_ResponseSyntax"></a>

```
{
   "accountIds": [ "string" ],
   "errors": [ "string" ]
}
```

## Response Elements
<a name="API_automation_DisassociateAccounts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountIds](#API_automation_DisassociateAccounts_ResponseSyntax) **   <a name="computeoptimizer-automation_DisassociateAccounts-response-accountIds"></a>
 The IDs of the member accounts that were successfully disassociated.   
Type: Array of strings  
Pattern: `[0-9]{12}` 

 ** [errors](#API_automation_DisassociateAccounts_ResponseSyntax) **   <a name="computeoptimizer-automation_DisassociateAccounts-response-errors"></a>
 Any errors that occurred during the disassociation process.   
Type: Array of strings

## Errors
<a name="API_automation_DisassociateAccounts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** NotManagementAccountException **   
 The operation can only be performed by a management account.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_DisassociateAccounts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/DisassociateAccounts) 

# GetAutomationEvent
<a name="API_automation_GetAutomationEvent"></a>

 Retrieves details about a specific automation event. 

## Request Syntax
<a name="API_automation_GetAutomationEvent_RequestSyntax"></a>

```
{
   "eventId": "string"
}
```

## Request Parameters
<a name="API_automation_GetAutomationEvent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [eventId](#API_automation_GetAutomationEvent_RequestSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-request-eventId"></a>
 The ID of the automation event to retrieve.   
Type: String  
Pattern: `[0-9A-Za-z]{16}`   
Required: Yes

## Response Syntax
<a name="API_automation_GetAutomationEvent_ResponseSyntax"></a>

```
{
   "accountId": "string",
   "completedTimestamp": number,
   "createdTimestamp": number,
   "estimatedMonthlySavings": { 
      "afterDiscountSavings": number,
      "beforeDiscountSavings": number,
      "currency": "string",
      "savingsEstimationMode": "string"
   },
   "eventDescription": "string",
   "eventId": "string",
   "eventStatus": "string",
   "eventStatusReason": "string",
   "eventType": "string",
   "recommendedActionId": "string",
   "region": "string",
   "resourceArn": "string",
   "resourceId": "string",
   "resourceType": "string",
   "ruleId": "string"
}
```

## Response Elements
<a name="API_automation_GetAutomationEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountId](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-accountId"></a>
The AWS account ID associated with the automation event.  
Type: String  
Pattern: `[0-9]{12}` 

 ** [completedTimestamp](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-completedTimestamp"></a>
The timestamp when the automation event completed.  
Type: Timestamp

 ** [createdTimestamp](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-createdTimestamp"></a>
The timestamp when the automation event was created.  
Type: Timestamp

 ** [estimatedMonthlySavings](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-estimatedMonthlySavings"></a>
 Contains information about estimated monthly cost savings.   
Type: [EstimatedMonthlySavings](API_automation_EstimatedMonthlySavings.md) object

 ** [eventDescription](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-eventDescription"></a>
A description of the automation event.  
Type: String

 ** [eventId](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-eventId"></a>
The ID of the automation event to retrieve.  
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

 ** [eventStatus](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-eventStatus"></a>
The current status of the automation event.  
Type: String  
Valid Values: `Ready | InProgress | Complete | Failed | Cancelled | RollbackReady | RollbackInProgress | RollbackComplete | RollbackFailed` 

 ** [eventStatusReason](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-eventStatusReason"></a>
The reason for the current event status.  
Type: String

 ** [eventType](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-eventType"></a>
The type of automation event.  
Type: String  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType` 

 ** [recommendedActionId](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-recommendedActionId"></a>
The ID of the recommended action associated with this automation event.  
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

 ** [region](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-region"></a>
The AWS Region where the automation event occurred.  
Type: String

 ** [resourceArn](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource affected by the automation event.  
Type: String  
Pattern: `arn:aws[a-z0-9-]*:[a-z0-9-]+:[a-z0-9-]*:[0-9]{0,12}:[a-zA-Z0-9/_.-]+` 

 ** [resourceId](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-resourceId"></a>
The ID of the resource affected by the automation event.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9_.-]+` 

 ** [resourceType](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-resourceType"></a>
The type of resource affected by the automation event.  
Type: String  
Valid Values: `EbsVolume` 

 ** [ruleId](#API_automation_GetAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationEvent-response-ruleId"></a>
The ID of the automation rule that triggered this event.  
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

## Errors
<a name="API_automation_GetAutomationEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_GetAutomationEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/GetAutomationEvent) 

# GetAutomationRule
<a name="API_automation_GetAutomationRule"></a>

 Retrieves details about a specific automation rule. 

## Request Syntax
<a name="API_automation_GetAutomationRule_RequestSyntax"></a>

```
{
   "ruleArn": "string"
}
```

## Request Parameters
<a name="API_automation_GetAutomationRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ruleArn](#API_automation_GetAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-request-ruleArn"></a>
 The ARN of the rule to retrieve.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+`   
Required: Yes

## Response Syntax
<a name="API_automation_GetAutomationRule_ResponseSyntax"></a>

```
{
   "accountId": "string",
   "createdTimestamp": number,
   "criteria": { 
      "ebsVolumeSizeInGib": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "ebsVolumeType": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "estimatedMonthlySavings": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "lookBackPeriodInDays": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "region": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceArn": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceTag": [ 
         { 
            "comparison": "string",
            "key": "string",
            "values": [ "string" ]
         }
      ],
      "restartNeeded": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ]
   },
   "description": "string",
   "lastUpdatedTimestamp": number,
   "name": "string",
   "organizationConfiguration": { 
      "accountIds": [ "string" ],
      "ruleApplyOrder": "string"
   },
   "priority": "string",
   "recommendedActionTypes": [ "string" ],
   "ruleArn": "string",
   "ruleId": "string",
   "ruleRevision": number,
   "ruleType": "string",
   "schedule": { 
      "executionWindowInMinutes": number,
      "scheduleExpression": "string",
      "scheduleExpressionTimezone": "string"
   },
   "status": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_automation_GetAutomationRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountId](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-accountId"></a>
The 12-digit AWS account ID that owns this automation rule.  
Type: String  
Pattern: `[0-9]{12}` 

 ** [createdTimestamp](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-createdTimestamp"></a>
The timestamp when the automation rule was created.  
Type: Timestamp

 ** [criteria](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-criteria"></a>
 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.   
Type: [Criteria](API_automation_Criteria.md) object

 ** [description](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-description"></a>
A description of the automation rule.  
Type: String

 ** [lastUpdatedTimestamp](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-lastUpdatedTimestamp"></a>
The timestamp when the automation rule was last updated.  
Type: Timestamp

 ** [name](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-name"></a>
The name of the automation rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_-]*` 

 ** [organizationConfiguration](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-organizationConfiguration"></a>
Configuration settings for organization-wide automation rules.  
Type: [OrganizationConfiguration](API_automation_OrganizationConfiguration.md) object

 ** [priority](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-priority"></a>
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.  
Type: String

 ** [recommendedActionTypes](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-recommendedActionTypes"></a>
List of recommended action types that this rule can execute.  
Type: Array of strings  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType` 

 ** [ruleArn](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-ruleArn"></a>
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_-]+` 

 ** [ruleId](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-ruleId"></a>
The unique identifier of the automation rule.  
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

 ** [ruleRevision](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-ruleRevision"></a>
The revision number of the automation rule.  
Type: Long

 ** [ruleType](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-ruleType"></a>
The type of automation rule.  
Type: String  
Valid Values: `OrganizationRule | AccountRule` 

 ** [schedule](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-schedule"></a>
Configuration for scheduling when automation rules should execute, including timing and execution windows.  
Type: [Schedule](API_automation_Schedule.md) object

 ** [status](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-status"></a>
The current status of the automation rule (Active or Inactive).  
Type: String  
Valid Values: `Active | Inactive` 

 ** [tags](#API_automation_GetAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_GetAutomationRule-response-tags"></a>
The tags associated with the automation rule.  
Type: Array of [Tag](API_automation_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_automation_GetAutomationRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_GetAutomationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/GetAutomationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/GetAutomationRule) 

# GetEnrollmentConfiguration
<a name="API_automation_GetEnrollmentConfiguration"></a>

 Retrieves the current enrollment configuration for Compute Optimizer Automation. 

## Response Syntax
<a name="API_automation_GetEnrollmentConfiguration_ResponseSyntax"></a>

```
{
   "lastUpdatedTimestamp": number,
   "organizationRuleMode": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_automation_GetEnrollmentConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [lastUpdatedTimestamp](#API_automation_GetEnrollmentConfiguration_ResponseSyntax) **   <a name="computeoptimizer-automation_GetEnrollmentConfiguration-response-lastUpdatedTimestamp"></a>
 The timestamp of the last update to the enrollment configuration.   
Type: Timestamp

 ** [organizationRuleMode](#API_automation_GetEnrollmentConfiguration_ResponseSyntax) **   <a name="computeoptimizer-automation_GetEnrollmentConfiguration-response-organizationRuleMode"></a>
Specifies whether the management account can create Automation rules that implement optimization actions for this account.   
Type: String  
Valid Values: `AnyAllowed | NoneAllowed` 

 ** [status](#API_automation_GetEnrollmentConfiguration_ResponseSyntax) **   <a name="computeoptimizer-automation_GetEnrollmentConfiguration-response-status"></a>
 The current enrollment status.   
Type: String  
Valid Values: `Active | Inactive | Pending | Failed` 

 ** [statusReason](#API_automation_GetEnrollmentConfiguration_ResponseSyntax) **   <a name="computeoptimizer-automation_GetEnrollmentConfiguration-response-statusReason"></a>
 The reason for the current enrollment status.   
Type: String

## Errors
<a name="API_automation_GetEnrollmentConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_GetEnrollmentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/GetEnrollmentConfiguration) 

# ListAccounts
<a name="API_automation_ListAccounts"></a>

 Lists the accounts in your organization that are enrolled in Compute Optimizer and whether they have enabled Automation. 

**Note**  
Only the management account or a delegated administrator can perform this action.

## Request Syntax
<a name="API_automation_ListAccounts_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_automation_ListAccounts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_automation_ListAccounts_RequestSyntax) **   <a name="computeoptimizer-automation_ListAccounts-request-maxResults"></a>
 The maximum number of results to return in a single call.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_automation_ListAccounts_RequestSyntax) **   <a name="computeoptimizer-automation_ListAccounts-request-nextToken"></a>
 The token for the next page of results.   
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_automation_ListAccounts_ResponseSyntax"></a>

```
{
   "accounts": [ 
      { 
         "accountId": "string",
         "lastUpdatedTimestamp": number,
         "organizationRuleMode": "string",
         "status": "string",
         "statusReason": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_automation_ListAccounts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accounts](#API_automation_ListAccounts_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAccounts-response-accounts"></a>
 The list of accounts in your organization enrolled in Compute Optimizer   
Type: Array of [AccountInfo](API_automation_AccountInfo.md) objects

 ** [nextToken](#API_automation_ListAccounts_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAccounts-response-nextToken"></a>
 The token to use to retrieve the next page of results.   
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_automation_ListAccounts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** NotManagementAccountException **   
 The operation can only be performed by a management account.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListAccounts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListAccounts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListAccounts) 

# ListAutomationEvents
<a name="API_automation_ListAutomationEvents"></a>

Lists automation events based on specified filters. You can retrieve events that were created within the past year. 

## Request Syntax
<a name="API_automation_ListAutomationEvents_RequestSyntax"></a>

```
{
   "endTimeExclusive": number,
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "startTimeInclusive": number
}
```

## Request Parameters
<a name="API_automation_ListAutomationEvents_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endTimeExclusive](#API_automation_ListAutomationEvents_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEvents-request-endTimeExclusive"></a>
 The end of the time range to query for events.   
Type: Timestamp  
Required: No

 ** [filters](#API_automation_ListAutomationEvents_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEvents-request-filters"></a>
 The filters to apply to the list of automation events.   
Type: Array of [AutomationEventFilter](API_automation_AutomationEventFilter.md) objects  
Required: No

 ** [maxResults](#API_automation_ListAutomationEvents_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEvents-request-maxResults"></a>
 The maximum number of results to return in a single call.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListAutomationEvents_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEvents-request-nextToken"></a>
 The token for the next page of results.   
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

 ** [startTimeInclusive](#API_automation_ListAutomationEvents_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEvents-request-startTimeInclusive"></a>
 The start of the time range to query for events.   
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_automation_ListAutomationEvents_ResponseSyntax"></a>

```
{
   "automationEvents": [ 
      { 
         "accountId": "string",
         "completedTimestamp": number,
         "createdTimestamp": number,
         "estimatedMonthlySavings": { 
            "afterDiscountSavings": number,
            "beforeDiscountSavings": number,
            "currency": "string",
            "savingsEstimationMode": "string"
         },
         "eventDescription": "string",
         "eventId": "string",
         "eventStatus": "string",
         "eventStatusReason": "string",
         "eventType": "string",
         "recommendedActionId": "string",
         "region": "string",
         "resourceArn": "string",
         "resourceId": "string",
         "resourceType": "string",
         "ruleId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_automation_ListAutomationEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [automationEvents](#API_automation_ListAutomationEvents_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationEvents-response-automationEvents"></a>
 The list of automation events that match the specified criteria.   
Type: Array of [AutomationEvent](API_automation_AutomationEvent.md) objects

 ** [nextToken](#API_automation_ListAutomationEvents_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationEvents-response-nextToken"></a>
 The token to use to retrieve the next page of results.   
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_automation_ListAutomationEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListAutomationEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListAutomationEvents) 

# ListAutomationEventSteps
<a name="API_automation_ListAutomationEventSteps"></a>

Lists the steps for a specific automation event. You can only list steps for events created within the past year. 

## Request Syntax
<a name="API_automation_ListAutomationEventSteps_RequestSyntax"></a>

```
{
   "eventId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_automation_ListAutomationEventSteps_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [eventId](#API_automation_ListAutomationEventSteps_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSteps-request-eventId"></a>
 The ID of the automation event.   
Type: String  
Pattern: `[0-9A-Za-z]{16}`   
Required: Yes

 ** [maxResults](#API_automation_ListAutomationEventSteps_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSteps-request-maxResults"></a>
The maximum number of automation event steps to return in a single response. Valid range is 1-1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListAutomationEventSteps_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSteps-request-nextToken"></a>
A token used for pagination to retrieve the next set of results when the response is truncated.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_automation_ListAutomationEventSteps_ResponseSyntax"></a>

```
{
   "automationEventSteps": [ 
      { 
         "completedTimestamp": number,
         "estimatedMonthlySavings": { 
            "afterDiscountSavings": number,
            "beforeDiscountSavings": number,
            "currency": "string",
            "savingsEstimationMode": "string"
         },
         "eventId": "string",
         "resourceId": "string",
         "startTimestamp": number,
         "stepId": "string",
         "stepStatus": "string",
         "stepType": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_automation_ListAutomationEventSteps_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [automationEventSteps](#API_automation_ListAutomationEventSteps_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSteps-response-automationEventSteps"></a>
 The list of steps for the specified automation event.   
Type: Array of [AutomationEventStep](API_automation_AutomationEventStep.md) objects

 ** [nextToken](#API_automation_ListAutomationEventSteps_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSteps-response-nextToken"></a>
A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_automation_ListAutomationEventSteps_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListAutomationEventSteps_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListAutomationEventSteps) 

# ListAutomationEventSummaries
<a name="API_automation_ListAutomationEventSummaries"></a>

Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary. 

## Request Syntax
<a name="API_automation_ListAutomationEventSummaries_RequestSyntax"></a>

```
{
   "endDateExclusive": "string",
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "startDateInclusive": "string"
}
```

## Request Parameters
<a name="API_automation_ListAutomationEventSummaries_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endDateExclusive](#API_automation_ListAutomationEventSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSummaries-request-endDateExclusive"></a>
The end date for filtering automation event summaries, exclusive. Events created before this date will be included.  
Type: String  
Required: No

 ** [filters](#API_automation_ListAutomationEventSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSummaries-request-filters"></a>
 The filters to apply to the list of automation event summaries.   
Type: Array of [AutomationEventFilter](API_automation_AutomationEventFilter.md) objects  
Required: No

 ** [maxResults](#API_automation_ListAutomationEventSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSummaries-request-maxResults"></a>
The maximum number of automation event summaries to return in a single response. Valid range is 1-1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListAutomationEventSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSummaries-request-nextToken"></a>
A token used for pagination to retrieve the next set of results when the response is truncated.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

 ** [startDateInclusive](#API_automation_ListAutomationEventSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSummaries-request-startDateInclusive"></a>
The start date for filtering automation event summaries, inclusive. Events created on or after this date will be included.  
Type: String  
Required: No

## Response Syntax
<a name="API_automation_ListAutomationEventSummaries_ResponseSyntax"></a>

```
{
   "automationEventSummaries": [ 
      { 
         "dimensions": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "key": "string",
         "timePeriod": { 
            "endTimeExclusive": number,
            "startTimeInclusive": number
         },
         "total": { 
            "automationEventCount": number,
            "estimatedMonthlySavings": { 
               "afterDiscountSavings": number,
               "beforeDiscountSavings": number,
               "currency": "string",
               "savingsEstimationMode": "string"
            }
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_automation_ListAutomationEventSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [automationEventSummaries](#API_automation_ListAutomationEventSummaries_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSummaries-response-automationEventSummaries"></a>
 The list of automation event summaries that match the specified criteria.   
Type: Array of [AutomationEventSummary](API_automation_AutomationEventSummary.md) objects

 ** [nextToken](#API_automation_ListAutomationEventSummaries_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationEventSummaries-response-nextToken"></a>
A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_automation_ListAutomationEventSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListAutomationEventSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListAutomationEventSummaries) 

# ListAutomationRulePreview
<a name="API_automation_ListAutomationRulePreview"></a>

Returns a preview of the recommended actions that match your Automation rule's configuration and criteria. 

## Request Syntax
<a name="API_automation_ListAutomationRulePreview_RequestSyntax"></a>

```
{
   "criteria": { 
      "ebsVolumeSizeInGib": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "ebsVolumeType": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "estimatedMonthlySavings": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "lookBackPeriodInDays": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "region": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceArn": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceTag": [ 
         { 
            "comparison": "string",
            "key": "string",
            "values": [ "string" ]
         }
      ],
      "restartNeeded": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ]
   },
   "maxResults": number,
   "nextToken": "string",
   "organizationScope": { 
      "accountIds": [ "string" ]
   },
   "recommendedActionTypes": [ "string" ],
   "ruleType": "string"
}
```

## Request Parameters
<a name="API_automation_ListAutomationRulePreview_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [criteria](#API_automation_ListAutomationRulePreview_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-request-criteria"></a>
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.   
Type: [Criteria](API_automation_Criteria.md) object  
Required: No

 ** [maxResults](#API_automation_ListAutomationRulePreview_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-request-maxResults"></a>
The maximum number of automation rule preview results to return in a single response. Valid range is 1-1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListAutomationRulePreview_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-request-nextToken"></a>
A token used for pagination to retrieve the next set of results when the response is truncated.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

 ** [organizationScope](#API_automation_ListAutomationRulePreview_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-request-organizationScope"></a>
 The organizational scope for the rule preview.   
Type: [OrganizationScope](API_automation_OrganizationScope.md) object  
Required: No

 ** [recommendedActionTypes](#API_automation_ListAutomationRulePreview_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-request-recommendedActionTypes"></a>
 The types of recommended actions to include in the preview.   
Type: Array of strings  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType`   
Required: Yes

 ** [ruleType](#API_automation_ListAutomationRulePreview_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-request-ruleType"></a>
 The type of rule.   
Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.
Type: String  
Valid Values: `OrganizationRule | AccountRule`   
Required: Yes

## Response Syntax
<a name="API_automation_ListAutomationRulePreview_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "previewResults": [ 
      { 
         "accountId": "string",
         "currentResourceDetails": { ... },
         "currentResourceSummary": "string",
         "estimatedMonthlySavings": { 
            "afterDiscountSavings": number,
            "beforeDiscountSavings": number,
            "currency": "string",
            "savingsEstimationMode": "string"
         },
         "lookBackPeriodInDays": number,
         "recommendedActionId": "string",
         "recommendedActionType": "string",
         "recommendedResourceDetails": { ... },
         "recommendedResourceSummary": "string",
         "region": "string",
         "resourceArn": "string",
         "resourceId": "string",
         "resourceTags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "resourceType": "string",
         "restartNeeded": boolean
      }
   ]
}
```

## Response Elements
<a name="API_automation_ListAutomationRulePreview_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_automation_ListAutomationRulePreview_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-response-nextToken"></a>
A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [previewResults](#API_automation_ListAutomationRulePreview_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreview-response-previewResults"></a>
 The list of actions that would be taken based on the specified criteria.   
Type: Array of [PreviewResult](API_automation_PreviewResult.md) objects

## Errors
<a name="API_automation_ListAutomationRulePreview_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListAutomationRulePreview_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreview) 

# ListAutomationRulePreviewSummaries
<a name="API_automation_ListAutomationRulePreviewSummaries"></a>

Returns a summary of the recommended actions that match your rule preview configuration and criteria. 

## Request Syntax
<a name="API_automation_ListAutomationRulePreviewSummaries_RequestSyntax"></a>

```
{
   "criteria": { 
      "ebsVolumeSizeInGib": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "ebsVolumeType": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "estimatedMonthlySavings": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "lookBackPeriodInDays": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "region": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceArn": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceTag": [ 
         { 
            "comparison": "string",
            "key": "string",
            "values": [ "string" ]
         }
      ],
      "restartNeeded": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ]
   },
   "maxResults": number,
   "nextToken": "string",
   "organizationScope": { 
      "accountIds": [ "string" ]
   },
   "recommendedActionTypes": [ "string" ],
   "ruleType": "string"
}
```

## Request Parameters
<a name="API_automation_ListAutomationRulePreviewSummaries_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [criteria](#API_automation_ListAutomationRulePreviewSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-request-criteria"></a>
 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.   
Type: [Criteria](API_automation_Criteria.md) object  
Required: No

 ** [maxResults](#API_automation_ListAutomationRulePreviewSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-request-maxResults"></a>
The maximum number of automation rule preview summaries to return in a single response. Valid range is 1-1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListAutomationRulePreviewSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-request-nextToken"></a>
A token used for pagination to retrieve the next set of results when the response is truncated.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

 ** [organizationScope](#API_automation_ListAutomationRulePreviewSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-request-organizationScope"></a>
The organizational scope for the rule preview.  
Type: [OrganizationScope](API_automation_OrganizationScope.md) object  
Required: No

 ** [recommendedActionTypes](#API_automation_ListAutomationRulePreviewSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-request-recommendedActionTypes"></a>
The types of recommended actions to include in the preview.  
Type: Array of strings  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType`   
Required: Yes

 ** [ruleType](#API_automation_ListAutomationRulePreviewSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-request-ruleType"></a>
The type of rule.  
Type: String  
Valid Values: `OrganizationRule | AccountRule`   
Required: Yes

## Response Syntax
<a name="API_automation_ListAutomationRulePreviewSummaries_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "previewResultSummaries": [ 
      { 
         "key": "string",
         "total": { 
            "estimatedMonthlySavings": { 
               "afterDiscountSavings": number,
               "beforeDiscountSavings": number,
               "currency": "string",
               "savingsEstimationMode": "string"
            },
            "recommendedActionCount": number
         }
      }
   ]
}
```

## Response Elements
<a name="API_automation_ListAutomationRulePreviewSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_automation_ListAutomationRulePreviewSummaries_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-response-nextToken"></a>
A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [previewResultSummaries](#API_automation_ListAutomationRulePreviewSummaries_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationRulePreviewSummaries-response-previewResultSummaries"></a>
The list of automation rule preview summaries that match the specified criteria.  
Type: Array of [PreviewResultSummary](API_automation_PreviewResultSummary.md) objects

## Errors
<a name="API_automation_ListAutomationRulePreviewSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListAutomationRulePreviewSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListAutomationRulePreviewSummaries) 

# ListAutomationRules
<a name="API_automation_ListAutomationRules"></a>

 Lists the automation rules that match specified filters. 

## Request Syntax
<a name="API_automation_ListAutomationRules_RequestSyntax"></a>

```
{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_automation_ListAutomationRules_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filters](#API_automation_ListAutomationRules_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRules-request-filters"></a>
 The filters to apply to the list of automation rules.   
Type: Array of [Filter](API_automation_Filter.md) objects  
Required: No

 ** [maxResults](#API_automation_ListAutomationRules_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRules-request-maxResults"></a>
The maximum number of automation rules to return in a single response. Valid range is 1-1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListAutomationRules_RequestSyntax) **   <a name="computeoptimizer-automation_ListAutomationRules-request-nextToken"></a>
A token used for pagination to retrieve the next set of results when the response is truncated.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_automation_ListAutomationRules_ResponseSyntax"></a>

```
{
   "automationRules": [ 
      { 
         "accountId": "string",
         "createdTimestamp": number,
         "description": "string",
         "lastUpdatedTimestamp": number,
         "name": "string",
         "organizationConfiguration": { 
            "accountIds": [ "string" ],
            "ruleApplyOrder": "string"
         },
         "priority": "string",
         "recommendedActionTypes": [ "string" ],
         "ruleArn": "string",
         "ruleId": "string",
         "ruleRevision": number,
         "ruleType": "string",
         "schedule": { 
            "executionWindowInMinutes": number,
            "scheduleExpression": "string",
            "scheduleExpressionTimezone": "string"
         },
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_automation_ListAutomationRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [automationRules](#API_automation_ListAutomationRules_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationRules-response-automationRules"></a>
 The list of automation rules that match the specified criteria.   
Type: Array of [AutomationRule](API_automation_AutomationRule.md) objects

 ** [nextToken](#API_automation_ListAutomationRules_ResponseSyntax) **   <a name="computeoptimizer-automation_ListAutomationRules-response-nextToken"></a>
A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_automation_ListAutomationRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListAutomationRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListAutomationRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListAutomationRules) 

# ListRecommendedActions
<a name="API_automation_ListRecommendedActions"></a>

 Lists the recommended actions based that match specified filters. 

**Note**  
Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using `AssociateAccounts`.

## Request Syntax
<a name="API_automation_ListRecommendedActions_RequestSyntax"></a>

```
{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_automation_ListRecommendedActions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filters](#API_automation_ListRecommendedActions_RequestSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActions-request-filters"></a>
 The filters to apply to the list of recommended actions.   
Type: Array of [RecommendedActionFilter](API_automation_RecommendedActionFilter.md) objects  
Required: No

 ** [maxResults](#API_automation_ListRecommendedActions_RequestSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActions-request-maxResults"></a>
The maximum number of recommended actions to return in a single response. Valid range is 1-1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListRecommendedActions_RequestSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActions-request-nextToken"></a>
A token used for pagination to retrieve the next set of results when the response is truncated.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_automation_ListRecommendedActions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "recommendedActions": [ 
      { 
         "accountId": "string",
         "currentResourceDetails": { ... },
         "currentResourceSummary": "string",
         "estimatedMonthlySavings": { 
            "afterDiscountSavings": number,
            "beforeDiscountSavings": number,
            "currency": "string",
            "savingsEstimationMode": "string"
         },
         "lookBackPeriodInDays": number,
         "recommendedActionId": "string",
         "recommendedActionType": "string",
         "recommendedResourceDetails": { ... },
         "recommendedResourceSummary": "string",
         "region": "string",
         "resourceArn": "string",
         "resourceId": "string",
         "resourceTags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "resourceType": "string",
         "restartNeeded": boolean
      }
   ]
}
```

## Response Elements
<a name="API_automation_ListRecommendedActions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_automation_ListRecommendedActions_ResponseSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActions-response-nextToken"></a>
A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [recommendedActions](#API_automation_ListRecommendedActions_ResponseSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActions-response-recommendedActions"></a>
 The list of recommended actions that match the specified criteria.   
Type: Array of [RecommendedAction](API_automation_RecommendedAction.md) objects

## Errors
<a name="API_automation_ListRecommendedActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListRecommendedActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListRecommendedActions) 

# ListRecommendedActionSummaries
<a name="API_automation_ListRecommendedActionSummaries"></a>

 Provides a summary of recommended actions based on specified filters. 

**Note**  
Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using `AssociateAccounts`.

## Request Syntax
<a name="API_automation_ListRecommendedActionSummaries_RequestSyntax"></a>

```
{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_automation_ListRecommendedActionSummaries_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filters](#API_automation_ListRecommendedActionSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActionSummaries-request-filters"></a>
A list of filters to apply when retrieving recommended action summaries. Filters can be based on resource type, action type, account ID, and other criteria.  
Type: Array of [RecommendedActionFilter](API_automation_RecommendedActionFilter.md) objects  
Required: No

 ** [maxResults](#API_automation_ListRecommendedActionSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActionSummaries-request-maxResults"></a>
The maximum number of recommended action summaries to return in a single response. Valid range is 1-1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_automation_ListRecommendedActionSummaries_RequestSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActionSummaries-request-nextToken"></a>
A token used for pagination to retrieve the next set of results when the response is truncated.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

## Response Syntax
<a name="API_automation_ListRecommendedActionSummaries_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "recommendedActionSummaries": [ 
      { 
         "key": "string",
         "total": { 
            "estimatedMonthlySavings": { 
               "afterDiscountSavings": number,
               "beforeDiscountSavings": number,
               "currency": "string",
               "savingsEstimationMode": "string"
            },
            "recommendedActionCount": number
         }
      }
   ]
}
```

## Response Elements
<a name="API_automation_ListRecommendedActionSummaries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_automation_ListRecommendedActionSummaries_ResponseSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActionSummaries-response-nextToken"></a>
A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.  
Type: String  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [recommendedActionSummaries](#API_automation_ListRecommendedActionSummaries_ResponseSyntax) **   <a name="computeoptimizer-automation_ListRecommendedActionSummaries-response-recommendedActionSummaries"></a>
 The summary of recommended actions that match the specified criteria.   
Type: Array of [RecommendedActionSummary](API_automation_RecommendedActionSummary.md) objects

## Errors
<a name="API_automation_ListRecommendedActionSummaries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListRecommendedActionSummaries_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListRecommendedActionSummaries) 

# ListTagsForResource
<a name="API_automation_ListTagsForResource"></a>

 Lists the tags for a specified resource. 

## Request Syntax
<a name="API_automation_ListTagsForResource_RequestSyntax"></a>

```
{
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_automation_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_automation_ListTagsForResource_RequestSyntax) **   <a name="computeoptimizer-automation_ListTagsForResource-request-resourceArn"></a>
 The ARN of the resource to list tags for.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+`   
Required: Yes

## Response Syntax
<a name="API_automation_ListTagsForResource_ResponseSyntax"></a>

```
{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_automation_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_automation_ListTagsForResource_ResponseSyntax) **   <a name="computeoptimizer-automation_ListTagsForResource-response-tags"></a>
 The list of tags associated with the specified resource.   
Type: Array of [Tag](API_automation_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_automation_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/ListTagsForResource) 

# RollbackAutomationEvent
<a name="API_automation_RollbackAutomationEvent"></a>

 Initiates a rollback for a completed automation event. 

**Note**  
Management accounts and delegated administrators can only initiate a rollback for events belonging to associated member accounts. You can associate a member account using `AssociateAccounts`.

## Request Syntax
<a name="API_automation_RollbackAutomationEvent_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "eventId": "string"
}
```

## Request Parameters
<a name="API_automation_RollbackAutomationEvent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_RollbackAutomationEvent_RequestSyntax) **   <a name="computeoptimizer-automation_RollbackAutomationEvent-request-clientToken"></a>
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.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [eventId](#API_automation_RollbackAutomationEvent_RequestSyntax) **   <a name="computeoptimizer-automation_RollbackAutomationEvent-request-eventId"></a>
 The ID of the automation event to roll back.   
Type: String  
Pattern: `[0-9A-Za-z]{16}`   
Required: Yes

## Response Syntax
<a name="API_automation_RollbackAutomationEvent_ResponseSyntax"></a>

```
{
   "eventId": "string",
   "eventStatus": "string"
}
```

## Response Elements
<a name="API_automation_RollbackAutomationEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [eventId](#API_automation_RollbackAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_RollbackAutomationEvent-response-eventId"></a>
 The ID of the automation event being rolled back.   
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

 ** [eventStatus](#API_automation_RollbackAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_RollbackAutomationEvent-response-eventStatus"></a>
 The current status of the rollback operation.   
Type: String  
Valid Values: `Ready | InProgress | Complete | Failed | Cancelled | RollbackReady | RollbackInProgress | RollbackComplete | RollbackFailed` 

## Errors
<a name="API_automation_RollbackAutomationEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_RollbackAutomationEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/RollbackAutomationEvent) 

# StartAutomationEvent
<a name="API_automation_StartAutomationEvent"></a>

 Initiates a one-time, on-demand automation for the specified recommended action. 

**Note**  
Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using `AssociateAccounts`.

## Request Syntax
<a name="API_automation_StartAutomationEvent_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "recommendedActionId": "string"
}
```

## Request Parameters
<a name="API_automation_StartAutomationEvent_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_StartAutomationEvent_RequestSyntax) **   <a name="computeoptimizer-automation_StartAutomationEvent-request-clientToken"></a>
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.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [recommendedActionId](#API_automation_StartAutomationEvent_RequestSyntax) **   <a name="computeoptimizer-automation_StartAutomationEvent-request-recommendedActionId"></a>
 The ID of the recommended action to automate.   
Type: String  
Pattern: `[0-9A-Za-z]{16}`   
Required: Yes

## Response Syntax
<a name="API_automation_StartAutomationEvent_ResponseSyntax"></a>

```
{
   "eventId": "string",
   "eventStatus": "string",
   "recommendedActionId": "string"
}
```

## Response Elements
<a name="API_automation_StartAutomationEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [eventId](#API_automation_StartAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_StartAutomationEvent-response-eventId"></a>
The ID of the automation event.  
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

 ** [eventStatus](#API_automation_StartAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_StartAutomationEvent-response-eventStatus"></a>
The current status of the automation event.  
Type: String  
Valid Values: `Ready | InProgress | Complete | Failed | Cancelled | RollbackReady | RollbackInProgress | RollbackComplete | RollbackFailed` 

 ** [recommendedActionId](#API_automation_StartAutomationEvent_ResponseSyntax) **   <a name="computeoptimizer-automation_StartAutomationEvent-response-recommendedActionId"></a>
The ID of the recommended action being automated.  
Type: String  
Pattern: `[0-9A-Za-z]{16}` 

## Errors
<a name="API_automation_StartAutomationEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The request would exceed service quotas.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_StartAutomationEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/StartAutomationEvent) 

# TagResource
<a name="API_automation_TagResource"></a>

 Adds tags to the specified resource. 

## Request Syntax
<a name="API_automation_TagResource_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "resourceArn": "string",
   "ruleRevision": number,
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_automation_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_TagResource_RequestSyntax) **   <a name="computeoptimizer-automation_TagResource-request-clientToken"></a>
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.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [resourceArn](#API_automation_TagResource_RequestSyntax) **   <a name="computeoptimizer-automation_TagResource-request-resourceArn"></a>
 The ARN of the resource to tag.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+`   
Required: Yes

 ** [ruleRevision](#API_automation_TagResource_RequestSyntax) **   <a name="computeoptimizer-automation_TagResource-request-ruleRevision"></a>
The revision number of the automation rule to tag. This ensures you're tagging the correct version of the rule.  
Type: Long  
Required: Yes

 ** [tags](#API_automation_TagResource_RequestSyntax) **   <a name="computeoptimizer-automation_TagResource-request-tags"></a>
 The tags to add to the resource.   
Type: Array of [Tag](API_automation_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_automation_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_automation_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/TagResource) 

# UntagResource
<a name="API_automation_UntagResource"></a>

 Removes tags from the specified resource. 

## Request Syntax
<a name="API_automation_UntagResource_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "resourceArn": "string",
   "ruleRevision": number,
   "tagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_automation_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_UntagResource_RequestSyntax) **   <a name="computeoptimizer-automation_UntagResource-request-clientToken"></a>
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.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [resourceArn](#API_automation_UntagResource_RequestSyntax) **   <a name="computeoptimizer-automation_UntagResource-request-resourceArn"></a>
 The ARN of the resource to untag.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+`   
Required: Yes

 ** [ruleRevision](#API_automation_UntagResource_RequestSyntax) **   <a name="computeoptimizer-automation_UntagResource-request-ruleRevision"></a>
The revision number of the automation rule to untag. This ensures you're untagging the correct version of the rule.  
Type: Long  
Required: Yes

 ** [tagKeys](#API_automation_UntagResource_RequestSyntax) **   <a name="computeoptimizer-automation_UntagResource-request-tagKeys"></a>
 The keys of the tags to remove from the resource.   
Type: Array of strings  
Required: Yes

## Response Elements
<a name="API_automation_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_automation_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/UntagResource) 

# UpdateAutomationRule
<a name="API_automation_UpdateAutomationRule"></a>

 Updates an existing automation rule. 

## Request Syntax
<a name="API_automation_UpdateAutomationRule_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "criteria": { 
      "ebsVolumeSizeInGib": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "ebsVolumeType": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "estimatedMonthlySavings": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "lookBackPeriodInDays": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "region": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceArn": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceTag": [ 
         { 
            "comparison": "string",
            "key": "string",
            "values": [ "string" ]
         }
      ],
      "restartNeeded": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ]
   },
   "description": "string",
   "name": "string",
   "organizationConfiguration": { 
      "accountIds": [ "string" ],
      "ruleApplyOrder": "string"
   },
   "priority": "string",
   "recommendedActionTypes": [ "string" ],
   "ruleArn": "string",
   "ruleRevision": number,
   "ruleType": "string",
   "schedule": { 
      "executionWindowInMinutes": number,
      "scheduleExpression": "string",
      "scheduleExpressionTimezone": "string"
   },
   "status": "string"
}
```

## Request Parameters
<a name="API_automation_UpdateAutomationRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-clientToken"></a>
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.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [criteria](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-criteria"></a>
 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.   
Type: [Criteria](API_automation_Criteria.md) object  
Required: No

 ** [description](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-description"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9_\-\s@\.]*`   
Required: No

 ** [name](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-name"></a>
The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_-]*`   
Required: No

 ** [organizationConfiguration](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-organizationConfiguration"></a>
Updated configuration settings for organization-wide rules, including rule application order and target account IDs.  
Type: [OrganizationConfiguration](API_automation_OrganizationConfiguration.md) object  
Required: No

 ** [priority](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-priority"></a>
The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.  
Type: String  
Required: No

 ** [recommendedActionTypes](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-recommendedActionTypes"></a>
Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.  
Type: Array of strings  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType`   
Required: No

 ** [ruleArn](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-ruleArn"></a>
 The ARN of the rule to update.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+`   
Required: Yes

 ** [ruleRevision](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-ruleRevision"></a>
 The revision number of the rule to update.   
Type: Long  
Required: Yes

 ** [ruleType](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-ruleType"></a>
The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.  
Type: String  
Valid Values: `OrganizationRule | AccountRule`   
Required: No

 ** [schedule](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-schedule"></a>
The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.  
Type: [Schedule](API_automation_Schedule.md) object  
Required: No

 ** [status](#API_automation_UpdateAutomationRule_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-request-status"></a>
The updated status of the automation rule. Can be Active or Inactive.  
Type: String  
Valid Values: `Active | Inactive`   
Required: No

## Response Syntax
<a name="API_automation_UpdateAutomationRule_ResponseSyntax"></a>

```
{
   "createdTimestamp": number,
   "criteria": { 
      "ebsVolumeSizeInGib": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "ebsVolumeType": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "estimatedMonthlySavings": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "lookBackPeriodInDays": [ 
         { 
            "comparison": "string",
            "values": [ number ]
         }
      ],
      "region": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceArn": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ],
      "resourceTag": [ 
         { 
            "comparison": "string",
            "key": "string",
            "values": [ "string" ]
         }
      ],
      "restartNeeded": [ 
         { 
            "comparison": "string",
            "values": [ "string" ]
         }
      ]
   },
   "description": "string",
   "lastUpdatedTimestamp": number,
   "name": "string",
   "organizationConfiguration": { 
      "accountIds": [ "string" ],
      "ruleApplyOrder": "string"
   },
   "priority": "string",
   "recommendedActionTypes": [ "string" ],
   "ruleArn": "string",
   "ruleRevision": number,
   "ruleType": "string",
   "schedule": { 
      "executionWindowInMinutes": number,
      "scheduleExpression": "string",
      "scheduleExpressionTimezone": "string"
   },
   "status": "string"
}
```

## Response Elements
<a name="API_automation_UpdateAutomationRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdTimestamp](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-createdTimestamp"></a>
The timestamp when the automation rule was originally created.  
Type: Timestamp

 ** [criteria](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-criteria"></a>
 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.   
Type: [Criteria](API_automation_Criteria.md) object

 ** [description](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-description"></a>
The updated description of the automation rule.  
Type: String

 ** [lastUpdatedTimestamp](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-lastUpdatedTimestamp"></a>
The timestamp when the automation rule was last updated.  
Type: Timestamp

 ** [name](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-name"></a>
The updated name of the automation rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_-]*` 

 ** [organizationConfiguration](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-organizationConfiguration"></a>
The updated organization configuration settings.  
Type: [OrganizationConfiguration](API_automation_OrganizationConfiguration.md) object

 ** [priority](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-priority"></a>
The updated priority level of the automation rule.  
Type: String

 ** [recommendedActionTypes](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-recommendedActionTypes"></a>
The updated list of recommended action types.  
Type: Array of strings  
Valid Values: `SnapshotAndDeleteUnattachedEbsVolume | UpgradeEbsVolumeType` 

 ** [ruleArn](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-ruleArn"></a>
 The ARN of the updated rule.   
Type: String  
Pattern: `arn:aws:compute-optimizer::[0-9]{12}:automation-rule/[a-zA-Z0-9_-]+` 

 ** [ruleRevision](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-ruleRevision"></a>
 The new revision number of the updated rule.   
Type: Long

 ** [ruleType](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-ruleType"></a>
The updated type of automation rule.  
Type: String  
Valid Values: `OrganizationRule | AccountRule` 

 ** [schedule](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-schedule"></a>
The updated schedule configuration.  
Type: [Schedule](API_automation_Schedule.md) object

 ** [status](#API_automation_UpdateAutomationRule_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateAutomationRule-response-status"></a>
The updated status of the automation rule.  
Type: String  
Valid Values: `Active | Inactive` 

## Errors
<a name="API_automation_UpdateAutomationRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_UpdateAutomationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/UpdateAutomationRule) 

# UpdateEnrollmentConfiguration
<a name="API_automation_UpdateEnrollmentConfiguration"></a>

Updates your account’s Compute Optimizer Automation enrollment configuration. 

## Request Syntax
<a name="API_automation_UpdateEnrollmentConfiguration_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "status": "string"
}
```

## Request Parameters
<a name="API_automation_UpdateEnrollmentConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_automation_UpdateEnrollmentConfiguration_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateEnrollmentConfiguration-request-clientToken"></a>
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.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,64}`   
Required: No

 ** [status](#API_automation_UpdateEnrollmentConfiguration_RequestSyntax) **   <a name="computeoptimizer-automation_UpdateEnrollmentConfiguration-request-status"></a>
The desired enrollment status.   
+ Active - Enables the Automation feature for your account.
+ Inactive - Disables the Automation feature for your account and stops all of your automation rules. If you opt in again later, all rules will be inactive, and you must enable the rules you want to run. You must wait at least 24 hours after opting out to opt in again.
The `Pending` and `Failed` options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.  
If you are a member account, your account must be disassociated from your organization’s management account before you can disable Automation. Contact your administrator to make this change.
Type: String  
Valid Values: `Active | Inactive | Pending | Failed`   
Required: Yes

## Response Syntax
<a name="API_automation_UpdateEnrollmentConfiguration_ResponseSyntax"></a>

```
{
   "lastUpdatedTimestamp": number,
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_automation_UpdateEnrollmentConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [lastUpdatedTimestamp](#API_automation_UpdateEnrollmentConfiguration_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateEnrollmentConfiguration-response-lastUpdatedTimestamp"></a>
 The timestamp when the enrollment configuration was last updated.   
Type: Timestamp

 ** [status](#API_automation_UpdateEnrollmentConfiguration_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateEnrollmentConfiguration-response-status"></a>
 The updated enrollment status.   
Type: String  
Valid Values: `Active | Inactive | Pending | Failed` 

 ** [statusReason](#API_automation_UpdateEnrollmentConfiguration_ResponseSyntax) **   <a name="computeoptimizer-automation_UpdateEnrollmentConfiguration-response-statusReason"></a>
 The reason for the updated enrollment status.   
Type: String

## Errors
<a name="API_automation_UpdateEnrollmentConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
 You do not have sufficient permissions to perform this action.   
HTTP Status Code: 400

 ** ForbiddenException **   
 You are not authorized to perform this action.   
HTTP Status Code: 400

 ** IdempotencyTokenInUseException **   
 The specified client token is already in use.   
HTTP Status Code: 400

 ** IdempotentParameterMismatchException **   
Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.  
HTTP Status Code: 400

 ** InternalServerException **   
 An internal error occurred while processing the request.   
HTTP Status Code: 500

 ** InvalidParameterValueException **   
 One or more parameter values are not valid.   
HTTP Status Code: 400

 ** NotManagementAccountException **   
 The operation can only be performed by a management account.   
HTTP Status Code: 400

 ** OptInRequiredException **   
 The account must be opted in to Compute Optimizer Automation before performing this action.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
 The specified resource was not found.   
HTTP Status Code: 400

 ** ServiceUnavailableException **   
 The service is temporarily unavailable.   
HTTP Status Code: 500

 ** ThrottlingException **   
 The request was denied due to request throttling.   
HTTP Status Code: 400

## See Also
<a name="API_automation_UpdateEnrollmentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/compute-optimizer-automation-2025-09-22/UpdateEnrollmentConfiguration)