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.
-
#delete_experiment_template(params = {}) ⇒ Types::DeleteExperimentTemplateResponse
Deletes the specified 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_template(params = {}) ⇒ Types::GetExperimentTemplateResponse
Gets information about the specified 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_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_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.
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.
365 366 367 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 365 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 Simulator User Guide.
529 530 531 532 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 529 def create_experiment_template(params = {}, = {}) req = build_request(:create_experiment_template, params) req.send_request() end |
#delete_experiment_template(params = {}) ⇒ Types::DeleteExperimentTemplateResponse
Deletes the specified experiment template.
592 593 594 595 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 592 def delete_experiment_template(params = {}, = {}) req = build_request(:delete_experiment_template, params) req.send_request() end |
#get_action(params = {}) ⇒ Types::GetActionResponse
Gets information about the specified FIS action.
628 629 630 631 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 628 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.
698 699 700 701 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 698 def get_experiment(params = {}, = {}) req = build_request(:get_experiment, params) req.send_request() end |
#get_experiment_template(params = {}) ⇒ Types::GetExperimentTemplateResponse
Gets information about the specified experiment template.
761 762 763 764 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 761 def get_experiment_template(params = {}, = {}) req = build_request(:get_experiment_template, params) req.send_request() end |
#get_target_resource_type(params = {}) ⇒ Types::GetTargetResourceTypeResponse
Gets information about the specified resource type.
793 794 795 796 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 793 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.
837 838 839 840 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 837 def list_actions(params = {}, = {}) req = build_request(:list_actions, 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.
881 882 883 884 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 881 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.
926 927 928 929 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 926 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.
955 956 957 958 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 955 def (params = {}, = {}) req = build_request(:list_tags_for_resource, 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.
995 996 997 998 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 995 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1079 def start_experiment(params = {}, = {}) req = build_request(:start_experiment, params) req.send_request() end |
#stop_experiment(params = {}) ⇒ Types::StopExperimentResponse
Stops the specified experiment.
1149 1150 1151 1152 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1149 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.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1177 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.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1203 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.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1335 def update_experiment_template(params = {}, = {}) req = build_request(:update_experiment_template, params) req.send_request() end |