amazonka-kinesis-analytics-1.6.0: Amazon Kinesis Analytics SDK.

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

Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource

Contents

Description

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

Creating a Request

addApplicationReferenceDataSource #

Creates a value of AddApplicationReferenceDataSource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • aardsApplicationName - Name of an existing application.
  • aardsCurrentApplicationVersionId - 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.
  • aardsReferenceDataSource - 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.

data AddApplicationReferenceDataSource #

See: addApplicationReferenceDataSource smart constructor.

Instances

Eq AddApplicationReferenceDataSource # 
Data AddApplicationReferenceDataSource # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AddApplicationReferenceDataSource -> c AddApplicationReferenceDataSource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AddApplicationReferenceDataSource #

toConstr :: AddApplicationReferenceDataSource -> Constr #

dataTypeOf :: AddApplicationReferenceDataSource -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AddApplicationReferenceDataSource) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AddApplicationReferenceDataSource) #

gmapT :: (forall b. Data b => b -> b) -> AddApplicationReferenceDataSource -> AddApplicationReferenceDataSource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AddApplicationReferenceDataSource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AddApplicationReferenceDataSource -> r #

gmapQ :: (forall d. Data d => d -> u) -> AddApplicationReferenceDataSource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AddApplicationReferenceDataSource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AddApplicationReferenceDataSource -> m AddApplicationReferenceDataSource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AddApplicationReferenceDataSource -> m AddApplicationReferenceDataSource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AddApplicationReferenceDataSource -> m AddApplicationReferenceDataSource #

Read AddApplicationReferenceDataSource # 
Show AddApplicationReferenceDataSource # 
Generic AddApplicationReferenceDataSource # 
Hashable AddApplicationReferenceDataSource # 
ToJSON AddApplicationReferenceDataSource # 
NFData AddApplicationReferenceDataSource # 
AWSRequest AddApplicationReferenceDataSource # 
ToHeaders AddApplicationReferenceDataSource # 
ToPath AddApplicationReferenceDataSource # 
ToQuery AddApplicationReferenceDataSource # 
type Rep AddApplicationReferenceDataSource # 
type Rep AddApplicationReferenceDataSource = D1 * (MetaData "AddApplicationReferenceDataSource" "Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource" "amazonka-kinesis-analytics-1.6.0-CdiLxSMgN2H9NTRoTSSuux" False) (C1 * (MetaCons "AddApplicationReferenceDataSource'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_aardsApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_aardsCurrentApplicationVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat)) (S1 * (MetaSel (Just Symbol "_aardsReferenceDataSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ReferenceDataSource)))))
type Rs AddApplicationReferenceDataSource # 

Request Lenses

aardsCurrentApplicationVersionId :: Lens' AddApplicationReferenceDataSource Natural #

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.

aardsReferenceDataSource :: Lens' 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.

Destructuring the Response

addApplicationReferenceDataSourceResponse #

Creates a value of AddApplicationReferenceDataSourceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data AddApplicationReferenceDataSourceResponse #

Instances

Eq AddApplicationReferenceDataSourceResponse # 
Data AddApplicationReferenceDataSourceResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AddApplicationReferenceDataSourceResponse -> c AddApplicationReferenceDataSourceResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AddApplicationReferenceDataSourceResponse #

toConstr :: AddApplicationReferenceDataSourceResponse -> Constr #

dataTypeOf :: AddApplicationReferenceDataSourceResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AddApplicationReferenceDataSourceResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AddApplicationReferenceDataSourceResponse) #

gmapT :: (forall b. Data b => b -> b) -> AddApplicationReferenceDataSourceResponse -> AddApplicationReferenceDataSourceResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AddApplicationReferenceDataSourceResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AddApplicationReferenceDataSourceResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> AddApplicationReferenceDataSourceResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AddApplicationReferenceDataSourceResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AddApplicationReferenceDataSourceResponse -> m AddApplicationReferenceDataSourceResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AddApplicationReferenceDataSourceResponse -> m AddApplicationReferenceDataSourceResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AddApplicationReferenceDataSourceResponse -> m AddApplicationReferenceDataSourceResponse #

Read AddApplicationReferenceDataSourceResponse # 
Show AddApplicationReferenceDataSourceResponse # 
Generic AddApplicationReferenceDataSourceResponse # 
NFData AddApplicationReferenceDataSourceResponse # 
type Rep AddApplicationReferenceDataSourceResponse # 
type Rep AddApplicationReferenceDataSourceResponse = D1 * (MetaData "AddApplicationReferenceDataSourceResponse" "Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource" "amazonka-kinesis-analytics-1.6.0-CdiLxSMgN2H9NTRoTSSuux" True) (C1 * (MetaCons "AddApplicationReferenceDataSourceResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_aardsrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses