Fis
This page documents function available when using the Fis module, created with @service Fis.
Index
Main.Fis.create_experiment_templateMain.Fis.delete_experiment_templateMain.Fis.get_actionMain.Fis.get_experimentMain.Fis.get_experiment_templateMain.Fis.get_target_resource_typeMain.Fis.list_actionsMain.Fis.list_experiment_templatesMain.Fis.list_experimentsMain.Fis.list_tags_for_resourceMain.Fis.list_target_resource_typesMain.Fis.start_experimentMain.Fis.stop_experimentMain.Fis.tag_resourceMain.Fis.untag_resourceMain.Fis.update_experiment_template
Documentation
Main.Fis.create_experiment_template — Methodcreate_experiment_template(actions, client_token, description, role_arn, stop_conditions)
create_experiment_template(actions, client_token, description, role_arn, stop_conditions, params::Dict{String,<:Any})Creates an experiment template. An experiment template includes the following components: Targets: A target can be a specific resource in your Amazon Web Services environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags. Actions: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment. Stop conditions: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm. For more information, see Experiment templates in the Fault Injection Simulator User Guide.
Arguments
actions: The actions for the experiment.client_token: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.description: A description for the experiment template.role_arn: The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.stop_conditions: The stop conditions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"logConfiguration": The configuration for experiment logging."tags": The tags to apply to the experiment template."targets": The targets for the experiment.
Main.Fis.delete_experiment_template — Methoddelete_experiment_template(id)
delete_experiment_template(id, params::Dict{String,<:Any})Deletes the specified experiment template.
Arguments
id: The ID of the experiment template.
Main.Fis.get_action — Methodget_action(id)
get_action(id, params::Dict{String,<:Any})Gets information about the specified FIS action.
Arguments
id: The ID of the action.
Main.Fis.get_experiment — Methodget_experiment(id)
get_experiment(id, params::Dict{String,<:Any})Gets information about the specified experiment.
Arguments
id: The ID of the experiment.
Main.Fis.get_experiment_template — Methodget_experiment_template(id)
get_experiment_template(id, params::Dict{String,<:Any})Gets information about the specified experiment template.
Arguments
id: The ID of the experiment template.
Main.Fis.get_target_resource_type — Methodget_target_resource_type(resource_type)
get_target_resource_type(resource_type, params::Dict{String,<:Any})Gets information about the specified resource type.
Arguments
resource_type: The resource type.
Main.Fis.list_actions — Methodlist_actions()
list_actions(params::Dict{String,<:Any})Lists the available FIS actions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": 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": The token for the next page of results.
Main.Fis.list_experiment_templates — Methodlist_experiment_templates()
list_experiment_templates(params::Dict{String,<:Any})Lists your experiment templates.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": 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": The token for the next page of results.
Main.Fis.list_experiments — Methodlist_experiments()
list_experiments(params::Dict{String,<:Any})Lists your experiments.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": 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": The token for the next page of results.
Main.Fis.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags for the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Fis.list_target_resource_types — Methodlist_target_resource_types()
list_target_resource_types(params::Dict{String,<:Any})Lists the target resource types.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": 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": The token for the next page of results.
Main.Fis.start_experiment — Methodstart_experiment(client_token, experiment_template_id)
start_experiment(client_token, experiment_template_id, params::Dict{String,<:Any})Starts running an experiment from the specified experiment template.
Arguments
client_token: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.experiment_template_id: The ID of the experiment template.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"tags": The tags to apply to the experiment.
Main.Fis.stop_experiment — Methodstop_experiment(id)
stop_experiment(id, params::Dict{String,<:Any})Stops the specified experiment.
Arguments
id: The ID of the experiment.
Main.Fis.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Applies the specified tags to the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tags: The tags for the resource.
Main.Fis.untag_resource — Methoduntag_resource(resource_arn)
untag_resource(resource_arn, params::Dict{String,<:Any})Removes the specified tags from the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"tagKeys": The tag keys to remove.
Main.Fis.update_experiment_template — Methodupdate_experiment_template(id)
update_experiment_template(id, params::Dict{String,<:Any})Updates the specified experiment template.
Arguments
id: The ID of the experiment template.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"actions": The actions for the experiment."description": A description for the template."logConfiguration": The configuration for experiment logging."roleArn": The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf."stopConditions": The stop conditions for the experiment."targets": The targets for the experiment.