| 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.AddApplicationOutput
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.
Adds an external destination to your Amazon Kinesis Analytics application.
If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination).
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
For the limits on the number of application inputs and outputs you can configure, see Limits.
This operation requires permissions to perform the
kinesisanalytics:AddApplicationOutput action.
Synopsis
- data AddApplicationOutput = AddApplicationOutput' {}
- newAddApplicationOutput :: Text -> Natural -> Output -> AddApplicationOutput
- addApplicationOutput_applicationName :: Lens' AddApplicationOutput Text
- addApplicationOutput_currentApplicationVersionId :: Lens' AddApplicationOutput Natural
- addApplicationOutput_output :: Lens' AddApplicationOutput Output
- data AddApplicationOutputResponse = AddApplicationOutputResponse' {
- httpStatus :: Int
- newAddApplicationOutputResponse :: Int -> AddApplicationOutputResponse
- addApplicationOutputResponse_httpStatus :: Lens' AddApplicationOutputResponse Int
Creating a Request
data AddApplicationOutput Source #
See: newAddApplicationOutput smart constructor.
Constructors
| AddApplicationOutput' | |
Fields
| |
Instances
newAddApplicationOutput Source #
Arguments
| :: Text | |
| -> Natural | |
| -> Output | |
| -> AddApplicationOutput |
Create a value of AddApplicationOutput 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:AddApplicationOutput', addApplicationOutput_applicationName - Name of the application to which you want to add the output
configuration.
$sel:currentApplicationVersionId:AddApplicationOutput', addApplicationOutput_currentApplicationVersionId - Version of the application to which you want to add the output
configuration. You can use the
DescribeApplication
operation to get the current application version. If the version
specified is not the current version, the
ConcurrentModificationException is returned.
$sel:output:AddApplicationOutput', addApplicationOutput_output - An array of objects, each describing one output configuration. In the
output configuration, you specify the name of an in-application stream,
a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis
Firehose delivery stream, or an AWS Lambda function), and record the
formation to use when writing to the destination.
Request Lenses
addApplicationOutput_applicationName :: Lens' AddApplicationOutput Text Source #
Name of the application to which you want to add the output configuration.
addApplicationOutput_currentApplicationVersionId :: Lens' AddApplicationOutput Natural Source #
Version of the application to which you want to add the output
configuration. You can use the
DescribeApplication
operation to get the current application version. If the version
specified is not the current version, the
ConcurrentModificationException is returned.
addApplicationOutput_output :: Lens' AddApplicationOutput Output Source #
An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
Destructuring the Response
data AddApplicationOutputResponse Source #
See: newAddApplicationOutputResponse smart constructor.
Constructors
| AddApplicationOutputResponse' | |
Fields
| |
Instances
newAddApplicationOutputResponse Source #
Create a value of AddApplicationOutputResponse 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:AddApplicationOutputResponse', addApplicationOutputResponse_httpStatus - The response's http status code.
Response Lenses
addApplicationOutputResponse_httpStatus :: Lens' AddApplicationOutputResponse Int Source #
The response's http status code.