experiments

Creates, updates, deletes, gets or lists an experiments resource.

Overview

Name	experiments
Type	Resource
Id	aws.fis.experiments

Fields

The following fields are returned by SELECT queries:

get_experiment

Name	Datatype	Description
id	string	The ID of the experiment. (pattern: <code>[\S]+</code>)
actions	object	The actions for the experiment.
arn	string	The Amazon Resource Name (ARN) of the experiment. (pattern: <code>[\S]+</code>)
creation_time	string (date-time)	The time that the experiment was created.
end_time	string (date-time)	The time that the experiment ended.
experiment_options	object	The experiment options for the experiment.
experiment_report	object	The experiment report for the experiment.
experiment_report_configuration	object	The experiment report configuration for the experiment.
experiment_template_id	string	The ID of the experiment template. (pattern: <code>[\S]+</code>)
log_configuration	object	The configuration for experiment logging.
role_arn	string	The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf. (pattern: <code>[\S]+</code>)
start_time	string (date-time)	The time that the experiment started.
state	object	The state of the experiment.
stop_conditions	array	The stop conditions for the experiment.
tags	object	The tags for the experiment.
target_account_configurations_count	integer (int64)	The count of target account configurations for the experiment.
targets	object	The targets for the experiment.

list_experiments

Name	Datatype	Description
id	string	The ID of the experiment. (pattern: <code>[\S]+</code>)
arn	string	The Amazon Resource Name (ARN) of the experiment. (pattern: <code>[\S]+</code>)
creation_time	string (date-time)	The time that the experiment was created.
experiment_options	object	The experiment options for the experiment.
experiment_template_id	string	The ID of the experiment template. (pattern: <code>[\S]+</code>)
state	object	The state of the experiment.
tags	object	The tags for the experiment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_experiment	select	id, region		Gets information about the specified experiment.
list_experiments	select	region	maxResults, nextToken, experimentTemplateId	Lists your experiments.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the experiment.
region	string	AWS region (default: us-east-1)
experimentTemplateId	string	The ID of the experiment template.
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.

SELECT examples

get_experiment

Gets information about the specified experiment.

SELECT
id,
actions,
arn,
creation_time,
end_time,
experiment_options,
experiment_report,
experiment_report_configuration,
experiment_template_id,
log_configuration,
role_arn,
start_time,
state,
stop_conditions,
tags,
target_account_configurations_count,
targets
FROM aws.fis.experiments
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_experiments

Lists your experiments.

SELECT
id,
arn,
creation_time,
experiment_options,
experiment_template_id,
state,
tags
FROM aws.fis.experiments
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND experimentTemplateId = '{{ experimentTemplateId }}'
;