2024/03/14 - AWS Fault Injection Simulator - 11 updated api methods
Changes This release adds support for previewing target resources before running a FIS experiment. It also adds resource ARNs for actions, experiments, and experiment templates to API responses.
{'experimentTemplate': {'arn': 'string'}}
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.
See also: AWS API Documentation
Request Syntax
client.create_experiment_template(
clientToken='string',
description='string',
stopConditions=[
{
'source': 'string',
'value': 'string'
},
],
targets={
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
actions={
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
]
}
},
roleArn='string',
tags={
'string': 'string'
},
logConfiguration={
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
experimentOptions={
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip'
}
)
string
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
A description for the experiment template.
list
[REQUIRED]
The stop conditions.
(dict) --
Specifies a stop condition for an experiment template.
source (string) -- [REQUIRED]
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.
dict
The targets for the experiment.
(string) --
(dict) --
Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags.
For more information, see Targets in the Fault Injection Service User Guide.
resourceType (string) -- [REQUIRED]
The resource type. The resource type must be supported for the specified action.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the resources.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the Fault Injection Service User Guide.
path (string) -- [REQUIRED]
The attribute path for the filter.
values (list) -- [REQUIRED]
The attribute values for the filter.
(string) --
selectionMode (string) -- [REQUIRED]
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.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
dict
[REQUIRED]
The actions for the experiment.
(string) --
(dict) --
Specifies an action for an experiment template.
For more information, see Actions in the Fault Injection Service User Guide.
actionId (string) -- [REQUIRED]
The ID of the action. The format of the action ID is: aws:service-name:action-type.
description (string) --
A description for the action.
parameters (dict) --
The parameters for the action, if applicable.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
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.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
dict
The tags to apply to the experiment template.
(string) --
(string) --
dict
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) -- [REQUIRED]
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) -- [REQUIRED]
The schema version.
dict
The experiment options for the experiment template.
accountTargeting (string) --
Specifies the account targeting setting for experiment options.
emptyTargetResolutionMode (string) --
Specifies the empty target resolution mode for experiment options.
dict
Response Syntax
{
'experimentTemplate': {
'id': 'string',
'arn': 'string',
'description': 'string',
'targets': {
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
'actions': {
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
]
}
},
'stopConditions': [
{
'source': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'roleArn': 'string',
'tags': {
'string': 'string'
},
'logConfiguration': {
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip'
},
'targetAccountConfigurationsCount': 123
}
}
Response Structure
(dict) --
experimentTemplate (dict) --
Information about the experiment template.
id (string) --
The ID of the experiment template.
arn (string) --
The Amazon Resource Name (ARN) of the experiment template.
description (string) --
The description for the experiment template.
targets (dict) --
The targets for the experiment.
(string) --
(dict) --
Describes a target for an experiment template.
resourceType (string) --
The resource type.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the targets.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Describes a filter used for the target resources in an experiment template.
path (string) --
The attribute path for the filter.
values (list) --
The attribute values for the filter.
(string) --
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
actions (dict) --
The actions for the experiment.
(string) --
(dict) --
Describes an action for an experiment template.
actionId (string) --
The ID of the action.
description (string) --
A description for the action.
parameters (dict) --
The parameters for the action.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
The name of the action that must be completed before the current action starts.
(string) --
stopConditions (list) --
The stop conditions for the experiment.
(dict) --
Describes a stop condition for an experiment template.
source (string) --
The source for the stop condition.
value (string) --
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime (datetime) --
The time the experiment template was created.
lastUpdateTime (datetime) --
The time the experiment template was last updated.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role.
tags (dict) --
The tags for the experiment template.
(string) --
(string) --
logConfiguration (dict) --
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) --
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) --
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
experimentOptions (dict) --
The experiment options for an experiment template.
accountTargeting (string) --
The account targeting setting for an experiment template.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment template.
targetAccountConfigurationsCount (integer) --
The count of target account configurations for the experiment template.
{'experimentTemplate': {'arn': 'string'}}
Deletes the specified experiment template.
See also: AWS API Documentation
Request Syntax
client.delete_experiment_template(
id='string'
)
string
[REQUIRED]
The ID of the experiment template.
dict
Response Syntax
{
'experimentTemplate': {
'id': 'string',
'arn': 'string',
'description': 'string',
'targets': {
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
'actions': {
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
]
}
},
'stopConditions': [
{
'source': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'roleArn': 'string',
'tags': {
'string': 'string'
},
'logConfiguration': {
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip'
},
'targetAccountConfigurationsCount': 123
}
}
Response Structure
(dict) --
experimentTemplate (dict) --
Information about the experiment template.
id (string) --
The ID of the experiment template.
arn (string) --
The Amazon Resource Name (ARN) of the experiment template.
description (string) --
The description for the experiment template.
targets (dict) --
The targets for the experiment.
(string) --
(dict) --
Describes a target for an experiment template.
resourceType (string) --
The resource type.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the targets.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Describes a filter used for the target resources in an experiment template.
path (string) --
The attribute path for the filter.
values (list) --
The attribute values for the filter.
(string) --
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
actions (dict) --
The actions for the experiment.
(string) --
(dict) --
Describes an action for an experiment template.
actionId (string) --
The ID of the action.
description (string) --
A description for the action.
parameters (dict) --
The parameters for the action.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
The name of the action that must be completed before the current action starts.
(string) --
stopConditions (list) --
The stop conditions for the experiment.
(dict) --
Describes a stop condition for an experiment template.
source (string) --
The source for the stop condition.
value (string) --
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime (datetime) --
The time the experiment template was created.
lastUpdateTime (datetime) --
The time the experiment template was last updated.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role.
tags (dict) --
The tags for the experiment template.
(string) --
(string) --
logConfiguration (dict) --
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) --
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) --
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
experimentOptions (dict) --
The experiment options for an experiment template.
accountTargeting (string) --
The account targeting setting for an experiment template.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment template.
targetAccountConfigurationsCount (integer) --
The count of target account configurations for the experiment template.
{'action': {'arn': 'string'}}
Gets information about the specified FIS action.
See also: AWS API Documentation
Request Syntax
client.get_action(
id='string'
)
string
[REQUIRED]
The ID of the action.
dict
Response Syntax
{
'action': {
'id': 'string',
'arn': 'string',
'description': 'string',
'parameters': {
'string': {
'description': 'string',
'required': True|False
}
},
'targets': {
'string': {
'resourceType': 'string'
}
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
action (dict) --
Information about the action.
id (string) --
The ID of the action.
arn (string) --
The Amazon Resource Name (ARN) of the action.
description (string) --
The description for the action.
parameters (dict) --
The action parameters, if applicable.
(string) --
(dict) --
Describes a parameter for an action.
description (string) --
The parameter description.
required (boolean) --
Indicates whether the parameter is required.
targets (dict) --
The supported targets for the action.
(string) --
(dict) --
Describes a target for an action.
resourceType (string) --
The resource type of the target.
tags (dict) --
The tags for the action.
(string) --
(string) --
{'experiment': {'arn': 'string',
'experimentOptions': {'actionsMode': 'skip-all | run-all'}}}
Gets information about the specified experiment.
See also: AWS API Documentation
Request Syntax
client.get_experiment(
id='string'
)
string
[REQUIRED]
The ID of the experiment.
dict
Response Syntax
{
'experiment': {
'id': 'string',
'arn': 'string',
'experimentTemplateId': 'string',
'roleArn': 'string',
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
'reason': 'string'
},
'targets': {
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
'actions': {
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
],
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'cancelled'|'stopping'|'stopped'|'failed'|'skipped',
'reason': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
},
'stopConditions': [
{
'source': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'logConfiguration': {
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip',
'actionsMode': 'skip-all'|'run-all'
},
'targetAccountConfigurationsCount': 123
}
}
Response Structure
(dict) --
experiment (dict) --
Information about the experiment.
id (string) --
The ID of the experiment.
arn (string) --
The Amazon Resource Name (ARN) 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 FIS service permission to perform service actions on your behalf.
state (dict) --
The state of the experiment.
status (string) --
The state of the experiment.
reason (string) --
The reason for the state.
targets (dict) --
The targets for the experiment.
(string) --
(dict) --
Describes a target for an experiment.
resourceType (string) --
The resource type.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the resources.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Describes a filter used for the target resources in an experiment.
path (string) --
The attribute path for the filter.
values (list) --
The attribute values for the filter.
(string) --
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
actions (dict) --
The actions for the experiment.
(string) --
(dict) --
Describes the action for an experiment.
actionId (string) --
The ID of the action.
description (string) --
The description for the action.
parameters (dict) --
The parameters for the action.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
The name of the action that must be completed before this action starts.
(string) --
state (dict) --
The state of the action.
status (string) --
The state of the action.
reason (string) --
The reason for the state.
startTime (datetime) --
The time that the action started.
endTime (datetime) --
The time that the action ended.
stopConditions (list) --
The stop conditions for the experiment.
(dict) --
Describes the stop condition for an experiment.
source (string) --
The source for the stop condition.
value (string) --
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime (datetime) --
The time that the experiment was created.
startTime (datetime) --
The time that the experiment started.
endTime (datetime) --
The time that the experiment ended.
tags (dict) --
The tags for the experiment.
(string) --
(string) --
logConfiguration (dict) --
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) --
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) --
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
experimentOptions (dict) --
The experiment options for the experiment.
accountTargeting (string) --
The account targeting setting for an experiment.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment.
actionsMode (string) --
The actions mode of the experiment that is set from the StartExperiment API command.
targetAccountConfigurationsCount (integer) --
The count of target account configurations for the experiment.
{'experimentTemplate': {'arn': 'string'}}
Gets information about the specified experiment template.
See also: AWS API Documentation
Request Syntax
client.get_experiment_template(
id='string'
)
string
[REQUIRED]
The ID of the experiment template.
dict
Response Syntax
{
'experimentTemplate': {
'id': 'string',
'arn': 'string',
'description': 'string',
'targets': {
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
'actions': {
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
]
}
},
'stopConditions': [
{
'source': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'roleArn': 'string',
'tags': {
'string': 'string'
},
'logConfiguration': {
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip'
},
'targetAccountConfigurationsCount': 123
}
}
Response Structure
(dict) --
experimentTemplate (dict) --
Information about the experiment template.
id (string) --
The ID of the experiment template.
arn (string) --
The Amazon Resource Name (ARN) of the experiment template.
description (string) --
The description for the experiment template.
targets (dict) --
The targets for the experiment.
(string) --
(dict) --
Describes a target for an experiment template.
resourceType (string) --
The resource type.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the targets.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Describes a filter used for the target resources in an experiment template.
path (string) --
The attribute path for the filter.
values (list) --
The attribute values for the filter.
(string) --
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
actions (dict) --
The actions for the experiment.
(string) --
(dict) --
Describes an action for an experiment template.
actionId (string) --
The ID of the action.
description (string) --
A description for the action.
parameters (dict) --
The parameters for the action.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
The name of the action that must be completed before the current action starts.
(string) --
stopConditions (list) --
The stop conditions for the experiment.
(dict) --
Describes a stop condition for an experiment template.
source (string) --
The source for the stop condition.
value (string) --
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime (datetime) --
The time the experiment template was created.
lastUpdateTime (datetime) --
The time the experiment template was last updated.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role.
tags (dict) --
The tags for the experiment template.
(string) --
(string) --
logConfiguration (dict) --
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) --
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) --
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
experimentOptions (dict) --
The experiment options for an experiment template.
accountTargeting (string) --
The account targeting setting for an experiment template.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment template.
targetAccountConfigurationsCount (integer) --
The count of target account configurations for the experiment template.
{'actions': {'arn': 'string'}}
Lists the available FIS actions.
See also: AWS API Documentation
Request Syntax
client.list_actions(
maxResults=123,
nextToken='string'
)
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.
string
The token for the next page of results.
dict
Response Syntax
{
'actions': [
{
'id': 'string',
'arn': 'string',
'description': 'string',
'targets': {
'string': {
'resourceType': 'string'
}
},
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
actions (list) --
The actions.
(dict) --
Provides a summary of an action.
id (string) --
The ID of the action.
arn (string) --
The Amazon Resource Name (ARN) of the action.
description (string) --
The description for the action.
targets (dict) --
The targets for the action.
(string) --
(dict) --
Describes a target for an action.
resourceType (string) --
The resource type of the target.
tags (dict) --
The tags for the action.
(string) --
(string) --
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.
{'experimentTemplates': {'arn': 'string'}}
Lists your experiment templates.
See also: AWS API Documentation
Request Syntax
client.list_experiment_templates(
maxResults=123,
nextToken='string'
)
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.
string
The token for the next page of results.
dict
Response Syntax
{
'experimentTemplates': [
{
'id': 'string',
'arn': 'string',
'description': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
experimentTemplates (list) --
The experiment templates.
(dict) --
Provides a summary of an experiment template.
id (string) --
The ID of the experiment template.
arn (string) --
The Amazon Resource Name (ARN) of the experiment template.
description (string) --
The description of the experiment template.
creationTime (datetime) --
The time that the experiment template was created.
lastUpdateTime (datetime) --
The time that the experiment template was last updated.
tags (dict) --
The tags for the experiment template.
(string) --
(string) --
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.
{'experimentTemplateId': 'string'}
Response {'experiments': {'arn': 'string',
'experimentOptions': {'accountTargeting': 'single-account | '
'multi-account',
'actionsMode': 'skip-all | run-all',
'emptyTargetResolutionMode': 'fail | '
'skip'}}}
Lists your experiments.
See also: AWS API Documentation
Request Syntax
client.list_experiments(
maxResults=123,
nextToken='string',
experimentTemplateId='string'
)
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.
string
The token for the next page of results.
string
The ID of the experiment template.
dict
Response Syntax
{
'experiments': [
{
'id': 'string',
'arn': 'string',
'experimentTemplateId': 'string',
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
'reason': 'string'
},
'creationTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip',
'actionsMode': 'skip-all'|'run-all'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
experiments (list) --
The experiments.
(dict) --
Provides a summary of an experiment.
id (string) --
The ID of the experiment.
arn (string) --
The Amazon Resource Name (ARN) of the experiment.
experimentTemplateId (string) --
The ID of the experiment template.
state (dict) --
The state of the experiment.
status (string) --
The state of the experiment.
reason (string) --
The reason for the state.
creationTime (datetime) --
The time that the experiment was created.
tags (dict) --
The tags for the experiment.
(string) --
(string) --
experimentOptions (dict) --
The experiment options for the experiment.
accountTargeting (string) --
The account targeting setting for an experiment.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment.
actionsMode (string) --
The actions mode of the experiment that is set from the StartExperiment API command.
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.
{'experimentOptions': {'actionsMode': 'skip-all | run-all'}}
Response {'experiment': {'arn': 'string',
'experimentOptions': {'actionsMode': 'skip-all | run-all'}}}
Starts running an experiment from the specified experiment template.
See also: AWS API Documentation
Request Syntax
client.start_experiment(
clientToken='string',
experimentTemplateId='string',
experimentOptions={
'actionsMode': 'skip-all'|'run-all'
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the experiment template.
dict
The experiment options for running the experiment.
actionsMode (string) --
Specifies the actions mode for experiment options.
dict
The tags to apply to the experiment.
(string) --
(string) --
dict
Response Syntax
{
'experiment': {
'id': 'string',
'arn': 'string',
'experimentTemplateId': 'string',
'roleArn': 'string',
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
'reason': 'string'
},
'targets': {
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
'actions': {
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
],
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'cancelled'|'stopping'|'stopped'|'failed'|'skipped',
'reason': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
},
'stopConditions': [
{
'source': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'logConfiguration': {
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip',
'actionsMode': 'skip-all'|'run-all'
},
'targetAccountConfigurationsCount': 123
}
}
Response Structure
(dict) --
experiment (dict) --
Information about the experiment.
id (string) --
The ID of the experiment.
arn (string) --
The Amazon Resource Name (ARN) 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 FIS service permission to perform service actions on your behalf.
state (dict) --
The state of the experiment.
status (string) --
The state of the experiment.
reason (string) --
The reason for the state.
targets (dict) --
The targets for the experiment.
(string) --
(dict) --
Describes a target for an experiment.
resourceType (string) --
The resource type.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the resources.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Describes a filter used for the target resources in an experiment.
path (string) --
The attribute path for the filter.
values (list) --
The attribute values for the filter.
(string) --
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
actions (dict) --
The actions for the experiment.
(string) --
(dict) --
Describes the action for an experiment.
actionId (string) --
The ID of the action.
description (string) --
The description for the action.
parameters (dict) --
The parameters for the action.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
The name of the action that must be completed before this action starts.
(string) --
state (dict) --
The state of the action.
status (string) --
The state of the action.
reason (string) --
The reason for the state.
startTime (datetime) --
The time that the action started.
endTime (datetime) --
The time that the action ended.
stopConditions (list) --
The stop conditions for the experiment.
(dict) --
Describes the stop condition for an experiment.
source (string) --
The source for the stop condition.
value (string) --
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime (datetime) --
The time that the experiment was created.
startTime (datetime) --
The time that the experiment started.
endTime (datetime) --
The time that the experiment ended.
tags (dict) --
The tags for the experiment.
(string) --
(string) --
logConfiguration (dict) --
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) --
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) --
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
experimentOptions (dict) --
The experiment options for the experiment.
accountTargeting (string) --
The account targeting setting for an experiment.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment.
actionsMode (string) --
The actions mode of the experiment that is set from the StartExperiment API command.
targetAccountConfigurationsCount (integer) --
The count of target account configurations for the experiment.
{'experiment': {'arn': 'string',
'experimentOptions': {'actionsMode': 'skip-all | run-all'}}}
Stops the specified experiment.
See also: AWS API Documentation
Request Syntax
client.stop_experiment(
id='string'
)
string
[REQUIRED]
The ID of the experiment.
dict
Response Syntax
{
'experiment': {
'id': 'string',
'arn': 'string',
'experimentTemplateId': 'string',
'roleArn': 'string',
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
'reason': 'string'
},
'targets': {
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
'actions': {
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
],
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'cancelled'|'stopping'|'stopped'|'failed'|'skipped',
'reason': 'string'
},
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
},
'stopConditions': [
{
'source': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'logConfiguration': {
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip',
'actionsMode': 'skip-all'|'run-all'
},
'targetAccountConfigurationsCount': 123
}
}
Response Structure
(dict) --
experiment (dict) --
Information about the experiment.
id (string) --
The ID of the experiment.
arn (string) --
The Amazon Resource Name (ARN) 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 FIS service permission to perform service actions on your behalf.
state (dict) --
The state of the experiment.
status (string) --
The state of the experiment.
reason (string) --
The reason for the state.
targets (dict) --
The targets for the experiment.
(string) --
(dict) --
Describes a target for an experiment.
resourceType (string) --
The resource type.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the resources.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Describes a filter used for the target resources in an experiment.
path (string) --
The attribute path for the filter.
values (list) --
The attribute values for the filter.
(string) --
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
actions (dict) --
The actions for the experiment.
(string) --
(dict) --
Describes the action for an experiment.
actionId (string) --
The ID of the action.
description (string) --
The description for the action.
parameters (dict) --
The parameters for the action.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
The name of the action that must be completed before this action starts.
(string) --
state (dict) --
The state of the action.
status (string) --
The state of the action.
reason (string) --
The reason for the state.
startTime (datetime) --
The time that the action started.
endTime (datetime) --
The time that the action ended.
stopConditions (list) --
The stop conditions for the experiment.
(dict) --
Describes the stop condition for an experiment.
source (string) --
The source for the stop condition.
value (string) --
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime (datetime) --
The time that the experiment was created.
startTime (datetime) --
The time that the experiment started.
endTime (datetime) --
The time that the experiment ended.
tags (dict) --
The tags for the experiment.
(string) --
(string) --
logConfiguration (dict) --
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) --
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) --
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
experimentOptions (dict) --
The experiment options for the experiment.
accountTargeting (string) --
The account targeting setting for an experiment.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment.
actionsMode (string) --
The actions mode of the experiment that is set from the StartExperiment API command.
targetAccountConfigurationsCount (integer) --
The count of target account configurations for the experiment.
{'experimentTemplate': {'arn': 'string'}}
Updates the specified experiment template.
See also: AWS API Documentation
Request Syntax
client.update_experiment_template(
id='string',
description='string',
stopConditions=[
{
'source': 'string',
'value': 'string'
},
],
targets={
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
actions={
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
]
}
},
roleArn='string',
logConfiguration={
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
experimentOptions={
'emptyTargetResolutionMode': 'fail'|'skip'
}
)
string
[REQUIRED]
The ID of the experiment template.
string
A description for the template.
list
The stop conditions for the experiment.
(dict) --
Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.
source (string) -- [REQUIRED]
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.
dict
The targets for the experiment.
(string) --
(dict) --
Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both.
resourceType (string) -- [REQUIRED]
The resource type. The resource type must be supported for the specified action.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the targets.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the Fault Injection Service User Guide.
path (string) -- [REQUIRED]
The attribute path for the filter.
values (list) -- [REQUIRED]
The attribute values for the filter.
(string) --
selectionMode (string) -- [REQUIRED]
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
dict
The actions for the experiment.
(string) --
(dict) --
Specifies an action for an experiment template.
actionId (string) --
The ID of the action.
description (string) --
A description for the action.
parameters (dict) --
The parameters for the action, if applicable.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
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.
(string) --
string
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
dict
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) -- [REQUIRED]
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
dict
The experiment options for the experiment template.
emptyTargetResolutionMode (string) --
The empty target resolution mode of the experiment template.
dict
Response Syntax
{
'experimentTemplate': {
'id': 'string',
'arn': 'string',
'description': 'string',
'targets': {
'string': {
'resourceType': 'string',
'resourceArns': [
'string',
],
'resourceTags': {
'string': 'string'
},
'filters': [
{
'path': 'string',
'values': [
'string',
]
},
],
'selectionMode': 'string',
'parameters': {
'string': 'string'
}
}
},
'actions': {
'string': {
'actionId': 'string',
'description': 'string',
'parameters': {
'string': 'string'
},
'targets': {
'string': 'string'
},
'startAfter': [
'string',
]
}
},
'stopConditions': [
{
'source': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdateTime': datetime(2015, 1, 1),
'roleArn': 'string',
'tags': {
'string': 'string'
},
'logConfiguration': {
'cloudWatchLogsConfiguration': {
'logGroupArn': 'string'
},
's3Configuration': {
'bucketName': 'string',
'prefix': 'string'
},
'logSchemaVersion': 123
},
'experimentOptions': {
'accountTargeting': 'single-account'|'multi-account',
'emptyTargetResolutionMode': 'fail'|'skip'
},
'targetAccountConfigurationsCount': 123
}
}
Response Structure
(dict) --
experimentTemplate (dict) --
Information about the experiment template.
id (string) --
The ID of the experiment template.
arn (string) --
The Amazon Resource Name (ARN) of the experiment template.
description (string) --
The description for the experiment template.
targets (dict) --
The targets for the experiment.
(string) --
(dict) --
Describes a target for an experiment template.
resourceType (string) --
The resource type.
resourceArns (list) --
The Amazon Resource Names (ARNs) of the targets.
(string) --
resourceTags (dict) --
The tags for the target resources.
(string) --
(string) --
filters (list) --
The filters to apply to identify target resources using specific attributes.
(dict) --
Describes a filter used for the target resources in an experiment template.
path (string) --
The attribute path for the filter.
values (list) --
The attribute values for the filter.
(string) --
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
(string) --
(string) --
actions (dict) --
The actions for the experiment.
(string) --
(dict) --
Describes an action for an experiment template.
actionId (string) --
The ID of the action.
description (string) --
A description for the action.
parameters (dict) --
The parameters for the action.
(string) --
(string) --
targets (dict) --
The targets for the action.
(string) --
(string) --
startAfter (list) --
The name of the action that must be completed before the current action starts.
(string) --
stopConditions (list) --
The stop conditions for the experiment.
(dict) --
Describes a stop condition for an experiment template.
source (string) --
The source for the stop condition.
value (string) --
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
creationTime (datetime) --
The time the experiment template was created.
lastUpdateTime (datetime) --
The time the experiment template was last updated.
roleArn (string) --
The Amazon Resource Name (ARN) of an IAM role.
tags (dict) --
The tags for the experiment template.
(string) --
(string) --
logConfiguration (dict) --
The configuration for experiment logging.
cloudWatchLogsConfiguration (dict) --
The configuration for experiment logging to Amazon CloudWatch Logs.
logGroupArn (string) --
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
s3Configuration (dict) --
The configuration for experiment logging to Amazon S3.
bucketName (string) --
The name of the destination bucket.
prefix (string) --
The bucket prefix.
logSchemaVersion (integer) --
The schema version.
experimentOptions (dict) --
The experiment options for an experiment template.
accountTargeting (string) --
The account targeting setting for an experiment template.
emptyTargetResolutionMode (string) --
The empty target resolution mode for an experiment template.
targetAccountConfigurationsCount (integer) --
The count of target account configurations for the experiment template.