Class: Aws::FIS::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    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. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    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
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    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.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 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.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :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

  • :retry_limit (Integer) — default: 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.

  • :retry_max_delay (Integer) — default: 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.

  • :retry_mode (String) — default: "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.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: 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.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 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.

  • :http_continue_timeout (Float) — default: 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.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    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.

  • :ssl_ca_directory (String)

    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.



348
349
350
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 348

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.

Examples:

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: "TargetResourceTypeId", # required
      resource_arns: ["ResourceArn"],
      resource_tags: {
        "TagKey" => "TagValue",
      },
      filters: [
        {
          path: "ExperimentTemplateTargetFilterPath", # required
          values: ["ExperimentTemplateTargetFilterValue"], # required
        },
      ],
      selection_mode: "ExperimentTemplateTargetSelectionMode", # required
      parameters: {
        "ExperimentTemplateTargetParameterName" => "ExperimentTemplateTargetParameterValue",
      },
    },
  },
  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",
  },
  log_configuration: {
    cloud_watch_logs_configuration: {
      log_group_arn: "CloudWatchLogGroupArn", # required
    },
    s3_configuration: {
      bucket_name: "S3BucketName", # required
      prefix: "S3ObjectKey",
    },
    log_schema_version: 1, # required
  },
})

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.targets["ExperimentTemplateTargetName"].parameters #=> Hash
resp.experiment_template.targets["ExperimentTemplateTargetName"].parameters["ExperimentTemplateTargetParameterName"] #=> 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
resp.experiment_template.log_configuration.cloud_watch_logs_configuration.log_group_arn #=> String
resp.experiment_template.log_configuration.s3_configuration.bucket_name #=> String
resp.experiment_template.log_configuration.s3_configuration.prefix #=> String
resp.experiment_template.log_configuration.log_schema_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_token (required, String)

    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.**

  • :description (required, String)

    A description for the experiment template.

  • :stop_conditions (required, Array<Types::CreateExperimentTemplateStopConditionInput>)

    The stop conditions.

  • :targets (Hash<String,Types::CreateExperimentTemplateTargetInput>)

    The targets for the experiment.

  • :actions (required, Hash<String,Types::CreateExperimentTemplateActionInput>)

    The actions for the experiment.

  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.

  • :tags (Hash<String,String>)

    The tags to apply to the experiment template.

  • :log_configuration (Types::CreateExperimentTemplateLogConfigurationInput)

    The configuration for experiment logging.

Returns:

See Also:



512
513
514
515
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 512

def create_experiment_template(params = {}, options = {})
  req = build_request(:create_experiment_template, params)
  req.send_request(options)
end

#delete_experiment_template(params = {}) ⇒ Types::DeleteExperimentTemplateResponse

Deletes the specified experiment template.

Examples:

Request syntax with placeholder values


resp = client.delete_experiment_template({
  id: "ExperimentTemplateId", # required
})

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.targets["ExperimentTemplateTargetName"].parameters #=> Hash
resp.experiment_template.targets["ExperimentTemplateTargetName"].parameters["ExperimentTemplateTargetParameterName"] #=> 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
resp.experiment_template.log_configuration.cloud_watch_logs_configuration.log_group_arn #=> String
resp.experiment_template.log_configuration.s3_configuration.bucket_name #=> String
resp.experiment_template.log_configuration.s3_configuration.prefix #=> String
resp.experiment_template.log_configuration.log_schema_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the experiment template.

Returns:

See Also:



575
576
577
578
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 575

def delete_experiment_template(params = {}, options = {})
  req = build_request(:delete_experiment_template, params)
  req.send_request(options)
end

#get_action(params = {}) ⇒ Types::GetActionResponse

Gets information about the specified FIS action.

Examples:

Request syntax with placeholder values


