Table of Contents
FIS.Client¶A low-level client representing AWS Fault Injection Simulator (FIS)
Fault Injection Simulator 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 Simulator User Guide .
import boto3
client = boto3.client('fis')
These are the available methods:
can_paginate()close()create_experiment_template()delete_experiment_template()get_action()get_experiment()get_experiment_template()get_paginator()get_target_resource_type()get_waiter()list_actions()list_experiment_templates()list_experiments()list_tags_for_resource()list_target_resource_types()start_experiment()stop_experiment()tag_resource()untag_resource()update_experiment_template()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_experiment_template(**kwargs)¶Creates an experiment template.
An experiment template includes the following components:
For more information, see Experiment templates in the Fault Injection Simulator User Guide .
See also: AWS API Documentation
Request Syntax
response = 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
}
)
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
A description for the experiment template.
[REQUIRED]
The stop conditions.
Specifies a stop condition for an experiment template.
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.
The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.
The targets for the experiment.
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 Simulator User Guide .
The resource type. The resource type must be supported for the specified action.
The Amazon Resource Names (ARNs) of the resources.
The tags for the target resources.
The filters to apply to identify target resources using specific attributes.
Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the Fault Injection Simulator User Guide .
The attribute path for the filter.
The attribute values for the filter.
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.
The resource type parameters.
[REQUIRED]
The actions for the experiment.
Specifies an action for an experiment template.
For more information, see Actions in the Fault Injection Simulator User Guide .
The ID of the action. The format of the action ID is: aws:service-name :action-type .
A description for the action.
The parameters for the action, if applicable.
The targets for the action.
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.
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
The tags to apply to the experiment template.
The configuration for experiment logging.
The configuration for experiment logging to Amazon CloudWatch Logs.
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
The configuration for experiment logging to Amazon S3.
The name of the destination bucket.
The bucket prefix.
The schema version.
dict
Response Syntax
{
'experimentTemplate': {
'id': '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
}
}
}
Response Structure
(dict) --
experimentTemplate (dict) --
Information about the experiment template.
id (string) --
The ID 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.
resourceTags (dict) --
The tags for the target resources.
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.
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
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.
targets (dict) --
The targets for the action.
startAfter (list) --
The name of the action that must be completed before the current action starts.
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.
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.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ConflictExceptionFIS.Client.exceptions.ResourceNotFoundExceptionFIS.Client.exceptions.ServiceQuotaExceededExceptiondelete_experiment_template(**kwargs)¶Deletes the specified experiment template.
See also: AWS API Documentation
Request Syntax
response = client.delete_experiment_template(
id='string'
)
[REQUIRED]
The ID of the experiment template.
{
'experimentTemplate': {
'id': '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
}
}
}
Response Structure
Information about the experiment template.
The ID of the experiment template.
The description for the experiment template.
The targets for the experiment.
Describes a target for an experiment template.
The resource type.
The Amazon Resource Names (ARNs) of the targets.
The tags for the target resources.
The filters to apply to identify target resources using specific attributes.
Describes a filter used for the target resources in an experiment template.
The attribute path for the filter.
The attribute values for the filter.
Scopes the identified resources to a specific count or percentage.
The resource type parameters.
The actions for the experiment.
Describes an action for an experiment template.
The ID of the action.
A description for the action.
The parameters for the action.
The targets for the action.
The name of the action that must be completed before the current action starts.
The stop conditions for the experiment.
Describes a stop condition for an experiment template.
The source for the stop condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
The time the experiment template was created.
The time the experiment template was last updated.
The Amazon Resource Name (ARN) of an IAM role.
The tags for the experiment template.
The configuration for experiment logging.
The configuration for experiment logging to Amazon CloudWatch Logs.
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
The configuration for experiment logging to Amazon S3.
The name of the destination bucket.
The bucket prefix.
The schema version.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ResourceNotFoundExceptionget_action(**kwargs)¶Gets information about the specified FIS action.
See also: AWS API Documentation
Request Syntax
response = client.get_action(
id='string'
)
[REQUIRED]
The ID of the action.
{
'action': {
'id': 'string',
'description': 'string',
'parameters': {
'string': {
'description': 'string',
'required': True|False
}
},
'targets': {
'string': {
'resourceType': 'string'
}
},
'tags': {
'string': 'string'
}
}
}
Response Structure
Information about the action.
The ID of the action.
The description for the action.
The action parameters, if applicable.
Describes a parameter for an action.
The parameter description.
Indicates whether the parameter is required.
The supported targets for the action.
Describes a target for an action.
The resource type of the target.
The tags for the action.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ResourceNotFoundExceptionget_experiment(**kwargs)¶Gets information about the specified experiment.
See also: AWS API Documentation
Request Syntax
response = client.get_experiment(
id='string'
)
[REQUIRED]
The ID of the experiment.
{
'experiment': {
'id': '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',
'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
}
}
}
Response Structure
Information about the experiment.
The ID of the experiment.
The ID of the experiment template.
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
The state of the experiment.
The state of the experiment.
The reason for the state.
The targets for the experiment.
Describes a target for an experiment.
The resource type.
The Amazon Resource Names (ARNs) of the resources.
The tags for the target resources.
The filters to apply to identify target resources using specific attributes.
Describes a filter used for the target resources in an experiment.
The attribute path for the filter.
The attribute values for the filter.
Scopes the identified resources to a specific count or percentage.
The resource type parameters.
The actions for the experiment.
Describes the action for an experiment.
The ID of the action.
The description for the action.
The parameters for the action.
The targets for the action.
The name of the action that must be completed before this action starts.
The state of the action.
The state of the action.
The reason for the state.
The time that the action started.
The time that the action ended.
The stop conditions for the experiment.
Describes the stop condition for an experiment.
The source for the stop condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
The time that the experiment was created.
The time that the experiment started.
The time that the experiment ended.
The tags for the experiment.
The configuration for experiment logging.
The configuration for experiment logging to Amazon CloudWatch Logs.
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
The configuration for experiment logging to Amazon S3.
The name of the destination bucket.
The bucket prefix.
The schema version.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ResourceNotFoundExceptionget_experiment_template(**kwargs)¶Gets information about the specified experiment template.
See also: AWS API Documentation
Request Syntax
response = client.get_experiment_template(
id='string'
)
[REQUIRED]
The ID of the experiment template.
{
'experimentTemplate': {
'id': '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
}
}
}
Response Structure
Information about the experiment template.
The ID of the experiment template.
The description for the experiment template.
The targets for the experiment.
Describes a target for an experiment template.
The resource type.
The Amazon Resource Names (ARNs) of the targets.
The tags for the target resources.
The filters to apply to identify target resources using specific attributes.
Describes a filter used for the target resources in an experiment template.
The attribute path for the filter.
The attribute values for the filter.
Scopes the identified resources to a specific count or percentage.
The resource type parameters.
The actions for the experiment.
Describes an action for an experiment template.
The ID of the action.
A description for the action.
The parameters for the action.
The targets for the action.
The name of the action that must be completed before the current action starts.
The stop conditions for the experiment.
Describes a stop condition for an experiment template.
The source for the stop condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
The time the experiment template was created.
The time the experiment template was last updated.
The Amazon Resource Name (ARN) of an IAM role.
The tags for the experiment template.
The configuration for experiment logging.
The configuration for experiment logging to Amazon CloudWatch Logs.
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
The configuration for experiment logging to Amazon S3.
The name of the destination bucket.
The bucket prefix.
The schema version.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_target_resource_type(**kwargs)¶Gets information about the specified resource type.
See also: AWS API Documentation
Request Syntax
response = client.get_target_resource_type(
resourceType='string'
)
[REQUIRED]
The resource type.
{
'targetResourceType': {
'resourceType': 'string',
'description': 'string',
'parameters': {
'string': {
'description': 'string',
'required': True|False
}
}
}
}
Response Structure
Information about the resource type.
The resource type.
A description of the resource type.
The parameters for the resource type.
Describes the parameters for a resource type. Use parameters to determine which tasks are identified during target resolution.
A description of the parameter.
Indicates whether the parameter is required.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ResourceNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_actions(**kwargs)¶Lists the available FIS actions.
See also: AWS API Documentation
Request Syntax
response = client.list_actions(
maxResults=123,
nextToken='string'
)
nextToken value.dict
Response Syntax
{
'actions': [
{
'id': '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.
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.
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.
Exceptions
FIS.Client.exceptions.ValidationExceptionlist_experiment_templates(**kwargs)¶Lists your experiment templates.
See also: AWS API Documentation
Request Syntax
response = client.list_experiment_templates(
maxResults=123,
nextToken='string'
)
nextToken value.dict
Response Syntax
{
'experimentTemplates': [
{
'id': '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.
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.
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.
Exceptions
FIS.Client.exceptions.ValidationExceptionlist_experiments(**kwargs)¶Lists your experiments.
See also: AWS API Documentation
Request Syntax
response = client.list_experiments(
maxResults=123,
nextToken='string'
)
nextToken value.dict
Response Syntax
{
'experiments': [
{
'id': 'string',
'experimentTemplateId': 'string',
'state': {
'status': 'pending'|'initiating'|'running'|'completed'|'stopping'|'stopped'|'failed',
'reason': 'string'
},
'creationTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
experiments (list) --
The experiments.
(dict) --
Provides a summary of an experiment.
id (string) --
The ID 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.
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.
Exceptions
FIS.Client.exceptions.ValidationExceptionLists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags for the resource.
list_target_resource_types(**kwargs)¶Lists the target resource types.
See also: AWS API Documentation
Request Syntax
response = client.list_target_resource_types(
maxResults=123,
nextToken='string'
)
nextToken value.dict
Response Syntax
{
'targetResourceTypes': [
{
'resourceType': 'string',
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
targetResourceTypes (list) --
The target resource types.
(dict) --
Describes a resource type.
resourceType (string) --
The resource type.
description (string) --
A description of the resource type.
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.
Exceptions
FIS.Client.exceptions.ValidationExceptionstart_experiment(**kwargs)¶Starts running an experiment from the specified experiment template.
See also: AWS API Documentation
Request Syntax
response = client.start_experiment(
clientToken='string',
experimentTemplateId='string',
tags={
'string': 'string'
}
)
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The ID of the experiment template.
The tags to apply to the experiment.
dict
Response Syntax
{
'experiment': {
'id': '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',
'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
}
}
}
Response Structure
(dict) --
experiment (dict) --
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 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.
resourceTags (dict) --
The tags for the target resources.
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.
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
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.
targets (dict) --
The targets for the action.
startAfter (list) --
The name of the action that must be completed before this action starts.
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.
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.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ConflictExceptionFIS.Client.exceptions.ResourceNotFoundExceptionFIS.Client.exceptions.ServiceQuotaExceededExceptionstop_experiment(**kwargs)¶Stops the specified experiment.
See also: AWS API Documentation
Request Syntax
response = client.stop_experiment(
id='string'
)
[REQUIRED]
The ID of the experiment.
{
'experiment': {
'id': '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',
'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
}
}
}
Response Structure
Information about the experiment.
The ID of the experiment.
The ID of the experiment template.
The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
The state of the experiment.
The state of the experiment.
The reason for the state.
The targets for the experiment.
Describes a target for an experiment.
The resource type.
The Amazon Resource Names (ARNs) of the resources.
The tags for the target resources.
The filters to apply to identify target resources using specific attributes.
Describes a filter used for the target resources in an experiment.
The attribute path for the filter.
The attribute values for the filter.
Scopes the identified resources to a specific count or percentage.
The resource type parameters.
The actions for the experiment.
Describes the action for an experiment.
The ID of the action.
The description for the action.
The parameters for the action.
The targets for the action.
The name of the action that must be completed before this action starts.
The state of the action.
The state of the action.
The reason for the state.
The time that the action started.
The time that the action ended.
The stop conditions for the experiment.
Describes the stop condition for an experiment.
The source for the stop condition.
The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.
The time that the experiment was created.
The time that the experiment started.
The time that the experiment ended.
The tags for the experiment.
The configuration for experiment logging.
The configuration for experiment logging to Amazon CloudWatch Logs.
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
The configuration for experiment logging to Amazon S3.
The name of the destination bucket.
The bucket prefix.
The schema version.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ResourceNotFoundExceptiontag_resource(**kwargs)¶Applies the specified tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tags for the resource.
dict
Response Syntax
{}
Response Structure
untag_resource(**kwargs)¶Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
The tag keys to remove.
dict
Response Syntax
{}
Response Structure
update_experiment_template(**kwargs)¶Updates the specified experiment template.
See also: AWS API Documentation
Request Syntax
response = 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
}
)
[REQUIRED]
The ID of the experiment template.
The stop conditions for the experiment.
Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.
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.
The Amazon Resource Name (ARN) of the CloudWatch alarm.
The targets for the experiment.
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.
The resource type. The resource type must be supported for the specified action.
The Amazon Resource Names (ARNs) of the targets.
The tags for the target resources.
The filters to apply to identify target resources using specific attributes.
Specifies a filter used for the target resource input in an experiment template.
For more information, see Resource filters in the Fault Injection Simulator User Guide .
The attribute path for the filter.
The attribute values for the filter.
Scopes the identified resources to a specific count or percentage.
The resource type parameters.
The actions for the experiment.
Specifies an action for an experiment template.
The ID of the action.
A description for the action.
The parameters for the action, if applicable.
The targets for the action.
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.
The configuration for experiment logging.
The configuration for experiment logging to Amazon CloudWatch Logs.
The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
The configuration for experiment logging to Amazon S3.
The name of the destination bucket.
The bucket prefix.
The schema version.
dict
Response Syntax
{
'experimentTemplate': {
'id': '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
}
}
}
Response Structure
(dict) --
experimentTemplate (dict) --
Information about the experiment template.
id (string) --
The ID 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.
resourceTags (dict) --
The tags for the target resources.
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.
selectionMode (string) --
Scopes the identified resources to a specific count or percentage.
parameters (dict) --
The resource type parameters.
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.
targets (dict) --
The targets for the action.
startAfter (list) --
The name of the action that must be completed before the current action starts.
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.
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.
Exceptions
FIS.Client.exceptions.ValidationExceptionFIS.Client.exceptions.ResourceNotFoundExceptionFIS.Client.exceptions.ServiceQuotaExceededExceptionThe available paginators are: