Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

Class: AWS.Fis

Inherits:
AWS.Service show all
Identifier:
fis
API Version:
2020-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using Fis

var fis = new AWS.Fis();
fis.createExperimentTemplate(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Fis object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var fis = new AWS.Fis({apiVersion: '2020-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the fis service identifier:

AWS.config.apiVersions = {
  fis: '2020-12-01',
  // other service API versions
};

var fis = new AWS.Fis();

Version:

  • 2020-12-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Fis(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Fis object

var fis = new AWS.Fis({apiVersion: '2020-12-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Fis.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Fis.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Fis.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createExperimentTemplate(params = {}, callback) ⇒ AWS.Request

Creates an experiment template.

To create a template, specify the following information:

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

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

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

For more information, see the AWS Fault Injection Simulator User Guide.

Service Reference:

Examples:

Calling the createExperimentTemplate operation

var params = {
  actions: { /* required */
    '<ExperimentTemplateActionName>': {
      actionId: 'STRING_VALUE', /* required */
      description: 'STRING_VALUE',
      parameters: {
        '<ExperimentTemplateActionParameterName>': 'STRING_VALUE',
        /* '<ExperimentTemplateActionParameterName>': ... */
      },
      startAfter: [
        'STRING_VALUE',
        /* more items */
      ],
      targets: {
        '<ExperimentTemplateActionTargetName>': 'STRING_VALUE',
        /* '<ExperimentTemplateActionTargetName>': ... */
      }
    },
    /* '<ExperimentTemplateActionName>': ... */
  },
  clientToken: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  stopConditions: [ /* required */
    {
      source: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  targets: {
    '<ExperimentTemplateTargetName>': {
      resourceType: 'STRING_VALUE', /* required */
      selectionMode: 'STRING_VALUE', /* required */
      filters: [
        {
          path: 'STRING_VALUE', /* required */
          values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      resourceArns: [
        'STRING_VALUE',
        /* more items */
      ],
      resourceTags: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    },
    /* '<ExperimentTemplateTargetName>': ... */
  }
};
fis.createExperimentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      A description for the experiment template. Can contain up to 64 letters (A-Z and a-z).

    • stopConditions — (Array<map>)

      The stop conditions.

      • sourcerequired — (String)

        The source for the stop condition. Specify aws:cloudwatch:alarm if the stop condition is defined by a CloudWatch alarm. Specify none if there is no stop condition.

      • value — (String)

        The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.

    • targets — (map<map>)

      The targets for the experiment.

      • resourceTyperequired — (String)

        The AWS resource type. The resource type must be supported for the specified action.

      • resourceArns — (Array<String>)

        The Amazon Resource Names (ARNs) of the resources.

      • resourceTags — (map<String>)

        The tags for the target resources.

      • filters — (Array<map>)

        The filters to apply to identify target resources using specific attributes.

        • pathrequired — (String)

          The attribute path for the filter.

        • valuesrequired — (Array<String>)

          The attribute values for the filter.

      • selectionModerequired — (String)

        Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.

        • ALL - Run the action on all identified targets. This is the default.

        • COUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random. For example, COUNT(1) selects one of the targets.

        • PERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets at random. For example, PERCENT(25) selects 25% of the targets.

    • actions — (map<map>)

      The actions for the experiment.

      • actionIdrequired — (String)

        The ID of the action.

      • description — (String)

        A description for the action.

      • parameters — (map<String>)

        The parameters for the action, if applicable.

      • targets — (map<String>)

        The targets for the action.

      • startAfter — (Array<String>)

        The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.

    • roleArn — (String)

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

    • tags — (map<String>)

      The tags to apply to the experiment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experimentTemplate — (map)

        Information about the experiment template.

        • id — (String)

          The ID of the experiment template.

        • description — (String)

          The description for the experiment template.

        • targets — (map<map>)

          The targets for the experiment.

          • resourceType — (String)

            The resource type.

          • resourceArns — (Array<String>)

            The Amazon Resource Names (ARNs) of the targets.

          • resourceTags — (map<String>)

            The tags for the target resources.

          • filters — (Array<map>)

            The filters to apply to identify target resources using specific attributes.

            • path — (String)

              The attribute path for the filter.

            • values — (Array<String>)

              The attribute values for the filter.

          • selectionMode — (String)

            Scopes the identified resources to a specific count or percentage.

        • actions — (map<map>)

          The actions for the experiment.

          • actionId — (String)

            The ID of the action.

          • description — (String)

            A description for the action.

          • parameters — (map<String>)

            The parameters for the action.

          • targets — (map<String>)

            The targets for the action.

          • startAfter — (Array<String>)

            The name of the action that must be completed before the current action starts.

        • stopConditions — (Array<map>)

          The stop conditions for the experiment.

          • source — (String)

            The source for the stop condition.

          • value — (String)

            The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

        • creationTime — (Date)

          The time the experiment template was created.

        • lastUpdateTime — (Date)

          The time the experiment template was last updated.

        • roleArn — (String)

          The Amazon Resource Name (ARN) of an IAM role.

        • tags — (map<String>)

          The tags for the experiment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteExperimentTemplate(params = {}, callback) ⇒ AWS.Request

Deletes the specified experiment template.

Service Reference:

Examples:

Calling the deleteExperimentTemplate operation

var params = {
  id: 'STRING_VALUE' /* required */
};
fis.deleteExperimentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the experiment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experimentTemplate — (map)

        Information about the experiment template.

        • id — (String)

          The ID of the experiment template.

        • description — (String)

          The description for the experiment template.

        • targets — (map<map>)

          The targets for the experiment.

          • resourceType — (String)

            The resource type.

          • resourceArns — (Array<String>)

            The Amazon Resource Names (ARNs) of the targets.

          • resourceTags — (map<String>)

            The tags for the target resources.

          • filters — (Array<map>)

            The filters to apply to identify target resources using specific attributes.

            • path — (String)

              The attribute path for the filter.

            • values — (Array<String>)

              The attribute values for the filter.

          • selectionMode — (String)

            Scopes the identified resources to a specific count or percentage.

        • actions — (map<map>)

          The actions for the experiment.

          • actionId — (String)

            The ID of the action.

          • description — (String)

            A description for the action.

          • parameters — (map<String>)

            The parameters for the action.

          • targets — (map<String>)

            The targets for the action.

          • startAfter — (Array<String>)

            The name of the action that must be completed before the current action starts.

        • stopConditions — (Array<map>)

          The stop conditions for the experiment.

          • source — (String)

            The source for the stop condition.

          • value — (String)

            The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

        • creationTime — (Date)

          The time the experiment template was created.

        • lastUpdateTime — (Date)

          The time the experiment template was last updated.

        • roleArn — (String)

          The Amazon Resource Name (ARN) of an IAM role.

        • tags — (map<String>)

          The tags for the experiment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAction(params = {}, callback) ⇒ AWS.Request

Gets information about the specified AWS FIS action.

Service Reference:

Examples:

Calling the getAction operation

var params = {
  id: 'STRING_VALUE' /* required */
};
fis.getAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the action.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • action — (map)

        Information about the action.

        • id — (String)

          The ID of the action.

        • description — (String)

          The description for the action.

        • parameters — (map<map>)

          The action parameters, if applicable.

          • description — (String)

            The parameter description.

          • required — (Boolean)

            Indicates whether the parameter is required.

        • targets — (map<map>)

          The supported targets for the action.

          • resourceType — (String)

            The resource type of the target.

        • tags — (map<String>)

          The tags for the action.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getExperiment(params = {}, callback) ⇒ AWS.Request

Gets information about the specified experiment.

Service Reference:

Examples:

Calling the getExperiment operation

var params = {
  id: 'STRING_VALUE' /* required */
};
fis.getExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiment — (map)

        Information about the experiment.

        • id — (String)

          The ID of the experiment.

        • experimentTemplateId — (String)

          The ID of the experiment template.

        • roleArn — (String)

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

        • state — (map)

          The state of the experiment.

          • status — (String)

            The state of the experiment.

            Possible values include:
            • "pending"
            • "initiating"
            • "running"
            • "completed"
            • "stopping"
            • "stopped"
            • "failed"
          • reason — (String)

            The reason for the state.

        • targets — (map<map>)

          The targets for the experiment.

          • resourceType — (String)

            The resource type.

          • resourceArns — (Array<String>)

            The Amazon Resource Names (ARNs) of the resources.

          • resourceTags — (map<String>)

            The tags for the target resources.

          • filters — (Array<map>)

            The filters to apply to identify target resources using specific attributes.

            • path — (String)

              The attribute path for the filter.

            • values — (Array<String>)

              The attribute values for the filter.

          • selectionMode — (String)

            Scopes the identified resources to a specific count or percentage.

        • actions — (map<map>)

          The actions for the experiment.

          • actionId — (String)

            The ID of the action.

          • description — (String)

            The description for the action.

          • parameters — (map<String>)

            The parameters for the action.

          • targets — (map<String>)

            The targets for the action.

          • startAfter — (Array<String>)

            The name of the action that must be completed before this action starts.

          • state — (map)

            The state of the action.

            • status — (String)

              The state of the action.

              Possible values include:
              • "pending"
              • "initiating"
              • "running"
              • "completed"
              • "cancelled"
              • "stopping"
              • "stopped"
              • "failed"
            • reason — (String)

              The reason for the state.

        • stopConditions — (Array<map>)

          The stop conditions for the experiment.

          • source — (String)

            The source for the stop condition.

          • value — (String)

            The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

        • creationTime — (Date)

          The time the experiment was created.

        • startTime — (Date)

          The time that the experiment was started.

        • endTime — (Date)

          The time that the experiment ended.

        • tags — (map<String>)

          The tags for the experiment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getExperimentTemplate(params = {}, callback) ⇒ AWS.Request

Gets information about the specified experiment template.

Service Reference:

Examples:

Calling the getExperimentTemplate operation

var params = {
  id: 'STRING_VALUE' /* required */
};
fis.getExperimentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the experiment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experimentTemplate — (map)

        Information about the experiment template.

        • id — (String)

          The ID of the experiment template.

        • description — (String)

          The description for the experiment template.

        • targets — (map<map>)

          The targets for the experiment.

          • resourceType — (String)

            The resource type.

          • resourceArns — (Array<String>)

            The Amazon Resource Names (ARNs) of the targets.

          • resourceTags — (map<String>)

            The tags for the target resources.

          • filters — (Array<map>)

            The filters to apply to identify target resources using specific attributes.

            • path — (String)

              The attribute path for the filter.

            • values — (Array<String>)

              The attribute values for the filter.

          • selectionMode — (String)

            Scopes the identified resources to a specific count or percentage.

        • actions — (map<map>)

          The actions for the experiment.

          • actionId — (String)

            The ID of the action.

          • description — (String)

            A description for the action.

          • parameters — (map<String>)

            The parameters for the action.

          • targets — (map<String>)

            The targets for the action.

          • startAfter — (Array<String>)

            The name of the action that must be completed before the current action starts.

        • stopConditions — (Array<map>)

          The stop conditions for the experiment.

          • source — (String)

            The source for the stop condition.

          • value — (String)

            The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

        • creationTime — (Date)

          The time the experiment template was created.

        • lastUpdateTime — (Date)

          The time the experiment template was last updated.

        • roleArn — (String)

          The Amazon Resource Name (ARN) of an IAM role.

        • tags — (map<String>)

          The tags for the experiment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listActions(params = {}, callback) ⇒ AWS.Request

Lists the available AWS FIS actions.

Service Reference:

Examples:

Calling the listActions operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
fis.listActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • actions — (Array<map>)

        The actions.

        • id — (String)

          The ID of the action.

        • description — (String)

          The description for the action.

        • targets — (map<map>)

          The targets for the action.

          • resourceType — (String)

            The resource type of the target.

        • tags — (map<String>)

          The tags for the action.

      • nextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listExperiments(params = {}, callback) ⇒ AWS.Request

Lists your experiments.

Service Reference:

Examples:

Calling the listExperiments operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
fis.listExperiments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiments — (Array<map>)

        The experiments.

        • id — (String)

          The ID of the experiment.

        • experimentTemplateId — (String)

          The ID of the experiment template.

        • state — (map)

          The state of the experiment.

          • status — (String)

            The state of the experiment.

            Possible values include:
            • "pending"
            • "initiating"
            • "running"
            • "completed"
            • "stopping"
            • "stopped"
            • "failed"
          • reason — (String)

            The reason for the state.

        • creationTime — (Date)

          The time that the experiment was created.

        • tags — (map<String>)

          The tags for the experiment.

      • nextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listExperimentTemplates(params = {}, callback) ⇒ AWS.Request

Lists your experiment templates.

Service Reference:

Examples:

Calling the listExperimentTemplates operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
fis.listExperimentTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experimentTemplates — (Array<map>)

        The experiment templates.

        • id — (String)

          The ID of the experiment template.

        • description — (String)

          The description of the experiment template.

        • creationTime — (Date)

          The time that the experiment template was created.

        • lastUpdateTime — (Date)

          The time that the experiment template was last updated.

        • tags — (map<String>)

          The tags for the experiment template.

      • nextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
fis.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags for the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startExperiment(params = {}, callback) ⇒ AWS.Request

Starts running an experiment from the specified experiment template.

Service Reference:

Examples:

Calling the startExperiment operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  experimentTemplateId: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
fis.startExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • experimentTemplateId — (String)

      The ID of the experiment template.

    • tags — (map<String>)

      The tags to apply to the experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiment — (map)

        Information about the experiment.

        • id — (String)

          The ID of the experiment.

        • experimentTemplateId — (String)

          The ID of the experiment template.

        • roleArn — (String)

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

        • state — (map)

          The state of the experiment.

          • status — (String)

            The state of the experiment.

            Possible values include:
            • "pending"
            • "initiating"
            • "running"
            • "completed"
            • "stopping"
            • "stopped"
            • "failed"
          • reason — (String)

            The reason for the state.

        • targets — (map<map>)

          The targets for the experiment.

          • resourceType — (String)

            The resource type.

          • resourceArns — (Array<String>)

            The Amazon Resource Names (ARNs) of the resources.

          • resourceTags — (map<String>)

            The tags for the target resources.

          • filters — (Array<map>)

            The filters to apply to identify target resources using specific attributes.

            • path — (String)

              The attribute path for the filter.

            • values — (Array<String>)

              The attribute values for the filter.

          • selectionMode — (String)

            Scopes the identified resources to a specific count or percentage.

        • actions — (map<map>)

          The actions for the experiment.

          • actionId — (String)

            The ID of the action.

          • description — (String)

            The description for the action.

          • parameters — (map<String>)

            The parameters for the action.

          • targets — (map<String>)

            The targets for the action.

          • startAfter — (Array<String>)

            The name of the action that must be completed before this action starts.

          • state — (map)

            The state of the action.

            • status — (String)

              The state of the action.

              Possible values include:
              • "pending"
              • "initiating"
              • "running"
              • "completed"
              • "cancelled"
              • "stopping"
              • "stopped"
              • "failed"
            • reason — (String)

              The reason for the state.

        • stopConditions — (Array<map>)

          The stop conditions for the experiment.

          • source — (String)

            The source for the stop condition.

          • value — (String)

            The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

        • creationTime — (Date)

          The time the experiment was created.

        • startTime — (Date)

          The time that the experiment was started.

        • endTime — (Date)

          The time that the experiment ended.

        • tags — (map<String>)

          The tags for the experiment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopExperiment(params = {}, callback) ⇒ AWS.Request

Stops the specified experiment.

Service Reference:

Examples:

Calling the stopExperiment operation

var params = {
  id: 'STRING_VALUE' /* required */
};
fis.stopExperiment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the experiment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experiment — (map)

        Information about the experiment.

        • id — (String)

          The ID of the experiment.

        • experimentTemplateId — (String)

          The ID of the experiment template.

        • roleArn — (String)

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

        • state — (map)

          The state of the experiment.

          • status — (String)

            The state of the experiment.

            Possible values include:
            • "pending"
            • "initiating"
            • "running"
            • "completed"
            • "stopping"
            • "stopped"
            • "failed"
          • reason — (String)

            The reason for the state.

        • targets — (map<map>)

          The targets for the experiment.

          • resourceType — (String)

            The resource type.

          • resourceArns — (Array<String>)

            The Amazon Resource Names (ARNs) of the resources.

          • resourceTags — (map<String>)

            The tags for the target resources.

          • filters — (Array<map>)

            The filters to apply to identify target resources using specific attributes.

            • path — (String)

              The attribute path for the filter.

            • values — (Array<String>)

              The attribute values for the filter.

          • selectionMode — (String)

            Scopes the identified resources to a specific count or percentage.

        • actions — (map<map>)

          The actions for the experiment.

          • actionId — (String)

            The ID of the action.

          • description — (String)

            The description for the action.

          • parameters — (map<String>)

            The parameters for the action.

          • targets — (map<String>)

            The targets for the action.

          • startAfter — (Array<String>)

            The name of the action that must be completed before this action starts.

          • state — (map)

            The state of the action.

            • status — (String)

              The state of the action.

              Possible values include:
              • "pending"
              • "initiating"
              • "running"
              • "completed"
              • "cancelled"
              • "stopping"
              • "stopped"
              • "failed"
            • reason — (String)

              The reason for the state.

        • stopConditions — (Array<map>)

          The stop conditions for the experiment.

          • source — (String)

            The source for the stop condition.

          • value — (String)

            The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

        • creationTime — (Date)

          The time the experiment was created.

        • startTime — (Date)

          The time that the experiment was started.

        • endTime — (Date)

          The time that the experiment ended.

        • tags — (map<String>)

          The tags for the experiment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Applies the specified tags to the specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
fis.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags for the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the specified tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [
    'STRING_VALUE',
    /* more items */
  ]
};
fis.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      The tag keys to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateExperimentTemplate(params = {}, callback) ⇒ AWS.Request

Updates the specified experiment template.

Service Reference:

Examples:

Calling the updateExperimentTemplate operation

var params = {
  id: 'STRING_VALUE', /* required */
  actions: {
    '<ExperimentTemplateActionName>': {
      actionId: 'STRING_VALUE',
      description: 'STRING_VALUE',
      parameters: {
        '<ExperimentTemplateActionParameterName>': 'STRING_VALUE',
        /* '<ExperimentTemplateActionParameterName>': ... */
      },
      startAfter: [
        'STRING_VALUE',
        /* more items */
      ],
      targets: {
        '<ExperimentTemplateActionTargetName>': 'STRING_VALUE',
        /* '<ExperimentTemplateActionTargetName>': ... */
      }
    },
    /* '<ExperimentTemplateActionName>': ... */
  },
  description: 'STRING_VALUE',
  roleArn: 'STRING_VALUE',
  stopConditions: [
    {
      source: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  targets: {
    '<ExperimentTemplateTargetName>': {
      resourceType: 'STRING_VALUE', /* required */
      selectionMode: 'STRING_VALUE', /* required */
      filters: [
        {
          path: 'STRING_VALUE', /* required */
          values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      resourceArns: [
        'STRING_VALUE',
        /* more items */
      ],
      resourceTags: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    },
    /* '<ExperimentTemplateTargetName>': ... */
  }
};
fis.updateExperimentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the experiment template.

    • description — (String)

      A description for the template.

    • stopConditions — (Array<map>)

      The stop conditions for the experiment.

      • sourcerequired — (String)

        The source for the stop condition. Specify aws:cloudwatch:alarm if the stop condition is defined by a CloudWatch alarm. Specify none if there is no stop condition.

      • value — (String)

        The Amazon Resource Name (ARN) of the CloudWatch alarm.

    • targets — (map<map>)

      The targets for the experiment.

      • resourceTyperequired — (String)

        The AWS resource type. The resource type must be supported for the specified action.

      • resourceArns — (Array<String>)

        The Amazon Resource Names (ARNs) of the targets.

      • resourceTags — (map<String>)

        The tags for the target resources.

      • filters — (Array<map>)

        The filters to apply to identify target resources using specific attributes.

        • pathrequired — (String)

          The attribute path for the filter.

        • valuesrequired — (Array<String>)

          The attribute values for the filter.

      • selectionModerequired — (String)

        Scopes the identified resources to a specific count or percentage.

    • actions — (map<map>)

      The actions for the experiment.

      • actionId — (String)

        The ID of the action.

      • description — (String)

        A description for the action.

      • parameters — (map<String>)

        The parameters for the action, if applicable.

      • targets — (map<String>)

        The targets for the action.

      • startAfter — (Array<String>)

        The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.

    • roleArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • experimentTemplate — (map)

        Information about the experiment template.

        • id — (String)

          The ID of the experiment template.

        • description — (String)

          The description for the experiment template.

        • targets — (map<map>)

          The targets for the experiment.

          • resourceType — (String)

            The resource type.

          • resourceArns — (Array<String>)

            The Amazon Resource Names (ARNs) of the targets.

          • resourceTags — (map<String>)

            The tags for the target resources.

          • filters — (Array<map>)

            The filters to apply to identify target resources using specific attributes.

            • path — (String)

              The attribute path for the filter.

            • values — (Array<String>)

              The attribute values for the filter.

          • selectionMode — (String)

            Scopes the identified resources to a specific count or percentage.

        • actions — (map<map>)

          The actions for the experiment.

          • actionId — (String)

            The ID of the action.

          • description — (String)

            A description for the action.

          • parameters — (map<String>)

            The parameters for the action.

          • targets — (map<String>)

            The targets for the action.

          • startAfter — (Array<String>)

            The name of the action that must be completed before the current action starts.

        • stopConditions — (Array<map>)

          The stop conditions for the experiment.

          • source — (String)

            The source for the stop condition.

          • value — (String)

            The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

        • creationTime — (Date)

          The time the experiment template was created.

        • lastUpdateTime — (Date)

          The time the experiment template was last updated.

        • roleArn — (String)

          The Amazon Resource Name (ARN) of an IAM role.

        • tags — (map<String>)

          The tags for the experiment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.