paws.analytics (version 0.1.11)

kinesisanalyticsv2_stop_application: Stops the application from processing data

Description

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 describe_application operation to find the application status.

Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set to true.

Usage

kinesisanalyticsv2_stop_application(ApplicationName, Force)

Arguments

ApplicationName

[required] The name of the running application to stop.

Force

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.

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.

Value

An empty list.

Request syntax

svc$stop_application(
  ApplicationName = "string",
  Force = TRUE|FALSE
)