stop_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.ResourceNotFoundException