KinesisAnalyticsV2.Client.
stop_application
(**kwargs)¶Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force
parameter to true
.
You can use the DescribeApplication operation to find the application status.
Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force
is set to true
.
See also: AWS API Documentation
Request Syntax
response = client.stop_application(
ApplicationName='string',
Force=True|False
)
[REQUIRED]
The name of the running application to stop.
Set to true
to force the application to stop. If you set Force
to true
, Kinesis Data Analytics stops the application without taking a snapshot.
Note
Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.
You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.
The application must be in the STARTING
, UPDATING
, STOPPING
, AUTOSCALING
, or RUNNING
status.
dict
Response Syntax
{}
Response Structure
Exceptions
KinesisAnalyticsV2.Client.exceptions.ResourceNotFoundException
KinesisAnalyticsV2.Client.exceptions.ResourceInUseException
KinesisAnalyticsV2.Client.exceptions.InvalidArgumentException
KinesisAnalyticsV2.Client.exceptions.InvalidRequestException
KinesisAnalyticsV2.Client.exceptions.InvalidApplicationConfigurationException
KinesisAnalyticsV2.Client.exceptions.ConcurrentModificationException