Skip to content

Client

fis R Documentation

AWS Fault Injection Simulator

Description

Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Service User Guide.

Usage

fis(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- fis(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_experiment_template Creates an experiment template
create_target_account_configuration Creates a target account configuration for the experiment template
delete_experiment_template Deletes the specified experiment template
delete_target_account_configuration Deletes the specified target account configuration of the experiment template
get_action Gets information about the specified FIS action
get_experiment Gets information about the specified experiment
get_experiment_target_account_configuration Gets information about the specified target account configuration of the experiment
get_experiment_template Gets information about the specified experiment template
get_safety_lever Gets information about the specified safety lever
get_target_account_configuration Gets information about the specified target account configuration of the experiment template
get_target_resource_type Gets information about the specified resource type
list_actions Lists the available FIS actions
list_experiment_resolved_targets Lists the resolved targets information of the specified experiment
list_experiments Lists your experiments
list_experiment_target_account_configurations Lists the target account configurations of the specified experiment
list_experiment_templates Lists your experiment templates
list_tags_for_resource Lists the tags for the specified resource
list_target_account_configurations Lists the target account configurations of the specified experiment template
list_target_resource_types Lists the target resource types
start_experiment Starts running an experiment from the specified experiment template
stop_experiment Stops the specified experiment
tag_resource Applies the specified tags to the specified resource
untag_resource Removes the specified tags from the specified resource
update_experiment_template Updates the specified experiment template
update_safety_lever_state Updates the specified safety lever state
update_target_account_configuration Updates the target account configuration for the specified experiment template

Examples

## Not run: 
svc <- fis()
svc$create_experiment_template(
  Foo = 123
)

## End(Not run)