AWS.Fis — AWS SDK for JavaScript (original) (raw)
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
Class: AWS.Fis
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service 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.
Sending a Request Using Fis
var fis = new AWS.Fis();
fis.createTargetAccountConfiguration(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();
Constructor Summarycollapse
- new AWS.Fis(options = {}) ⇒ Object constructor
Constructs a service object.
Property Summarycollapse
- endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summarycollapse
- createExperimentTemplate(params = {}, callback) ⇒ AWS.Request
Creates an experiment template. - createTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a target account configuration for the experiment template. - deleteExperimentTemplate(params = {}, callback) ⇒ AWS.Request
Deletes the specified experiment template.
. - deleteTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the specified target account configuration of the experiment template.
. - getAction(params = {}, callback) ⇒ AWS.Request
Gets information about the specified FIS action.
. - getExperiment(params = {}, callback) ⇒ AWS.Request
Gets information about the specified experiment.
. - getExperimentTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Gets information about the specified target account configuration of the experiment.
. - getExperimentTemplate(params = {}, callback) ⇒ AWS.Request
Gets information about the specified experiment template.
. - getSafetyLever(params = {}, callback) ⇒ AWS.Request
Gets information about the specified safety lever. - getTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Gets information about the specified target account configuration of the experiment template.
. - getTargetResourceType(params = {}, callback) ⇒ AWS.Request
Gets information about the specified resource type.
. - listActions(params = {}, callback) ⇒ AWS.Request
Lists the available FIS actions.
. - listExperimentResolvedTargets(params = {}, callback) ⇒ AWS.Request
Lists the resolved targets information of the specified experiment.
. - listExperiments(params = {}, callback) ⇒ AWS.Request
Lists your experiments.
. - listExperimentTargetAccountConfigurations(params = {}, callback) ⇒ AWS.Request
Lists the target account configurations of the specified experiment.
. - listExperimentTemplates(params = {}, callback) ⇒ AWS.Request
Lists your experiment templates.
. - listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags for the specified resource.
. - listTargetAccountConfigurations(params = {}, callback) ⇒ AWS.Request
Lists the target account configurations of the specified experiment template.
. - listTargetResourceTypes(params = {}, callback) ⇒ AWS.Request
Lists the target resource types.
. - startExperiment(params = {}, callback) ⇒ AWS.Request
Starts running an experiment from the specified experiment template.
. - stopExperiment(params = {}, callback) ⇒ AWS.Request
Stops the specified experiment.
. - tagResource(params = {}, callback) ⇒ AWS.Request
Applies the specified tags to the specified resource.
. - untagResource(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from the specified resource.
. - updateExperimentTemplate(params = {}, callback) ⇒ AWS.Request
Updates the specified experiment template.
. - updateSafetyLeverState(params = {}, callback) ⇒ AWS.Request
Updates the specified safety lever state. - updateTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Updates the target account configuration for the specified experiment template.
.
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.
Property Details
endpoint ⇒ AWS.Endpoint
Returns an Endpoint object representing the endpoint URL for service requests.
Method Details
createExperimentTemplate(params = {}, callback) ⇒ AWS.Request
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.
createTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
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.
deleteExperimentTemplate(params = {}, callback) ⇒ AWS.Request
Deletes the specified experiment template.
deleteTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes the specified target account configuration of the experiment template.
getAction(params = {}, callback) ⇒ AWS.Request
Gets information about the specified FIS action.
getExperiment(params = {}, callback) ⇒ AWS.Request
Gets information about the specified experiment.
getExperimentTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Gets information about the specified target account configuration of the experiment.
getExperimentTemplate(params = {}, callback) ⇒ AWS.Request
Gets information about the specified experiment template.
getSafetyLever(params = {}, callback) ⇒ AWS.Request
Gets information about the specified safety lever.
getTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Gets information about the specified target account configuration of the experiment template.
getTargetResourceType(params = {}, callback) ⇒ AWS.Request
Gets information about the specified resource type.
listActions(params = {}, callback) ⇒ AWS.Request
Lists the available FIS actions.
listExperimentResolvedTargets(params = {}, callback) ⇒ AWS.Request
Lists the resolved targets information of the specified experiment.
listExperiments(params = {}, callback) ⇒ AWS.Request
listExperimentTargetAccountConfigurations(params = {}, callback) ⇒ AWS.Request
Lists the target account configurations of the specified experiment.
listExperimentTemplates(params = {}, callback) ⇒ AWS.Request
Lists your experiment templates.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags for the specified resource.
listTargetAccountConfigurations(params = {}, callback) ⇒ AWS.Request
Lists the target account configurations of the specified experiment template.
listTargetResourceTypes(params = {}, callback) ⇒ AWS.Request
Lists the target resource types.
startExperiment(params = {}, callback) ⇒ AWS.Request
Starts running an experiment from the specified experiment template.
stopExperiment(params = {}, callback) ⇒ AWS.Request
Stops the specified experiment.
tagResource(params = {}, callback) ⇒ AWS.Request
Applies the specified tags to the specified resource.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from the specified resource.
updateExperimentTemplate(params = {}, callback) ⇒ AWS.Request
Updates the specified experiment template.
updateSafetyLeverState(params = {}, callback) ⇒ AWS.Request
Updates the specified safety lever state.
updateTargetAccountConfiguration(params = {}, callback) ⇒ AWS.Request
Updates the target account configuration for the specified experiment template.