| 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.AddApplicationReferenceDataSource
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 a reference data source to an existing application.
Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.
For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.
This operation requires permissions to perform the
kinesisanalytics:AddApplicationOutput action.
Synopsis
- data AddApplicationReferenceDataSource = AddApplicationReferenceDataSource' {}
- newAddApplicationReferenceDataSource :: Text -> Natural -> ReferenceDataSource -> AddApplicationReferenceDataSource
- addApplicationReferenceDataSource_applicationName :: Lens' AddApplicationReferenceDataSource Text
- addApplicationReferenceDataSource_currentApplicationVersionId :: Lens' AddApplicationReferenceDataSource Natural
- addApplicationReferenceDataSource_referenceDataSource :: Lens' AddApplicationReferenceDataSource ReferenceDataSource
- data AddApplicationReferenceDataSourceResponse = AddApplicationReferenceDataSourceResponse' {
- httpStatus :: Int
- newAddApplicationReferenceDataSourceResponse :: Int -> AddApplicationReferenceDataSourceResponse
- addApplicationReferenceDataSourceResponse_httpStatus :: Lens' AddApplicationReferenceDataSourceResponse Int
Creating a Request
data AddApplicationReferenceDataSource Source #
See: newAddApplicationReferenceDataSource smart constructor.
Constructors
| AddApplicationReferenceDataSource' | |
Fields
| |
Instances
newAddApplicationReferenceDataSource Source #
Arguments
| :: Text | |
| -> Natural |
|
| -> ReferenceDataSource | |
| -> AddApplicationReferenceDataSource |
Create a value of AddApplicationReferenceDataSource 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:AddApplicationReferenceDataSource', addApplicationReferenceDataSource_applicationName - Name of an existing application.
$sel:currentApplicationVersionId:AddApplicationReferenceDataSource', addApplicationReferenceDataSource_currentApplicationVersionId - Version of the application for which you are adding the reference data
source. 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:referenceDataSource:AddApplicationReferenceDataSource', addApplicationReferenceDataSource_referenceDataSource - The reference data source can be an object in your Amazon S3 bucket.
Amazon Kinesis Analytics reads the object and copies the data into the
in-application table that is created. You provide an S3 bucket, object
key name, and the resulting in-application table that is created. You
must also provide an IAM role with the necessary permissions that Amazon
Kinesis Analytics can assume to read the object from your S3 bucket on
your behalf.
Request Lenses
addApplicationReferenceDataSource_applicationName :: Lens' AddApplicationReferenceDataSource Text Source #
Name of an existing application.
addApplicationReferenceDataSource_currentApplicationVersionId :: Lens' AddApplicationReferenceDataSource Natural Source #
Version of the application for which you are adding the reference data
source. 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.
addApplicationReferenceDataSource_referenceDataSource :: Lens' AddApplicationReferenceDataSource ReferenceDataSource Source #
The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.
Destructuring the Response
data AddApplicationReferenceDataSourceResponse Source #
See: newAddApplicationReferenceDataSourceResponse smart constructor.
Constructors
| AddApplicationReferenceDataSourceResponse' | |
Fields
| |
Instances
newAddApplicationReferenceDataSourceResponse Source #
Arguments
| :: Int | |
| -> AddApplicationReferenceDataSourceResponse |
Create a value of AddApplicationReferenceDataSourceResponse 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:AddApplicationReferenceDataSourceResponse', addApplicationReferenceDataSourceResponse_httpStatus - The response's http status code.
Response Lenses
addApplicationReferenceDataSourceResponse_httpStatus :: Lens' AddApplicationReferenceDataSourceResponse Int Source #
The response's http status code.