ComputeOptimizerAutomation class

Automation is a feature within Amazon Web Services Compute Optimizer that enables you to apply optimization recommendations to your Amazon Web Services resources, reducing costs and improving performance. You can apply recommended actions directly or create automation rules that implement recommendations on a recurring schedule when they match your specified criteria. With automation rules, set criteria such as Amazon Web Services Region and Resource Tags to target specific geographies and workloads. Configure rules to run daily, weekly, or monthly, and Compute Optimizer continuously evaluates new recommendations against your criteria. Track automation events over time, examine detailed step history, estimate savings achieved, and reverse actions directly from Compute Optimizer when needed.

Constructors

ComputeOptimizerAutomation({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

associateAccounts({required List<String> accountIds, String? clientToken}) → Future<AssociateAccountsResponse>

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.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

createAutomationRule({required String name, required List<RecommendedActionType> recommendedActionTypes, required RuleType ruleType, required Schedule schedule, required RuleStatus status, String? clientToken, Criteria? criteria, String? description, OrganizationConfiguration? organizationConfiguration, String? priority, List<Tag>? tags}) → Future<CreateAutomationRuleResponse>

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

deleteAutomationRule({required String ruleArn, required int ruleRevision, String? clientToken}) → Future<void>

Deletes an existing automation rule.

disassociateAccounts({required List<String> accountIds, String? clientToken}) → Future<DisassociateAccountsResponse>

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.

getAutomationEvent({required String eventId}) → Future<GetAutomationEventResponse>

Retrieves details about a specific automation event.

getAutomationRule({required String ruleArn}) → Future<GetAutomationRuleResponse>

Retrieves details about a specific automation rule.

getEnrollmentConfiguration() → Future<GetEnrollmentConfigurationResponse>

Retrieves the current enrollment configuration for Compute Optimizer Automation.

listAccounts({int? maxResults, String? nextToken}) → Future<ListAccountsResponse>

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

listAutomationEvents({DateTime? endTimeExclusive, List<AutomationEventFilter>? filters, int? maxResults, String? nextToken, DateTime? startTimeInclusive}) → Future<ListAutomationEventsResponse>

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

listAutomationEventSteps({required String eventId, int? maxResults, String? nextToken}) → Future<ListAutomationEventStepsResponse>

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

listAutomationEventSummaries({String? endDateExclusive, List<AutomationEventFilter>? filters, int? maxResults, String? nextToken, String? startDateInclusive}) → Future<ListAutomationEventSummariesResponse>

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

listAutomationRulePreview({required List<RecommendedActionType> recommendedActionTypes, required RuleType ruleType, Criteria? criteria, int? maxResults, String? nextToken, OrganizationScope? organizationScope}) → Future<ListAutomationRulePreviewResponse>

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

listAutomationRulePreviewSummaries({required List<RecommendedActionType> recommendedActionTypes, required RuleType ruleType, Criteria? criteria, int? maxResults, String? nextToken, OrganizationScope? organizationScope}) → Future<ListAutomationRulePreviewSummariesResponse>

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

listAutomationRules({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListAutomationRulesResponse>

Lists the automation rules that match specified filters.

listRecommendedActions({List<RecommendedActionFilter>? filters, int? maxResults, String? nextToken}) → Future<ListRecommendedActionsResponse>

Lists the recommended actions based that match specified filters.

listRecommendedActionSummaries({List<RecommendedActionFilter>? filters, int? maxResults, String? nextToken}) → Future<ListRecommendedActionSummariesResponse>

Provides a summary of recommended actions based on specified filters.

listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>

Lists the tags for a specified resource.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rollbackAutomationEvent({required String eventId, String? clientToken}) → Future<RollbackAutomationEventResponse>

Initiates a rollback for a completed automation event.

startAutomationEvent({required String recommendedActionId, String? clientToken}) → Future<StartAutomationEventResponse>

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

tagResource({required String resourceArn, required int ruleRevision, required List<Tag> tags, String? clientToken}) → Future<void>

Adds tags to the specified resource.

toString() → String

A string representation of this object.

inherited

untagResource({required String resourceArn, required int ruleRevision, required List<String> tagKeys, String? clientToken}) → Future<void>

Removes tags from the specified resource.

updateAutomationRule({required String ruleArn, required int ruleRevision, String? clientToken, Criteria? criteria, String? description, String? name, OrganizationConfiguration? organizationConfiguration, String? priority, List<RecommendedActionType>? recommendedActionTypes, RuleType? ruleType, Schedule? schedule, RuleStatus? status}) → Future<UpdateAutomationRuleResponse>

Updates an existing automation rule.

updateEnrollmentConfiguration({required EnrollmentStatus status, String? clientToken}) → Future<UpdateEnrollmentConfigurationResponse>

Updates your account’s Compute Optimizer Automation enrollment configuration.

Operators

operator ==(Object other) → bool

The equality operator.

inherited