| 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.KinesisAnalytics.StartApplication
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.
Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.
After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.
The application status must be READY for you to start an application.
You can get the application status in the console or using the
DescribeApplication
operation.
After you start the application, you can stop the application from processing the input by calling the StopApplication operation.
This operation requires permissions to perform the
kinesisanalytics:StartApplication action.
Synopsis
- data StartApplication = StartApplication' {}
- newStartApplication :: Text -> StartApplication
- startApplication_applicationName :: Lens' StartApplication Text
- startApplication_inputConfigurations :: Lens' StartApplication [InputConfiguration]
- data StartApplicationResponse = StartApplicationResponse' {
- httpStatus :: Int
- newStartApplicationResponse :: Int -> StartApplicationResponse
- startApplicationResponse_httpStatus :: Lens' StartApplicationResponse Int
Creating a Request
data StartApplication Source #
See: newStartApplication smart constructor.
Constructors
| StartApplication' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> StartApplication |
Create a value of StartApplication 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:applicationName:StartApplication', startApplication_applicationName - Name of the application.
$sel:inputConfigurations:StartApplication', startApplication_inputConfigurations - Identifies the specific input, by ID, that the application starts
consuming. Amazon Kinesis Analytics starts reading the streaming source
associated with the input. You can also specify where in the streaming
source you want Amazon Kinesis Analytics to start reading.
Request Lenses
startApplication_applicationName :: Lens' StartApplication Text Source #
Name of the application.
startApplication_inputConfigurations :: Lens' StartApplication [InputConfiguration] Source #
Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.
Destructuring the Response
data StartApplicationResponse Source #
See: newStartApplicationResponse smart constructor.
Constructors
| StartApplicationResponse' | |
Fields
| |
Instances
newStartApplicationResponse Source #
Create a value of StartApplicationResponse 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:StartApplicationResponse', startApplicationResponse_httpStatus - The response's http status code.
Response Lenses
startApplicationResponse_httpStatus :: Lens' StartApplicationResponse Int Source #
The response's http status code.