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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials 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)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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 —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :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.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :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.

  • :endpoint_provider (Aws::FIS::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::FIS::EndpointParameters.

  • :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.

  • :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_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

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

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

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



473
474
475
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#create_experiment_template(params = {}) ⇒ Types::CreateExperimentTemplateResponse

Creates an experiment template.

An experiment template includes the following components:

  • Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.

  • Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.

  • Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.

For more information, see experiment templates in the Fault Injection Service User Guide.

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
  },
  experiment_options: {
    account_targeting: "single-account", # accepts single-account, multi-account
    empty_target_resolution_mode: "fail", # accepts fail, skip
  },
  experiment_report_configuration: {
    outputs: {
      s3_configuration: {
        bucket_name: "S3BucketName",
        prefix: "ReportConfigurationS3OutputPrefix",
      },
    },
    data_sources: {
      cloud_watch_dashboards: [
        {
          dashboard_identifier: "ReportConfigurationCloudWatchDashboardIdentifier",
        },
      ],
    },
    pre_experiment_duration: "ReportConfigurationDuration",
    post_experiment_duration: "ReportConfigurationDuration",
  },
})

Response structure


resp.experiment_template.id #=> String
resp.experiment_template.arn #=> 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
resp.experiment_template.experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiment_template.experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiment_template. #=> Integer
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.bucket_name #=> String
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.prefix #=> String
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards #=> Array
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards[0].dashboard_identifier #=> String
resp.experiment_template.experiment_report_configuration.pre_experiment_duration #=> String
resp.experiment_template.experiment_report_configuration.post_experiment_duration #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



674
675
676
677
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 674

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

#create_target_account_configuration(params = {}) ⇒ Types::CreateTargetAccountConfigurationResponse

Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Service User Guide.

Examples:

Request syntax with placeholder values


resp = client.({
  client_token: "ClientToken",
  experiment_template_id: "ExperimentTemplateId", # required
  account_id: "TargetAccountId", # required
  role_arn: "RoleArn", # required
  description: "TargetAccountConfigurationDescription",
})

Response structure


