Class: Aws::ComputeOptimizerAutomation::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ComputeOptimizerAutomation::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb
Overview
An API client for ComputeOptimizerAutomation. To construct a client, you need to configure a :region and :credentials.
client = Aws::ComputeOptimizerAutomation::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_accounts(params = {}) ⇒ Types::AssociateAccountsResponse
Associates one or more member accounts with your organization's management account, enabling centralized implementation of optimization actions across those accounts.
-
#create_automation_rule(params = {}) ⇒ Types::CreateAutomationRuleResponse
Creates a new automation rule to apply recommended actions to resources based on specified criteria.
-
#delete_automation_rule(params = {}) ⇒ Struct
Deletes an existing automation rule.
-
#disassociate_accounts(params = {}) ⇒ Types::DisassociateAccountsResponse
Disassociates member accounts from your organization's management account, removing centralized automation capabilities.
-
#get_automation_event(params = {}) ⇒ Types::GetAutomationEventResponse
Retrieves details about a specific automation event.
-
#get_automation_rule(params = {}) ⇒ Types::GetAutomationRuleResponse
Retrieves details about a specific automation rule.
-
#get_enrollment_configuration(params = {}) ⇒ Types::GetEnrollmentConfigurationResponse
Retrieves the current enrollment configuration for Compute Optimizer Automation.
-
#list_accounts(params = {}) ⇒ Types::ListAccountsResponse
Lists the accounts in your organization that are enrolled in Compute Optimizer and whether they have enabled Automation.
-
#list_automation_event_steps(params = {}) ⇒ Types::ListAutomationEventStepsResponse
Lists the steps for a specific automation event.
-
#list_automation_event_summaries(params = {}) ⇒ Types::ListAutomationEventSummariesResponse
Provides a summary of automation events based on specified filters.
-
#list_automation_events(params = {}) ⇒ Types::ListAutomationEventsResponse
Lists automation events based on specified filters.
-
#list_automation_rule_preview(params = {}) ⇒ Types::ListAutomationRulePreviewResponse
Returns a preview of the recommended actions that match your Automation rule's configuration and criteria.
-
#list_automation_rule_preview_summaries(params = {}) ⇒ Types::ListAutomationRulePreviewSummariesResponse
Returns a summary of the recommended actions that match your rule preview configuration and criteria.
-
#list_automation_rules(params = {}) ⇒ Types::ListAutomationRulesResponse
Lists the automation rules that match specified filters.
-
#list_recommended_action_summaries(params = {}) ⇒ Types::ListRecommendedActionSummariesResponse
Provides a summary of recommended actions based on specified filters.
-
#list_recommended_actions(params = {}) ⇒ Types::ListRecommendedActionsResponse
Lists the recommended actions based that match specified filters.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a specified resource.
-
#rollback_automation_event(params = {}) ⇒ Types::RollbackAutomationEventResponse
Initiates a rollback for a completed automation event.
-
#start_automation_event(params = {}) ⇒ Types::StartAutomationEventResponse
Initiates a one-time, on-demand automation for the specified recommended action.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
-
#update_automation_rule(params = {}) ⇒ Types::UpdateAutomationRuleResponse
Updates an existing automation rule.
-
#update_enrollment_configuration(params = {}) ⇒ Types::UpdateEnrollmentConfigurationResponse
Updates your account’s Compute Optimizer Automation enrollment configuration.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#associate_accounts(params = {}) ⇒ Types::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.
542 543 544 545 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 542 def associate_accounts(params = {}, = {}) req = build_request(:associate_accounts, params) req.send_request() end |
#create_automation_rule(params = {}) ⇒ Types::CreateAutomationRuleResponse
Creates a new automation rule to apply recommended actions to resources based on specified criteria.
755 756 757 758 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 755 def create_automation_rule(params = {}, = {}) req = build_request(:create_automation_rule, params) req.send_request() end |
#delete_automation_rule(params = {}) ⇒ Struct
Deletes an existing automation rule.
788 789 790 791 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 788 def delete_automation_rule(params = {}, = {}) req = build_request(:delete_automation_rule, params) req.send_request() end |
#disassociate_accounts(params = {}) ⇒ Types::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.
836 837 838 839 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 836 def disassociate_accounts(params = {}, = {}) req = build_request(:disassociate_accounts, params) req.send_request() end |
#get_automation_event(params = {}) ⇒ Types::GetAutomationEventResponse
Retrieves details about a specific automation event.
895 896 897 898 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 895 def get_automation_event(params = {}, = {}) req = build_request(:get_automation_event, params) req.send_request() end |
#get_automation_rule(params = {}) ⇒ Types::GetAutomationRuleResponse
Retrieves details about a specific automation rule.
992 993 994 995 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 992 def get_automation_rule(params = {}, = {}) req = build_request(:get_automation_rule, params) req.send_request() end |
#get_enrollment_configuration(params = {}) ⇒ Types::GetEnrollmentConfigurationResponse
Retrieves the current enrollment configuration for Compute Optimizer Automation.
1018 1019 1020 1021 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1018 def get_enrollment_configuration(params = {}, = {}) req = build_request(:get_enrollment_configuration, params) req.send_request() end |
#list_accounts(params = {}) ⇒ Types::ListAccountsResponse
Lists the accounts in your organization that are enrolled in Compute Optimizer and whether they have enabled Automation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1065 def list_accounts(params = {}, = {}) req = build_request(:list_accounts, params) req.send_request() end |
#list_automation_event_steps(params = {}) ⇒ Types::ListAutomationEventStepsResponse
Lists the steps for a specific automation event. You can only list steps for events created within the past year.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1119 def list_automation_event_steps(params = {}, = {}) req = build_request(:list_automation_event_steps, params) req.send_request() end |
#list_automation_event_summaries(params = {}) ⇒ Types::ListAutomationEventSummariesResponse
Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1189 1190 1191 1192 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1189 def list_automation_event_summaries(params = {}, = {}) req = build_request(:list_automation_event_summaries, params) req.send_request() end |
#list_automation_events(params = {}) ⇒ Types::ListAutomationEventsResponse
Lists automation events based on specified filters. You can retrieve events that were created within the past year.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1261 1262 1263 1264 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1261 def list_automation_events(params = {}, = {}) req = build_request(:list_automation_events, params) req.send_request() end |
#list_automation_rule_preview(params = {}) ⇒ Types::ListAutomationRulePreviewResponse
Returns a preview of the recommended actions that match your Automation rule's configuration and criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1402 1403 1404 1405 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1402 def list_automation_rule_preview(params = {}, = {}) req = build_request(:list_automation_rule_preview, params) req.send_request() end |
#list_automation_rule_preview_summaries(params = {}) ⇒ Types::ListAutomationRulePreviewSummariesResponse
Returns a summary of the recommended actions that match your rule preview configuration and criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1519 1520 1521 1522 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1519 def list_automation_rule_preview_summaries(params = {}, = {}) req = build_request(:list_automation_rule_preview_summaries, params) req.send_request() end |
#list_automation_rules(params = {}) ⇒ Types::ListAutomationRulesResponse
Lists the automation rules that match specified filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1585 1586 1587 1588 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1585 def list_automation_rules(params = {}, = {}) req = build_request(:list_automation_rules, params) req.send_request() end |
#list_recommended_action_summaries(params = {}) ⇒ Types::ListRecommendedActionSummariesResponse
Provides a summary of recommended actions based on specified filters.
AssociateAccounts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1646 1647 1648 1649 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1646 def list_recommended_action_summaries(params = {}, = {}) req = build_request(:list_recommended_action_summaries, params) req.send_request() end |
#list_recommended_actions(params = {}) ⇒ Types::ListRecommendedActionsResponse
Lists the recommended actions based that match specified filters.
AssociateAccounts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1725 1726 1727 1728 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1725 def list_recommended_actions(params = {}, = {}) req = build_request(:list_recommended_actions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for a specified resource.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1755 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#rollback_automation_event(params = {}) ⇒ Types::RollbackAutomationEventResponse
Initiates a rollback for a completed automation event.
AssociateAccounts.
1800 1801 1802 1803 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1800 def rollback_automation_event(params = {}, = {}) req = build_request(:rollback_automation_event, params) req.send_request() end |
#start_automation_event(params = {}) ⇒ Types::StartAutomationEventResponse
Initiates a one-time, on-demand automation for the specified recommended action.
AssociateAccounts.
1848 1849 1850 1851 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1848 def start_automation_event(params = {}, = {}) req = build_request(:start_automation_event, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1893 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
1933 1934 1935 1936 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 1933 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_automation_rule(params = {}) ⇒ Types::UpdateAutomationRuleResponse
Updates an existing automation rule.
2140 2141 2142 2143 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 2140 def update_automation_rule(params = {}, = {}) req = build_request(:update_automation_rule, params) req.send_request() end |
#update_enrollment_configuration(params = {}) ⇒ Types::UpdateEnrollmentConfigurationResponse
Updates your account’s Compute Optimizer Automation enrollment configuration.
2200 2201 2202 2203 |
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/client.rb', line 2200 def update_enrollment_configuration(params = {}, = {}) req = build_request(:update_enrollment_configuration, params) req.send_request() end |