| 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.AddApplicationReferenceDataSource
Description
Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.
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' {}
- newAddApplicationReferenceDataSourceResponse :: Int -> AddApplicationReferenceDataSourceResponse
- addApplicationReferenceDataSourceResponse_applicationARN :: Lens' AddApplicationReferenceDataSourceResponse (Maybe Text)
- addApplicationReferenceDataSourceResponse_applicationVersionId :: Lens' AddApplicationReferenceDataSourceResponse (Maybe Natural)
- addApplicationReferenceDataSourceResponse_referenceDataSourceDescriptions :: Lens' AddApplicationReferenceDataSourceResponse (Maybe [ReferenceDataSourceDescription])
- 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 - The name of an existing application.
$sel:currentApplicationVersionId:AddApplicationReferenceDataSource', addApplicationReferenceDataSource_currentApplicationVersionId - The 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.
Kinesis Data 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.
Request Lenses
addApplicationReferenceDataSource_applicationName :: Lens' AddApplicationReferenceDataSource Text Source #
The name of an existing application.
addApplicationReferenceDataSource_currentApplicationVersionId :: Lens' AddApplicationReferenceDataSource Natural Source #
The 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. Kinesis Data 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.
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:applicationARN:AddApplicationReferenceDataSourceResponse', addApplicationReferenceDataSourceResponse_applicationARN - The application Amazon Resource Name (ARN).
$sel:applicationVersionId:AddApplicationReferenceDataSourceResponse', addApplicationReferenceDataSourceResponse_applicationVersionId - The updated application version ID. Kinesis Data Analytics increments
this ID when the application is updated.
$sel:referenceDataSourceDescriptions:AddApplicationReferenceDataSourceResponse', addApplicationReferenceDataSourceResponse_referenceDataSourceDescriptions - Describes reference data sources configured for the application.
$sel:httpStatus:AddApplicationReferenceDataSourceResponse', addApplicationReferenceDataSourceResponse_httpStatus - The response's http status code.
Response Lenses
addApplicationReferenceDataSourceResponse_applicationARN :: Lens' AddApplicationReferenceDataSourceResponse (Maybe Text) Source #
The application Amazon Resource Name (ARN).
addApplicationReferenceDataSourceResponse_applicationVersionId :: Lens' AddApplicationReferenceDataSourceResponse (Maybe Natural) Source #
The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
addApplicationReferenceDataSourceResponse_referenceDataSourceDescriptions :: Lens' AddApplicationReferenceDataSourceResponse (Maybe [ReferenceDataSourceDescription]) Source #
Describes reference data sources configured for the application.
addApplicationReferenceDataSourceResponse_httpStatus :: Lens' AddApplicationReferenceDataSourceResponse Int Source #
The response's http status code.