resp..role_arn #=> String
resp.. #=> String
resp..description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (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 experiment template ID.

  • :account_id (required, String) —

    The Amazon Web Services account ID of the target account.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of an IAM role for the target account.

  • :description (String) —

    The description of the target account.

Returns:

See Also:



732
733
734
735
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 732

def (params = {}, options = {})
  req = build_request(:create_target_account_configuration, 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.arn #=> 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
resp.experiment_template.experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiment_template.experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiment_template. #=> Integer
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.bucket_name #=> String
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.prefix #=> String
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards #=> Array
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards[0].dashboard_identifier #=> String
resp.experiment_template.experiment_report_configuration.pre_experiment_duration #=> String
resp.experiment_template.experiment_report_configuration.post_experiment_duration #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the experiment template.

Returns:

See Also:



805
806
807
808
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 805

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

#delete_target_account_configuration(params = {}) ⇒ Types::DeleteTargetAccountConfigurationResponse

Deletes the specified target account configuration of the experiment template.

Examples:

Request syntax with placeholder values


resp = client.({
  experiment_template_id: "ExperimentTemplateId", # required
  account_id: "TargetAccountId", # required
})

Response structure


resp..role_arn #=> String
resp.. #=> String
resp..description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :experiment_template_id (required, String) —

    The ID of the experiment template.

  • :account_id (required, String) —

    The Amazon Web Services account ID of the target account.

Returns:

See Also:



840
841
842
843
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 840

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



877
878
879
880
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 877

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.arn #=> 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", "cancelled"
resp.experiment.state.reason #=> String
resp.experiment.state.error. #=> String
resp.experiment.state.error.code #=> String
resp.experiment.state.error.location #=> 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", "skipped"
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
resp.experiment.experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiment.experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiment.experiment_options.actions_mode #=> String, one of "skip-all", "run-all"
resp.experiment. #=> Integer
resp.experiment.experiment_report_configuration.outputs.s3_configuration.bucket_name #=> String
resp.experiment.experiment_report_configuration.outputs.s3_configuration.prefix #=> String
resp.experiment.experiment_report_configuration.data_sources.cloud_watch_dashboards #=> Array
resp.experiment.experiment_report_configuration.data_sources.cloud_watch_dashboards[0].dashboard_identifier #=> String
resp.experiment.experiment_report_configuration.pre_experiment_duration #=> String
resp.experiment.experiment_report_configuration.post_experiment_duration #=> String
resp.experiment.experiment_report.state.status #=> String, one of "pending", "running", "completed", "cancelled", "failed"
resp.experiment.experiment_report.state.reason #=> String
resp.experiment.experiment_report.state.error.code #=> String
resp.experiment.experiment_report.s3_reports #=> Array
resp.experiment.experiment_report.s3_reports[0].arn #=> String
resp.experiment.experiment_report.s3_reports[0].report_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the experiment.

Returns:

See Also:



967
968
969
970
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 967

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

#get_experiment_target_account_configuration(params = {}) ⇒ Types::GetExperimentTargetAccountConfigurationResponse

Gets information about the specified target account configuration of the experiment.

Examples:

Request syntax with placeholder values


resp = client.({
  experiment_id: "ExperimentId", # required
  account_id: "TargetAccountId", # required
})

Response structure


resp..role_arn #=> String
resp.. #=> String
resp..description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :experiment_id (required, String) —

    The ID of the experiment.

  • :account_id (required, String) —

    The Amazon Web Services account ID of the target account.

Returns:

See Also:



1002
1003
1004
1005
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1002

def (params = {}, options = {})
  req = build_request(:get_experiment_target_account_configuration, 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.arn #=> 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
resp.experiment_template.experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiment_template.experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiment_template. #=> Integer
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.bucket_name #=> String
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.prefix #=> String
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards #=> Array
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards[0].dashboard_identifier #=> String
resp.experiment_template.experiment_report_configuration.pre_experiment_duration #=> String
resp.experiment_template.experiment_report_configuration.post_experiment_duration #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the experiment template.

Returns:

See Also:



1075
1076
1077
1078
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1075

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

#get_safety_lever(params = {}) ⇒ Types::GetSafetyLeverResponse

Gets information about the specified safety lever.

Examples:

Request syntax with placeholder values


resp = client.get_safety_lever({
  id: "SafetyLeverId", # required
})

Response structure


resp.safety_lever.id #=> String
resp.safety_lever.arn #=> String
resp.safety_lever.state.status #=> String, one of "disengaged", "engaged", "engaging"
resp.safety_lever.state.reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the safety lever.

Returns:

See Also:



1106
1107
1108
1109
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1106

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

#get_target_account_configuration(params = {}) ⇒ Types::GetTargetAccountConfigurationResponse

Gets information about the specified target account configuration of the experiment template.

Examples:

Request syntax with placeholder values


resp = client.({
  experiment_template_id: "ExperimentTemplateId", # required
  account_id: "TargetAccountId", # required
})

Response structure


resp..role_arn #=> String
resp.. #=> String
resp..description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :experiment_template_id (required, String) —

    The ID of the experiment template.

  • :account_id (required, String) —

    The Amazon Web Services account ID of the target account.

Returns:

See Also:



1141
1142
1143
1144
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1141

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



1173
1174
1175
1176
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1173

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].arn #=> 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:



1218
1219
1220
1221
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1218

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

#list_experiment_resolved_targets(params = {}) ⇒ Types::ListExperimentResolvedTargetsResponse

Lists the resolved targets information of the specified experiment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_experiment_resolved_targets({
  experiment_id: "ExperimentId", # required
  max_results: 1,
  next_token: "NextToken",
  target_name: "TargetName",
})

Response structure


resp.resolved_targets #=> Array
resp.resolved_targets[0].resource_type #=> String
resp.resolved_targets[0].target_name #=> String
resp.resolved_targets[0].target_information #=> Hash
resp.resolved_targets[0].target_information["TargetInformationKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :experiment_id (required, String) —

    The ID of the experiment.

  • :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.

  • :target_name (String) —

    The name of the target.

Returns:

See Also:



1268
1269
1270
1271
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1268

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

#list_experiment_target_account_configurations(params = {}) ⇒ Types::ListExperimentTargetAccountConfigurationsResponse

Lists the target account configurations of the specified experiment.

Examples:

Request syntax with placeholder values


resp = client.({
  experiment_id: "ExperimentId", # required
  next_token: "NextToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :experiment_id (required, String) —

    The ID of the experiment.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



1305
1306
1307
1308
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1305

def (params = {}, options = {})
  req = build_request(:list_experiment_target_account_configurations, 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].arn #=> 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:



1350
1351
1352
1353
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1350

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",
  experiment_template_id: "ExperimentTemplateId",
})

Response structure


resp.experiments #=> Array
resp.experiments[0].id #=> String
resp.experiments[0].arn #=> String
resp.experiments[0].experiment_template_id #=> String
resp.experiments[0].state.status #=> String, one of "pending", "initiating", "running", "completed", "stopping", "stopped", "failed", "cancelled"
resp.experiments[0].state.reason #=> String
resp.experiments[0].state.error. #=> String
resp.experiments[0].state.error.code #=> String
resp.experiments[0].state.error.location #=> String
resp.experiments[0].creation_time #=> Time
resp.experiments[0].tags #=> Hash
resp.experiments[0].tags["TagKey"] #=> String
resp.experiments[0].experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiments[0].experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiments[0].experiment_options.actions_mode #=> String, one of "skip-all", "run-all"
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.

  • :experiment_template_id (String) —

    The ID of the experiment template.

Returns:

See Also:



1406
1407
1408
1409
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1406

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:



1435
1436
1437
1438
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1435

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

#list_target_account_configurations(params = {}) ⇒ Types::ListTargetAccountConfigurationsResponse

Lists the target account configurations of the specified experiment template.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  experiment_template_id: "ExperimentTemplateId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :experiment_template_id (required, String) —

    The ID of the experiment template.

  • :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:



1481
1482
1483
1484
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1481

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



1521
1522
1523
1524
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1521

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
  experiment_options: {
    actions_mode: "skip-all", # accepts skip-all, run-all
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.experiment.id #=> String
resp.experiment.arn #=> 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", "cancelled"
resp.experiment.state.reason #=> String
resp.experiment.state.error. #=> String
resp.experiment.state.error.code #=> String
resp.experiment.state.error.location #=> 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", "skipped"
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
resp.experiment.experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiment.experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiment.experiment_options.actions_mode #=> String, one of "skip-all", "run-all"
resp.experiment. #=> Integer
resp.experiment.experiment_report_configuration.outputs.s3_configuration.bucket_name #=> String
resp.experiment.experiment_report_configuration.outputs.s3_configuration.prefix #=> String
resp.experiment.experiment_report_configuration.data_sources.cloud_watch_dashboards #=> Array
resp.experiment.experiment_report_configuration.data_sources.cloud_watch_dashboards[0].dashboard_identifier #=> String
resp.experiment.experiment_report_configuration.pre_experiment_duration #=> String
resp.experiment.experiment_report_configuration.post_experiment_duration #=> String
resp.experiment.experiment_report.state.status #=> String, one of "pending", "running", "completed", "cancelled", "failed"
resp.experiment.experiment_report.state.reason #=> String
resp.experiment.experiment_report.state.error.code #=> String
resp.experiment.experiment_report.s3_reports #=> Array
resp.experiment.experiment_report.s3_reports[0].arn #=> String
resp.experiment.experiment_report.s3_reports[0].report_type #=> String

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.

  • :experiment_options (Types::StartExperimentExperimentOptionsInput) —

    The experiment options for running the experiment.

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

    The tags to apply to the experiment.

Returns:

See Also:



1631
1632
1633
1634
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1631

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.arn #=> 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", "cancelled"
resp.experiment.state.reason #=> String
resp.experiment.state.error. #=> String
resp.experiment.state.error.code #=> String
resp.experiment.state.error.location #=> 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", "skipped"
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
resp.experiment.experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiment.experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiment.experiment_options.actions_mode #=> String, one of "skip-all", "run-all"
resp.experiment. #=> Integer
resp.experiment.experiment_report_configuration.outputs.s3_configuration.bucket_name #=> String
resp.experiment.experiment_report_configuration.outputs.s3_configuration.prefix #=> String
resp.experiment.experiment_report_configuration.data_sources.cloud_watch_dashboards #=> Array
resp.experiment.experiment_report_configuration.data_sources.cloud_watch_dashboards[0].dashboard_identifier #=> String
resp.experiment.experiment_report_configuration.pre_experiment_duration #=> String
resp.experiment.experiment_report_configuration.post_experiment_duration #=> String
resp.experiment.experiment_report.state.status #=> String, one of "pending", "running", "completed", "cancelled", "failed"
resp.experiment.experiment_report.state.reason #=> String
resp.experiment.experiment_report.state.error.code #=> String
resp.experiment.experiment_report.s3_reports #=> Array
resp.experiment.experiment_report.s3_reports[0].arn #=> String
resp.experiment.experiment_report.s3_reports[0].report_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the experiment.

Returns:

See Also:



1721
1722
1723
1724
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1721

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:



1749
1750
1751
1752
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1749

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:



1775
1776
1777
1778
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1775

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,
  },
  experiment_options: {
    empty_target_resolution_mode: "fail", # accepts fail, skip
  },
  experiment_report_configuration: {
    outputs: {
      s3_configuration: {
        bucket_name: "S3BucketName",
        prefix: "ReportConfigurationS3OutputPrefix",
      },
    },
    data_sources: {
      cloud_watch_dashboards: [
        {
          dashboard_identifier: "ReportConfigurationCloudWatchDashboardIdentifier",
        },
      ],
    },
    pre_experiment_duration: "ReportConfigurationDuration",
    post_experiment_duration: "ReportConfigurationDuration",
  },
})

Response structure


resp.experiment_template.id #=> String
resp.experiment_template.arn #=> 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
resp.experiment_template.experiment_options. #=> String, one of "single-account", "multi-account"
resp.experiment_template.experiment_options.empty_target_resolution_mode #=> String, one of "fail", "skip"
resp.experiment_template. #=> Integer
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.bucket_name #=> String
resp.experiment_template.experiment_report_configuration.outputs.s3_configuration.prefix #=> String
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards #=> Array
resp.experiment_template.experiment_report_configuration.data_sources.cloud_watch_dashboards[0].dashboard_identifier #=> String
resp.experiment_template.experiment_report_configuration.pre_experiment_duration #=> String
resp.experiment_template.experiment_report_configuration.post_experiment_duration #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1943
1944
1945
1946
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1943

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

#update_safety_lever_state(params = {}) ⇒ Types::UpdateSafetyLeverStateResponse

Updates the specified safety lever state.

Examples:

Request syntax with placeholder values


resp = client.update_safety_lever_state({
  id: "SafetyLeverId", # required
  state: { # required
    status: "disengaged", # required, accepts disengaged, engaged
    reason: "SafetyLeverStatusReason", # required
  },
})

Response structure


resp.safety_lever.id #=> String
resp.safety_lever.arn #=> String
resp.safety_lever.state.status #=> String, one of "disengaged", "engaged", "engaging"
resp.safety_lever.state.reason #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1981
1982
1983
1984
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 1981

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

#update_target_account_configuration(params = {}) ⇒ Types::UpdateTargetAccountConfigurationResponse

Updates the target account configuration for the specified experiment template.

Examples:

Request syntax with placeholder values


resp = client.({
  experiment_template_id: "ExperimentTemplateId", # required
  account_id: "TargetAccountId", # required
  role_arn: "RoleArn",
  description: "TargetAccountConfigurationDescription",
})

Response structure


resp..role_arn #=> String
resp.. #=> String
resp..description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :experiment_template_id (required, String) —

    The ID of the experiment template.

  • :account_id (required, String) —

    The Amazon Web Services account ID of the target account.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of an IAM role for the target account.

  • :description (String) —

    The description of the target account.

Returns:

See Also:



2024
2025
2026
2027
 
# File 'gems/aws-sdk-fis/lib/aws-sdk-fis/client.rb', line 2024

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