StopApplication - Amazon Kinesis Analytics

StopApplication

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.

Request Syntax

{ "ApplicationName": "string", "Force": boolean }

Request Parameters

The request accepts the following data in JSON format.

ApplicationName

The name of the running application to stop.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

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.

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.

Type: Boolean

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

ConcurrentModificationException

Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

HTTP Status Code: 400

InvalidApplicationConfigurationException

The user-provided application configuration is not valid.

HTTP Status Code: 400

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

InvalidRequestException

The request JSON is not valid for the operation.

HTTP Status Code: 400

ResourceInUseException

The application is not available for this operation.

HTTP Status Code: 400

ResourceNotFoundException

Specified application can't be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: