| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisAnalyticsV2.StopApplication
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 DescribeApplication operation to find the application status.
Kinesis Data Analytics takes a snapshot when the application is stopped,
unless Force is set to true.
Synopsis
- data StopApplication = StopApplication' {
- force :: Maybe Bool
- applicationName :: Text
- newStopApplication :: Text -> StopApplication
- stopApplication_force :: Lens' StopApplication (Maybe Bool)
- stopApplication_applicationName :: Lens' StopApplication Text
- data StopApplicationResponse = StopApplicationResponse' {
- httpStatus :: Int
- newStopApplicationResponse :: Int -> StopApplicationResponse
- stopApplicationResponse_httpStatus :: Lens' StopApplicationResponse Int
Creating a Request
data StopApplication Source #
See: newStopApplication smart constructor.
Constructors
| StopApplication' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> StopApplication |
Create a value of StopApplication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:force:StopApplication', stopApplication_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.
$sel:applicationName:StopApplication', stopApplication_applicationName - The name of the running application to stop.
Request Lenses
stopApplication_force :: Lens' StopApplication (Maybe Bool) Source #
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.
stopApplication_applicationName :: Lens' StopApplication Text Source #
The name of the running application to stop.
Destructuring the Response
data StopApplicationResponse Source #
See: newStopApplicationResponse smart constructor.
Constructors
| StopApplicationResponse' | |
Fields
| |
Instances
newStopApplicationResponse Source #
Create a value of StopApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopApplicationResponse', stopApplicationResponse_httpStatus - The response's http status code.
Response Lenses
stopApplicationResponse_httpStatus :: Lens' StopApplicationResponse Int Source #
The response's http status code.