class Aws::FIS::Client
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-fis/client.rb, line 1177 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-fis/client.rb, line 324 def initialize(*args) super end
Public Instance Methods
@param params ({}) @api private
# File lib/aws-sdk-fis/client.rb, line 1152 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-fis' context[:gem_version] = '1.4.0' Seahorse::Client::Request.new(handlers, context) end
Creates an experiment template.
To create a template, specify the following information:
-
Targets: A target can be a specific resource in your AWS 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 the [AWS Fault Injection Simulator User Guide].
[1]: docs.aws.amazon.com/fis/latest/userguide/
@option params [required, String] :client_token
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. **A suitable default value is auto-generated.** You should normally not need to pass this option.**
@option params [required, String] :description
A description for the experiment template. Can contain up to 64 letters (A-Z and a-z).
@option params [required, Array<Types::CreateExperimentTemplateStopConditionInput>] :stop_conditions
The stop conditions.
@option params [Hash<String,Types::CreateExperimentTemplateTargetInput>] :targets
The targets for the experiment.
@option params [required, Hash<String,Types::CreateExperimentTemplateActionInput>] :actions
The actions for the experiment.
@option params [required, String] :role_arn
The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
@option params [Hash<String,String>] :tags
The tags to apply to the experiment template.
@return [Types::CreateExperimentTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateExperimentTemplateResponse#experiment_template #experiment_template} => Types::ExperimentTemplate
@example Request syntax with placeholder values
resp = client.create_experiment_template({ client_token: "ClientToken", # required description: "ExperimentTemplateDescription", # required stop_conditions: [ # required { source: "StopConditionSource", # required value: "StopConditionValue", }, ], targets: { "ExperimentTemplateTargetName" => { resource_type: "ResourceType", # required resource_arns: ["ResourceArn"], resource_tags: { "TagKey" => "TagValue", }, filters: [ { path: "ExperimentTemplateTargetFilterPath", # required values: ["ExperimentTemplateTargetFilterValue"], # required }, ], selection_mode: "ExperimentTemplateTargetSelectionMode", # required }, }, actions: { # required "ExperimentTemplateActionName" => { action_id: "ActionId", # required description: "ExperimentTemplateActionDescription", parameters: { "ExperimentTemplateActionParameterName" => "ExperimentTemplateActionParameter", }, targets: { "ExperimentTemplateActionTargetName" => "ExperimentTemplateTargetName", }, start_after: ["ExperimentTemplateActionStartAfter"], }, }, role_arn: "RoleArn", # required tags: { "TagKey" => "TagValue", }, })
@example Response structure
resp.experiment_template.id #=> String resp.experiment_template.description #=> String resp.experiment_template.targets #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_type #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags["TagKey"] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].path #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].selection_mode #=> String resp.experiment_template.actions #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].action_id #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].description #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].parameters #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].parameters["ExperimentTemplateActionParameterName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].targets #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].targets["ExperimentTemplateActionTargetName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].start_after #=> Array resp.experiment_template.actions["ExperimentTemplateActionName"].start_after[0] #=> String resp.experiment_template.stop_conditions #=> Array resp.experiment_template.stop_conditions[0].source #=> String resp.experiment_template.stop_conditions[0].value #=> String resp.experiment_template.creation_time #=> Time resp.experiment_template.last_update_time #=> Time resp.experiment_template.role_arn #=> String resp.experiment_template.tags #=> Hash resp.experiment_template.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/CreateExperimentTemplate AWS API Documentation
@overload create_experiment_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 467 def create_experiment_template(params = {}, options = {}) req = build_request(:create_experiment_template, params) req.send_request(options) end
Deletes the specified experiment template.
@option params [required, String] :id
The ID of the experiment template.
@return [Types::DeleteExperimentTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DeleteExperimentTemplateResponse#experiment_template #experiment_template} => Types::ExperimentTemplate
@example Request syntax with placeholder values
resp = client.delete_experiment_template({ id: "ExperimentTemplateId", # required })
@example Response structure
resp.experiment_template.id #=> String resp.experiment_template.description #=> String resp.experiment_template.targets #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_type #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags["TagKey"] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].path #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].selection_mode #=> String resp.experiment_template.actions #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].action_id #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].description #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].parameters #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].parameters["ExperimentTemplateActionParameterName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].targets #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].targets["ExperimentTemplateActionTargetName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].start_after #=> Array resp.experiment_template.actions["ExperimentTemplateActionName"].start_after[0] #=> String resp.experiment_template.stop_conditions #=> Array resp.experiment_template.stop_conditions[0].source #=> String resp.experiment_template.stop_conditions[0].value #=> String resp.experiment_template.creation_time #=> Time resp.experiment_template.last_update_time #=> Time resp.experiment_template.role_arn #=> String resp.experiment_template.tags #=> Hash resp.experiment_template.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/DeleteExperimentTemplate AWS API Documentation
@overload delete_experiment_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 524 def delete_experiment_template(params = {}, options = {}) req = build_request(:delete_experiment_template, params) req.send_request(options) end
Gets information about the specified AWS FIS
action.
@option params [required, String] :id
The ID of the action.
@return [Types::GetActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetActionResponse#action #action} => Types::Action
@example Request syntax with placeholder values
resp = client.get_action({ id: "ActionId", # required })
@example Response structure
resp.action.id #=> String resp.action.description #=> String resp.action.parameters #=> Hash resp.action.parameters["ActionParameterName"].description #=> String resp.action.parameters["ActionParameterName"].required #=> Boolean resp.action.targets #=> Hash resp.action.targets["ActionTargetName"].resource_type #=> String resp.action.tags #=> Hash resp.action.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/GetAction AWS API Documentation
@overload get_action
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 560 def get_action(params = {}, options = {}) req = build_request(:get_action, params) req.send_request(options) end
Gets information about the specified experiment.
@option params [required, String] :id
The ID of the experiment.
@return [Types::GetExperimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetExperimentResponse#experiment #experiment} => Types::Experiment
@example Request syntax with placeholder values
resp = client.get_experiment({ id: "ExperimentId", # required })
@example Response structure
resp.experiment.id #=> String resp.experiment.experiment_template_id #=> String resp.experiment.role_arn #=> String resp.experiment.state.status #=> String, one of "pending", "initiating", "running", "completed", "stopping", "stopped", "failed" resp.experiment.state.reason #=> String resp.experiment.targets #=> Hash resp.experiment.targets["ExperimentTargetName"].resource_type #=> String resp.experiment.targets["ExperimentTargetName"].resource_arns #=> Array resp.experiment.targets["ExperimentTargetName"].resource_arns[0] #=> String resp.experiment.targets["ExperimentTargetName"].resource_tags #=> Hash resp.experiment.targets["ExperimentTargetName"].resource_tags["TagKey"] #=> String resp.experiment.targets["ExperimentTargetName"].filters #=> Array resp.experiment.targets["ExperimentTargetName"].filters[0].path #=> String resp.experiment.targets["ExperimentTargetName"].filters[0].values #=> Array resp.experiment.targets["ExperimentTargetName"].filters[0].values[0] #=> String resp.experiment.targets["ExperimentTargetName"].selection_mode #=> String resp.experiment.actions #=> Hash resp.experiment.actions["ExperimentActionName"].action_id #=> String resp.experiment.actions["ExperimentActionName"].description #=> String resp.experiment.actions["ExperimentActionName"].parameters #=> Hash resp.experiment.actions["ExperimentActionName"].parameters["ExperimentActionParameterName"] #=> String resp.experiment.actions["ExperimentActionName"].targets #=> Hash resp.experiment.actions["ExperimentActionName"].targets["ExperimentActionTargetName"] #=> String resp.experiment.actions["ExperimentActionName"].start_after #=> Array resp.experiment.actions["ExperimentActionName"].start_after[0] #=> String resp.experiment.actions["ExperimentActionName"].state.status #=> String, one of "pending", "initiating", "running", "completed", "cancelled", "stopping", "stopped", "failed" resp.experiment.actions["ExperimentActionName"].state.reason #=> String resp.experiment.stop_conditions #=> Array resp.experiment.stop_conditions[0].source #=> String resp.experiment.stop_conditions[0].value #=> String resp.experiment.creation_time #=> Time resp.experiment.start_time #=> Time resp.experiment.end_time #=> Time resp.experiment.tags #=> Hash resp.experiment.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/GetExperiment AWS API Documentation
@overload get_experiment
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 622 def get_experiment(params = {}, options = {}) req = build_request(:get_experiment, params) req.send_request(options) end
Gets information about the specified experiment template.
@option params [required, String] :id
The ID of the experiment template.
@return [Types::GetExperimentTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetExperimentTemplateResponse#experiment_template #experiment_template} => Types::ExperimentTemplate
@example Request syntax with placeholder values
resp = client.get_experiment_template({ id: "ExperimentTemplateId", # required })
@example Response structure
resp.experiment_template.id #=> String resp.experiment_template.description #=> String resp.experiment_template.targets #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_type #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags["TagKey"] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].path #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].selection_mode #=> String resp.experiment_template.actions #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].action_id #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].description #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].parameters #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].parameters["ExperimentTemplateActionParameterName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].targets #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].targets["ExperimentTemplateActionTargetName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].start_after #=> Array resp.experiment_template.actions["ExperimentTemplateActionName"].start_after[0] #=> String resp.experiment_template.stop_conditions #=> Array resp.experiment_template.stop_conditions[0].source #=> String resp.experiment_template.stop_conditions[0].value #=> String resp.experiment_template.creation_time #=> Time resp.experiment_template.last_update_time #=> Time resp.experiment_template.role_arn #=> String resp.experiment_template.tags #=> Hash resp.experiment_template.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/GetExperimentTemplate AWS API Documentation
@overload get_experiment_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 679 def get_experiment_template(params = {}, options = {}) req = build_request(:get_experiment_template, params) req.send_request(options) end
Lists the available AWS FIS
actions.
@option params [Integer] :max_results
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.
@option params [String] :next_token
The token for the next page of results.
@return [Types::ListActionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListActionsResponse#actions #actions} => Array<Types::ActionSummary> * {Types::ListActionsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_actions({ max_results: 1, next_token: "NextToken", })
@example Response structure
resp.actions #=> Array resp.actions[0].id #=> String resp.actions[0].description #=> String resp.actions[0].targets #=> Hash resp.actions[0].targets["ActionTargetName"].resource_type #=> String resp.actions[0].tags #=> Hash resp.actions[0].tags["TagKey"] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/ListActions AWS API Documentation
@overload list_actions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 723 def list_actions(params = {}, options = {}) req = build_request(:list_actions, params) req.send_request(options) end
Lists your experiment templates.
@option params [Integer] :max_results
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.
@option params [String] :next_token
The token for the next page of results.
@return [Types::ListExperimentTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListExperimentTemplatesResponse#experiment_templates #experiment_templates} => Array<Types::ExperimentTemplateSummary> * {Types::ListExperimentTemplatesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_experiment_templates({ max_results: 1, next_token: "NextToken", })
@example Response structure
resp.experiment_templates #=> Array resp.experiment_templates[0].id #=> String resp.experiment_templates[0].description #=> String resp.experiment_templates[0].creation_time #=> Time resp.experiment_templates[0].last_update_time #=> Time resp.experiment_templates[0].tags #=> Hash resp.experiment_templates[0].tags["TagKey"] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/ListExperimentTemplates AWS API Documentation
@overload list_experiment_templates
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 767 def list_experiment_templates(params = {}, options = {}) req = build_request(:list_experiment_templates, params) req.send_request(options) end
Lists your experiments.
@option params [Integer] :max_results
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.
@option params [String] :next_token
The token for the next page of results.
@return [Types::ListExperimentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListExperimentsResponse#experiments #experiments} => Array<Types::ExperimentSummary> * {Types::ListExperimentsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_experiments({ max_results: 1, next_token: "NextToken", })
@example Response structure
resp.experiments #=> Array resp.experiments[0].id #=> String resp.experiments[0].experiment_template_id #=> String resp.experiments[0].state.status #=> String, one of "pending", "initiating", "running", "completed", "stopping", "stopped", "failed" resp.experiments[0].state.reason #=> String resp.experiments[0].creation_time #=> Time resp.experiments[0].tags #=> Hash resp.experiments[0].tags["TagKey"] #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/ListExperiments AWS API Documentation
@overload list_experiments
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 812 def list_experiments(params = {}, options = {}) req = build_request(:list_experiments, params) req.send_request(options) end
Starts running an experiment from the specified experiment template.
@option params [required, String] :client_token
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. **A suitable default value is auto-generated.** You should normally not need to pass this option.**
@option params [required, String] :experiment_template_id
The ID of the experiment template.
@option params [Hash<String,String>] :tags
The tags to apply to the experiment.
@return [Types::StartExperimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartExperimentResponse#experiment #experiment} => Types::Experiment
@example Request syntax with placeholder values
resp = client.start_experiment({ client_token: "ClientToken", # required experiment_template_id: "ExperimentTemplateId", # required tags: { "TagKey" => "TagValue", }, })
@example Response structure
resp.experiment.id #=> String resp.experiment.experiment_template_id #=> String resp.experiment.role_arn #=> String resp.experiment.state.status #=> String, one of "pending", "initiating", "running", "completed", "stopping", "stopped", "failed" resp.experiment.state.reason #=> String resp.experiment.targets #=> Hash resp.experiment.targets["ExperimentTargetName"].resource_type #=> String resp.experiment.targets["ExperimentTargetName"].resource_arns #=> Array resp.experiment.targets["ExperimentTargetName"].resource_arns[0] #=> String resp.experiment.targets["ExperimentTargetName"].resource_tags #=> Hash resp.experiment.targets["ExperimentTargetName"].resource_tags["TagKey"] #=> String resp.experiment.targets["ExperimentTargetName"].filters #=> Array resp.experiment.targets["ExperimentTargetName"].filters[0].path #=> String resp.experiment.targets["ExperimentTargetName"].filters[0].values #=> Array resp.experiment.targets["ExperimentTargetName"].filters[0].values[0] #=> String resp.experiment.targets["ExperimentTargetName"].selection_mode #=> String resp.experiment.actions #=> Hash resp.experiment.actions["ExperimentActionName"].action_id #=> String resp.experiment.actions["ExperimentActionName"].description #=> String resp.experiment.actions["ExperimentActionName"].parameters #=> Hash resp.experiment.actions["ExperimentActionName"].parameters["ExperimentActionParameterName"] #=> String resp.experiment.actions["ExperimentActionName"].targets #=> Hash resp.experiment.actions["ExperimentActionName"].targets["ExperimentActionTargetName"] #=> String resp.experiment.actions["ExperimentActionName"].start_after #=> Array resp.experiment.actions["ExperimentActionName"].start_after[0] #=> String resp.experiment.actions["ExperimentActionName"].state.status #=> String, one of "pending", "initiating", "running", "completed", "cancelled", "stopping", "stopped", "failed" resp.experiment.actions["ExperimentActionName"].state.reason #=> String resp.experiment.stop_conditions #=> Array resp.experiment.stop_conditions[0].source #=> String resp.experiment.stop_conditions[0].value #=> String resp.experiment.creation_time #=> Time resp.experiment.start_time #=> Time resp.experiment.end_time #=> Time resp.experiment.tags #=> Hash resp.experiment.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/StartExperiment AWS API Documentation
@overload start_experiment
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 917 def start_experiment(params = {}, options = {}) req = build_request(:start_experiment, params) req.send_request(options) end
Stops the specified experiment.
@option params [required, String] :id
The ID of the experiment.
@return [Types::StopExperimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StopExperimentResponse#experiment #experiment} => Types::Experiment
@example Request syntax with placeholder values
resp = client.stop_experiment({ id: "ExperimentId", # required })
@example Response structure
resp.experiment.id #=> String resp.experiment.experiment_template_id #=> String resp.experiment.role_arn #=> String resp.experiment.state.status #=> String, one of "pending", "initiating", "running", "completed", "stopping", "stopped", "failed" resp.experiment.state.reason #=> String resp.experiment.targets #=> Hash resp.experiment.targets["ExperimentTargetName"].resource_type #=> String resp.experiment.targets["ExperimentTargetName"].resource_arns #=> Array resp.experiment.targets["ExperimentTargetName"].resource_arns[0] #=> String resp.experiment.targets["ExperimentTargetName"].resource_tags #=> Hash resp.experiment.targets["ExperimentTargetName"].resource_tags["TagKey"] #=> String resp.experiment.targets["ExperimentTargetName"].filters #=> Array resp.experiment.targets["ExperimentTargetName"].filters[0].path #=> String resp.experiment.targets["ExperimentTargetName"].filters[0].values #=> Array resp.experiment.targets["ExperimentTargetName"].filters[0].values[0] #=> String resp.experiment.targets["ExperimentTargetName"].selection_mode #=> String resp.experiment.actions #=> Hash resp.experiment.actions["ExperimentActionName"].action_id #=> String resp.experiment.actions["ExperimentActionName"].description #=> String resp.experiment.actions["ExperimentActionName"].parameters #=> Hash resp.experiment.actions["ExperimentActionName"].parameters["ExperimentActionParameterName"] #=> String resp.experiment.actions["ExperimentActionName"].targets #=> Hash resp.experiment.actions["ExperimentActionName"].targets["ExperimentActionTargetName"] #=> String resp.experiment.actions["ExperimentActionName"].start_after #=> Array resp.experiment.actions["ExperimentActionName"].start_after[0] #=> String resp.experiment.actions["ExperimentActionName"].state.status #=> String, one of "pending", "initiating", "running", "completed", "cancelled", "stopping", "stopped", "failed" resp.experiment.actions["ExperimentActionName"].state.reason #=> String resp.experiment.stop_conditions #=> Array resp.experiment.stop_conditions[0].source #=> String resp.experiment.stop_conditions[0].value #=> String resp.experiment.creation_time #=> Time resp.experiment.start_time #=> Time resp.experiment.end_time #=> Time resp.experiment.tags #=> Hash resp.experiment.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/StopExperiment AWS API Documentation
@overload stop_experiment
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 979 def stop_experiment(params = {}, options = {}) req = build_request(:stop_experiment, params) req.send_request(options) end
Applies the specified tags to the specified resource.
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource.
@option params [required, Hash<String,String>] :tags
The tags for the resource.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.tag_resource({ resource_arn: "ResourceArn", # required tags: { # required "TagKey" => "TagValue", }, })
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/TagResource AWS API Documentation
@overload tag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 1007 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end
Removes the specified tags from the specified resource.
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource.
@option params [Array<String>] :tag_keys
The tag keys to remove.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.untag_resource({ resource_arn: "ResourceArn", # required tag_keys: ["TagKey"], })
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/UntagResource AWS API Documentation
@overload untag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 1033 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end
Updates the specified experiment template.
@option params [required, String] :id
The ID of the experiment template.
@option params [String] :description
A description for the template.
@option params [Array<Types::UpdateExperimentTemplateStopConditionInput>] :stop_conditions
The stop conditions for the experiment.
@option params [Hash<String,Types::UpdateExperimentTemplateTargetInput>] :targets
The targets for the experiment.
@option params [Hash<String,Types::UpdateExperimentTemplateActionInputItem>] :actions
The actions for the experiment.
@option params [String] :role_arn
The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
@return [Types::UpdateExperimentTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateExperimentTemplateResponse#experiment_template #experiment_template} => Types::ExperimentTemplate
@example Request syntax with placeholder values
resp = client.update_experiment_template({ id: "ExperimentTemplateId", # required description: "ExperimentTemplateDescription", stop_conditions: [ { source: "StopConditionSource", # required value: "StopConditionValue", }, ], targets: { "ExperimentTemplateTargetName" => { resource_type: "ResourceType", # required resource_arns: ["ResourceArn"], resource_tags: { "TagKey" => "TagValue", }, filters: [ { path: "ExperimentTemplateTargetFilterPath", # required values: ["ExperimentTemplateTargetFilterValue"], # required }, ], selection_mode: "ExperimentTemplateTargetSelectionMode", # required }, }, actions: { "ExperimentTemplateActionName" => { action_id: "ActionId", description: "ExperimentTemplateActionDescription", parameters: { "ExperimentTemplateActionParameterName" => "ExperimentTemplateActionParameter", }, targets: { "ExperimentTemplateActionTargetName" => "ExperimentTemplateTargetName", }, start_after: ["ExperimentTemplateActionStartAfter"], }, }, role_arn: "RoleArn", })
@example Response structure
resp.experiment_template.id #=> String resp.experiment_template.description #=> String resp.experiment_template.targets #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_type #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_arns[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags #=> Hash resp.experiment_template.targets["ExperimentTemplateTargetName"].resource_tags["TagKey"] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].path #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values #=> Array resp.experiment_template.targets["ExperimentTemplateTargetName"].filters[0].values[0] #=> String resp.experiment_template.targets["ExperimentTemplateTargetName"].selection_mode #=> String resp.experiment_template.actions #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].action_id #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].description #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].parameters #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].parameters["ExperimentTemplateActionParameterName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].targets #=> Hash resp.experiment_template.actions["ExperimentTemplateActionName"].targets["ExperimentTemplateActionTargetName"] #=> String resp.experiment_template.actions["ExperimentTemplateActionName"].start_after #=> Array resp.experiment_template.actions["ExperimentTemplateActionName"].start_after[0] #=> String resp.experiment_template.stop_conditions #=> Array resp.experiment_template.stop_conditions[0].source #=> String resp.experiment_template.stop_conditions[0].value #=> String resp.experiment_template.creation_time #=> Time resp.experiment_template.last_update_time #=> Time resp.experiment_template.role_arn #=> String resp.experiment_template.tags #=> Hash resp.experiment_template.tags["TagKey"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/fis-2020-12-01/UpdateExperimentTemplate AWS API Documentation
@overload update_experiment_template
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-fis/client.rb, line 1143 def update_experiment_template(params = {}, options = {}) req = build_request(:update_experiment_template, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-fis/client.rb, line 1167 def waiter_names [] end