| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KinesisAnalytics.StopApplication
Description
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.
This operation requires permissions to perform the
kinesisanalytics:StopApplication action.
Synopsis
- data StopApplication = StopApplication' {}
- newStopApplication :: Text -> StopApplication
- 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:
StopApplication, stopApplication_applicationName - Name of the running application to stop.
Request Lenses
stopApplication_applicationName :: Lens' StopApplication Text Source #
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.