Class: Aws::FIS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::FIS::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb
Overview
An API client for FIS. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::FIS::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
-
#create_experiment_template(params = {}) ⇒ Types::CreateExperimentTemplateResponse
Creates an experiment template.
-
#create_target_account_configuration(params = {}) ⇒ Types::CreateTargetAccountConfigurationResponse
Creates a target account configuration for the experiment template.
-
#delete_experiment_template(params = {}) ⇒ Types::DeleteExperimentTemplateResponse
Deletes the specified experiment template.
-
#delete_target_account_configuration(params = {}) ⇒ Types::DeleteTargetAccountConfigurationResponse
Deletes the specified target account configuration of the experiment template.
-
#get_action(params = {}) ⇒ Types::GetActionResponse
Gets information about the specified FIS action.
-
#get_experiment(params = {}) ⇒ Types::GetExperimentResponse
Gets information about the specified experiment.
-
#get_experiment_target_account_configuration(params = {}) ⇒ Types::GetExperimentTargetAccountConfigurationResponse
Gets information about the specified target account configuration of the experiment.
-
#get_experiment_template(params = {}) ⇒ Types::GetExperimentTemplateResponse
Gets information about the specified experiment template.
-
#get_target_account_configuration(params = {}) ⇒ Types::GetTargetAccountConfigurationResponse
Gets information about the specified target account configuration of the experiment template.
-
#get_target_resource_type(params = {}) ⇒ Types::GetTargetResourceTypeResponse
Gets information about the specified resource type.
-
#list_actions(params = {}) ⇒ Types::ListActionsResponse
Lists the available FIS actions.
-
#list_experiment_resolved_targets(params = {}) ⇒ Types::ListExperimentResolvedTargetsResponse
Lists the resolved targets information of the specified experiment.
-
#list_experiment_target_account_configurations(params = {}) ⇒ Types::ListExperimentTargetAccountConfigurationsResponse
Lists the target account configurations of the specified experiment.
-
#list_experiment_templates(params = {}) ⇒ Types::ListExperimentTemplatesResponse
Lists your experiment templates.
-
#list_experiments(params = {}) ⇒ Types::ListExperimentsResponse
Lists your experiments.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#list_target_account_configurations(params = {}) ⇒ Types::ListTargetAccountConfigurationsResponse
Lists the target account configurations of the specified experiment template.
-
#list_target_resource_types(params = {}) ⇒ Types::ListTargetResourceTypesResponse
Lists the target resource types.
-
#start_experiment(params = {}) ⇒ Types::StartExperimentResponse
Starts running an experiment from the specified experiment template.
-
#stop_experiment(params = {}) ⇒ Types::StopExperimentResponse
Stops the specified experiment.
-
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_experiment_template(params = {}) ⇒ Types::UpdateExperimentTemplateResponse
Updates the specified experiment template.
-
#update_target_account_configuration(params = {}) ⇒ Types::UpdateTargetAccountConfigurationResponse
Updates the target account configuration for the specified experiment template.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from 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.
422 423 424 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#create_experiment_template(params = {}) ⇒ Types::CreateExperimentTemplateResponse
Creates an experiment template.
An experiment template includes the following components:
Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.
Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.
Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.
For more information, see experiment templates in the Fault Injection Service User Guide.
597 598 599 600 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 597 def create_experiment_template(params = {}, = {}) req = build_request(:create_experiment_template, params) req.send_request() end |
#create_target_account_configuration(params = {}) ⇒ Types::CreateTargetAccountConfigurationResponse
Creates a target account configuration for the experiment template. A
target account configuration is required when accountTargeting
of
experimentOptions
is set to multi-account
. For more information,
see experiment options in the Fault Injection Service User
Guide.
655 656 657 658 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 655 def create_target_account_configuration(params = {}, = {}) req = build_request(:create_target_account_configuration, params) req.send_request() end |
#delete_experiment_template(params = {}) ⇒ Types::DeleteExperimentTemplateResponse
Deletes the specified experiment template.
722 723 724 725 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 722 def delete_experiment_template(params = {}, = {}) req = build_request(:delete_experiment_template, params) req.send_request() end |
#delete_target_account_configuration(params = {}) ⇒ Types::DeleteTargetAccountConfigurationResponse
Deletes the specified target account configuration of the experiment template.
757 758 759 760 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 757 def delete_target_account_configuration(params = {}, = {}) req = build_request(:delete_target_account_configuration, params) req.send_request() end |
#get_action(params = {}) ⇒ Types::GetActionResponse
Gets information about the specified FIS action.
794 795 796 797 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 794 def get_action(params = {}, = {}) req = build_request(:get_action, params) req.send_request() end |
#get_experiment(params = {}) ⇒ Types::GetExperimentResponse
Gets information about the specified experiment.
872 873 874 875 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 872 def get_experiment(params = {}, = {}) req = build_request(:get_experiment, params) req.send_request() end |
#get_experiment_target_account_configuration(params = {}) ⇒ Types::GetExperimentTargetAccountConfigurationResponse
Gets information about the specified target account configuration of the experiment.
907 908 909 910 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 907 def get_experiment_target_account_configuration(params = {}, = {}) req = build_request(:get_experiment_target_account_configuration, params) req.send_request() end |
#get_experiment_template(params = {}) ⇒ Types::GetExperimentTemplateResponse
Gets information about the specified experiment template.
974 975 976 977 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 974 def get_experiment_template(params = {}, = {}) req = build_request(:get_experiment_template, params) req.send_request() end |
#get_target_account_configuration(params = {}) ⇒ Types::GetTargetAccountConfigurationResponse
Gets information about the specified target account configuration of the experiment template.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1009 def get_target_account_configuration(params = {}, = {}) req = build_request(:get_target_account_configuration, params) req.send_request() end |
#get_target_resource_type(params = {}) ⇒ Types::GetTargetResourceTypeResponse
Gets information about the specified resource type.
1041 1042 1043 1044 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1041 def get_target_resource_type(params = {}, = {}) req = build_request(:get_target_resource_type, params) req.send_request() end |
#list_actions(params = {}) ⇒ Types::ListActionsResponse
Lists the available FIS actions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1086 1087 1088 1089 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1086 def list_actions(params = {}, = {}) req = build_request(:list_actions, params) req.send_request() end |
#list_experiment_resolved_targets(params = {}) ⇒ Types::ListExperimentResolvedTargetsResponse
Lists the resolved targets information of the specified experiment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1136 1137 1138 1139 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1136 def list_experiment_resolved_targets(params = {}, = {}) req = build_request(:list_experiment_resolved_targets, params) req.send_request() end |
#list_experiment_target_account_configurations(params = {}) ⇒ Types::ListExperimentTargetAccountConfigurationsResponse
Lists the target account configurations of the specified experiment.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1173 def list_experiment_target_account_configurations(params = {}, = {}) req = build_request(:list_experiment_target_account_configurations, params) req.send_request() end |
#list_experiment_templates(params = {}) ⇒ Types::ListExperimentTemplatesResponse
Lists your experiment templates.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1218 1219 1220 1221 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1218 def list_experiment_templates(params = {}, = {}) req = build_request(:list_experiment_templates, params) req.send_request() end |
#list_experiments(params = {}) ⇒ Types::ListExperimentsResponse
Lists your experiments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1274 1275 1276 1277 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1274 def list_experiments(params = {}, = {}) req = build_request(:list_experiments, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1303 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_target_account_configurations(params = {}) ⇒ Types::ListTargetAccountConfigurationsResponse
Lists the target account configurations of the specified experiment template.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1349 def list_target_account_configurations(params = {}, = {}) req = build_request(:list_target_account_configurations, params) req.send_request() end |
#list_target_resource_types(params = {}) ⇒ Types::ListTargetResourceTypesResponse
Lists the target resource types.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1389 def list_target_resource_types(params = {}, = {}) req = build_request(:list_target_resource_types, params) req.send_request() end |
#start_experiment(params = {}) ⇒ Types::StartExperimentResponse
Starts running an experiment from the specified experiment template.
1487 1488 1489 1490 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1487 def start_experiment(params = {}, = {}) req = build_request(:start_experiment, params) req.send_request() end |
#stop_experiment(params = {}) ⇒ Types::StopExperimentResponse
Stops the specified experiment.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1565 def stop_experiment(params = {}, = {}) req = build_request(:stop_experiment, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Applies the specified tags to the specified resource.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1593 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
1619 1620 1621 1622 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1619 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_experiment_template(params = {}) ⇒ Types::UpdateExperimentTemplateResponse
Updates the specified experiment template.
1761 1762 1763 1764 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1761 def update_experiment_template(params = {}, = {}) req = build_request(:update_experiment_template, params) req.send_request() end |
#update_target_account_configuration(params = {}) ⇒ Types::UpdateTargetAccountConfigurationResponse
Updates the target account configuration for the specified experiment template.
1804 1805 1806 1807 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1804 def update_target_account_configuration(params = {}, = {}) req = build_request(:update_target_account_configuration, params) req.send_request() end |