resp = client.get_action({
  id: "ActionId", # required
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the action.

Returns:

See Also:



611
612
613
614
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 611

def get_action(params = {}, options = {})
  req = build_request(:get_action, params)
  req.send_request(options)
end

#get_experiment(params = {}) ⇒ Types::GetExperimentResponse

Gets information about the specified experiment.

Examples:

Request syntax with placeholder values


resp = client.get_experiment({
  id: "ExperimentId", # required
})

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.targets["ExperimentTargetName"].parameters #=> Hash
resp.experiment.targets["ExperimentTargetName"].parameters["ExperimentTargetParameterName"] #=> 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.actions["ExperimentActionName"].start_time #=> Time
resp.experiment.actions["ExperimentActionName"].end_time #=> Time
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
resp.experiment.log_configuration.cloud_watch_logs_configuration.log_group_arn #=> String
resp.experiment.log_configuration.s3_configuration.bucket_name #=> String
resp.experiment.log_configuration.s3_configuration.prefix #=> String
resp.experiment.log_configuration.log_schema_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the experiment.

Returns:

See Also:



681
682
683
684
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 681

def get_experiment(params = {}, options = {})
  req = build_request(:get_experiment, params)
  req.send_request(options)
end

#get_experiment_template(params = {}) ⇒ Types::GetExperimentTemplateResponse

Gets information about the specified experiment template.

Examples:

Request syntax with placeholder values


resp = client.get_experiment_template({
  id: "ExperimentTemplateId", # required
})

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.targets["ExperimentTemplateTargetName"].parameters #=> Hash
resp.experiment_template.targets["ExperimentTemplateTargetName"].parameters["ExperimentTemplateTargetParameterName"] #=> 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
resp.experiment_template.log_configuration.cloud_watch_logs_configuration.log_group_arn #=> String
resp.experiment_template.log_configuration.s3_configuration.bucket_name #=> String
resp.experiment_template.log_configuration.s3_configuration.prefix #=> String
resp.experiment_template.log_configuration.log_schema_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the experiment template.

Returns:

See Also:



744
745
746
747
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 744

def get_experiment_template(params = {}, options = {})
  req = build_request(:get_experiment_template, params)
  req.send_request(options)
end

#get_target_resource_type(params = {}) ⇒ Types::GetTargetResourceTypeResponse

Gets information about the specified resource type.

Examples:

Request syntax with placeholder values


resp = client.get_target_resource_type({
  resource_type: "TargetResourceTypeId", # required
})

Response structure


resp.target_resource_type.resource_type #=> String
resp.target_resource_type.description #=> String
resp.target_resource_type.parameters #=> Hash
resp.target_resource_type.parameters["TargetResourceTypeParameterName"].description #=> String
resp.target_resource_type.parameters["TargetResourceTypeParameterName"].required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_type (required, String)

    The resource type.

Returns:

See Also:



776
777
778
779
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 776

def get_target_resource_type(params = {}, options = {})
  req = build_request(:get_target_resource_type, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_actions({
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:



820
821
822
823
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 820

def list_actions(params = {}, options = {})
  req = build_request(:list_actions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_experiment_templates({
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:



864
865
866
867
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 864

def list_experiment_templates(params = {}, options = {})
  req = build_request(:list_experiment_templates, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_experiments({
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:



909
910
911
912
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 909

def list_experiments(params = {}, options = {})
  req = build_request(:list_experiments, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



938
939
940
941
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 938

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_target_resource_types({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.target_resource_types #=> Array
resp.target_resource_types[0].resource_type #=> String
resp.target_resource_types[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:



978
979
980
981
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 978

def list_target_resource_types(params = {}, options = {})
  req = build_request(:list_target_resource_types, params)
  req.send_request(options)
end

#start_experiment(params = {}) ⇒ Types::StartExperimentResponse

Starts running an experiment from the specified experiment template.

Examples:

Request syntax with placeholder values


resp = client.start_experiment({
  client_token: "ClientToken", # required
  experiment_template_id: "ExperimentTemplateId", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

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.targets["ExperimentTargetName"].parameters #=> Hash
resp.experiment.targets["ExperimentTargetName"].parameters["ExperimentTargetParameterName"] #=> 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.actions["ExperimentActionName"].start_time #=> Time
resp.experiment.actions["ExperimentActionName"].end_time #=> Time
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
resp.experiment.log_configuration.cloud_watch_logs_configuration.log_group_arn #=> String
resp.experiment.log_configuration.s3_configuration.bucket_name #=> String
resp.experiment.log_configuration.s3_configuration.prefix #=> String
resp.experiment.log_configuration.log_schema_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_token (required, String)

    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.**

  • :experiment_template_id (required, String)

    The ID of the experiment template.

  • :tags (Hash<String,String>)

    The tags to apply to the experiment.

Returns:

See Also:



1062
1063
1064
1065
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1062

def start_experiment(params = {}, options = {})
  req = build_request(:start_experiment, params)
  req.send_request(options)
end

#stop_experiment(params = {}) ⇒ Types::StopExperimentResponse

Stops the specified experiment.

Examples:

Request syntax with placeholder values


resp = client.stop_experiment({
  id: "ExperimentId", # required
})

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.targets["ExperimentTargetName"].parameters #=> Hash
resp.experiment.targets["ExperimentTargetName"].parameters["ExperimentTargetParameterName"] #=> 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.actions["ExperimentActionName"].start_time #=> Time
resp.experiment.actions["ExperimentActionName"].end_time #=> Time
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
resp.experiment.log_configuration.cloud_watch_logs_configuration.log_group_arn #=> String
resp.experiment.log_configuration.s3_configuration.bucket_name #=> String
resp.experiment.log_configuration.s3_configuration.prefix #=> String
resp.experiment.log_configuration.log_schema_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the experiment.

Returns:

See Also:



1132
1133
1134
1135
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1132

def stop_experiment(params = {}, options = {})
  req = build_request(:stop_experiment, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Applies the specified tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>)

    The tags for the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1160
1161
1162
1163
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1160

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (Array<String>)

    The tag keys to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1186
1187
1188
1189
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1186

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_experiment_template(params = {}) ⇒ Types::UpdateExperimentTemplateResponse

Updates the specified experiment template.

Examples:

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: "TargetResourceTypeId", # required
      resource_arns: ["ResourceArn"],
      resource_tags: {
        "TagKey" => "TagValue",
      },
      filters: [
        {
          path: "ExperimentTemplateTargetFilterPath", # required
          values: ["ExperimentTemplateTargetFilterValue"], # required
        },
      ],
      selection_mode: "ExperimentTemplateTargetSelectionMode", # required
      parameters: {
        "ExperimentTemplateTargetParameterName" => "ExperimentTemplateTargetParameterValue",
      },
    },
  },
  actions: {
    "ExperimentTemplateActionName" => {
      action_id: "ActionId",
      description: "ExperimentTemplateActionDescription",
      parameters: {
        "ExperimentTemplateActionParameterName" => "ExperimentTemplateActionParameter",
      },
      targets: {
        "ExperimentTemplateActionTargetName" => "ExperimentTemplateTargetName",
      },
      start_after: ["ExperimentTemplateActionStartAfter"],
    },
  },
  role_arn: "RoleArn",
  log_configuration: {
    cloud_watch_logs_configuration: {
      log_group_arn: "CloudWatchLogGroupArn", # required
    },
    s3_configuration: {
      bucket_name: "S3BucketName", # required
      prefix: "S3ObjectKey",
    },
    log_schema_version: 1,
  },
})

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.targets["ExperimentTemplateTargetName"].parameters #=> Hash
resp.experiment_template.targets["ExperimentTemplateTargetName"].parameters["ExperimentTemplateTargetParameterName"] #=> 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
resp.experiment_template.log_configuration.cloud_watch_logs_configuration.log_group_arn #=> String
resp.experiment_template.log_configuration.s3_configuration.bucket_name #=> String
resp.experiment_template.log_configuration.s3_configuration.prefix #=> String
resp.experiment_template.log_configuration.log_schema_version #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



1318
1319
1320
1321
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1318

def update_experiment_template(params = {}, options = {})
  req = build_request(:update_experiment_template, params)
  req.send_request(options)
end