libZSservicesZSamazonka-kinesisanalyticsv2ZSamazonka-kinesisanalyticsv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data AddApplicationReferenceDataSource Source #

See: newAddApplicationReferenceDataSource smart constructor.

Constructors

AddApplicationReferenceDataSource' 

Fields

  • applicationName :: Text

    The name of an existing application.

  • currentApplicationVersionId :: Natural

    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.

  • referenceDataSource :: 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.

Instances

Instances details
Eq AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Read AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Show AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Generic AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Associated Types

type Rep AddApplicationReferenceDataSource :: Type -> Type #

NFData AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Hashable AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

ToJSON AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

AWSRequest AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

ToHeaders AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

ToPath AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

ToQuery AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

type Rep AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

type Rep AddApplicationReferenceDataSource = D1 ('MetaData "AddApplicationReferenceDataSource" "Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource" "libZSservicesZSamazonka-kinesisanalyticsv2ZSamazonka-kinesisanalyticsv2" 'False) (C1 ('MetaCons "AddApplicationReferenceDataSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "currentApplicationVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "referenceDataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReferenceDataSource))))
type AWSResponse AddApplicationReferenceDataSource Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

newAddApplicationReferenceDataSource Source #

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_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 #

Constructors

AddApplicationReferenceDataSourceResponse' 

Fields

Instances

Instances details
Eq AddApplicationReferenceDataSourceResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Read AddApplicationReferenceDataSourceResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Show AddApplicationReferenceDataSourceResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

Generic AddApplicationReferenceDataSourceResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

NFData AddApplicationReferenceDataSourceResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

type Rep AddApplicationReferenceDataSourceResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource

type Rep AddApplicationReferenceDataSourceResponse = D1 ('MetaData "AddApplicationReferenceDataSourceResponse" "Amazonka.KinesisAnalyticsV2.AddApplicationReferenceDataSource" "libZSservicesZSamazonka-kinesisanalyticsv2ZSamazonka-kinesisanalyticsv2" 'False) (C1 ('MetaCons "AddApplicationReferenceDataSourceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "referenceDataSourceDescriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReferenceDataSourceDescription])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAddApplicationReferenceDataSourceResponse Source #

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_applicationVersionId :: Lens' AddApplicationReferenceDataSourceResponse (Maybe Natural) Source #

The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.