2022/01/20 - AWS Fault Injection Simulator - 3 updated api methods
Changes Added action startTime and action endTime timestamp fields to the ExperimentAction object
{'experiment': {'actions': {'endTime': 'timestamp', 'startTime': 'timestamp'}}}
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',
'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'
}
},
'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'
}
}
}
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.
(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.
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) --
{'experiment': {'actions': {'endTime': 'timestamp', 'startTime': 'timestamp'}}}
Starts running an experiment from the specified experiment template.
See also: AWS API Documentation
Request Syntax
client.start_experiment(
clientToken='string',
experimentTemplateId='string',
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 tags to apply to the experiment.
(string) --
(string) --
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'
}
},
'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'
}
}
}
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.
(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.
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) --
{'experiment': {'actions': {'endTime': 'timestamp', 'startTime': 'timestamp'}}}
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',
'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'
}
},
'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'
}
}
}
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.
(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.
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) --