View Source AWS.ComputeOptimizerAutomation (aws-elixir v1.0.11)

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.

Link to this section Summary

Functions

Associates one or more member accounts with your organization's management account, enabling centralized implementation of optimization actions across those accounts.

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

Deletes an existing automation rule.

Disassociates member accounts from your organization's management account, removing centralized automation capabilities.

Retrieves details about a specific automation event.

Retrieves details about a specific automation rule.

Retrieves the current enrollment configuration for Compute Optimizer Automation.

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

Lists the steps for a specific automation event.

Provides a summary of automation events based on specified filters.

Lists automation events based on specified filters.

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

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

Lists the automation rules that match specified filters.

Provides a summary of recommended actions based on specified filters.

Lists the recommended actions based that match specified filters.

Lists the tags for a specified resource.

Initiates a rollback for a completed automation event.

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

Adds tags to the specified resource.

Removes tags from the specified resource.

Updates an existing automation rule.

Updates your account’s Compute Optimizer Automation enrollment configuration.

Link to this section Functions

Link to this function

associate_accounts(client, input, options \\ [])

View Source

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.

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

Link to this function

create_automation_rule(client, input, options \\ [])

View Source

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

Link to this function

delete_automation_rule(client, input, options \\ [])

View Source

Deletes an existing automation rule.

Link to this function

disassociate_accounts(client, input, options \\ [])

View Source

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.

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

Link to this function

get_automation_event(client, input, options \\ [])

View Source

Retrieves details about a specific automation event.

Link to this function

get_automation_rule(client, input, options \\ [])

View Source

Retrieves details about a specific automation rule.

Link to this function

get_enrollment_configuration(client, input, options \\ [])

View Source

Retrieves the current enrollment configuration for Compute Optimizer Automation.

Link to this function

list_accounts(client, input, options \\ [])

View Source

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

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

Link to this function

list_automation_event_steps(client, input, options \\ [])

View Source

Lists the steps for a specific automation event.

You can only list steps for events created within the past year.

Link to this function

list_automation_event_summaries(client, input, options \\ [])

View Source

Provides a summary of automation events based on specified filters.

Only events created within the past year will be included in the summary.

Link to this function

list_automation_events(client, input, options \\ [])

View Source

Lists automation events based on specified filters.

You can retrieve events that were created within the past year.

Link to this function

list_automation_rule_preview(client, input, options \\ [])

View Source

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

Link to this function

list_automation_rule_preview_summaries(client, input, options \\ [])

View Source

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

Link to this function

list_automation_rules(client, input, options \\ [])

View Source

Lists the automation rules that match specified filters.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags for a specified resource.

Link to this function

rollback_automation_event(client, input, options \\ [])

View Source

Initiates a rollback for a completed automation event.

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.

Link to this function

start_automation_event(client, input, options \\ [])

View Source

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

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

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds tags to the specified resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from the specified resource.

Link to this function

update_automation_rule(client, input, options \\ [])

View Source

Updates an existing automation rule.

Link to this function

update_enrollment_configuration(client, input, options \\ [])

View Source

Updates your account’s Compute Optimizer Automation enrollment configuration.