Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

addApplicationReferenceDataSource #

Arguments

:: Text	`aardsApplicationName`
-> Natural	`aardsCurrentApplicationVersionId`
-> ReferenceDataSource	`aardsReferenceDataSource`
-> 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 #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods (==) :: AddApplicationReferenceDataSource -> AddApplicationReferenceDataSource -> Bool # (/=) :: AddApplicationReferenceDataSource -> AddApplicationReferenceDataSource -> Bool #
Data AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.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 #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods readsPrec :: Int -> ReadS AddApplicationReferenceDataSource # readList :: ReadS [AddApplicationReferenceDataSource] # readPrec :: ReadPrec AddApplicationReferenceDataSource # readListPrec :: ReadPrec [AddApplicationReferenceDataSource] #
Show AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods showsPrec :: Int -> AddApplicationReferenceDataSource -> ShowS # show :: AddApplicationReferenceDataSource -> String # showList :: [AddApplicationReferenceDataSource] -> ShowS #
Generic AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Associated Types type Rep AddApplicationReferenceDataSource :: * -> * # Methods from :: AddApplicationReferenceDataSource -> Rep AddApplicationReferenceDataSource x # to :: Rep AddApplicationReferenceDataSource x -> AddApplicationReferenceDataSource #
Hashable AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods hashWithSalt :: Int -> AddApplicationReferenceDataSource -> Int # hash :: AddApplicationReferenceDataSource -> Int #
ToJSON AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods toJSON :: AddApplicationReferenceDataSource -> Value # toEncoding :: AddApplicationReferenceDataSource -> Encoding # toJSONList :: [AddApplicationReferenceDataSource] -> Value # toEncodingList :: [AddApplicationReferenceDataSource] -> Encoding #
AWSRequest AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Associated Types type Rs AddApplicationReferenceDataSource :: * # Methods request :: AddApplicationReferenceDataSource -> Request AddApplicationReferenceDataSource # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy AddApplicationReferenceDataSource -> ClientResponse -> m (Response AddApplicationReferenceDataSource) #
ToHeaders AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods toHeaders :: AddApplicationReferenceDataSource -> [Header] #
ToPath AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods toPath :: AddApplicationReferenceDataSource -> ByteString #
ToQuery AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods toQuery :: AddApplicationReferenceDataSource -> QueryString #
NFData AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods rnf :: AddApplicationReferenceDataSource -> () #
type Rep AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource type Rep AddApplicationReferenceDataSource = D1 (MetaData "AddApplicationReferenceDataSource" "Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource" "amazonka-kinesis-analytics-1.6.0-J4j3HlKETSB834VywMggVH" False) (C1 (MetaCons "AddApplicationReferenceDataSource'" PrefixI True) (S1 (MetaSel (Just "_aardsApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_aardsCurrentApplicationVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat) :: S1 (MetaSel (Just "_aardsReferenceDataSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ReferenceDataSource))))
type Rs AddApplicationReferenceDataSource #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource type Rs AddApplicationReferenceDataSource = AddApplicationReferenceDataSourceResponse

Request Lenses

aardsApplicationName :: Lens' AddApplicationReferenceDataSource Text #

Name of an existing application.

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 #

Arguments

:: Int	`aardsrsResponseStatus`
-> 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:

aardsrsResponseStatus - -- | The response status code.

data AddApplicationReferenceDataSourceResponse #

See: addApplicationReferenceDataSourceResponse smart constructor.

Instances

Eq AddApplicationReferenceDataSourceResponse #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods (==) :: AddApplicationReferenceDataSourceResponse -> AddApplicationReferenceDataSourceResponse -> Bool # (/=) :: AddApplicationReferenceDataSourceResponse -> AddApplicationReferenceDataSourceResponse -> Bool #
Data AddApplicationReferenceDataSourceResponse #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource 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 #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods readsPrec :: Int -> ReadS AddApplicationReferenceDataSourceResponse # readList :: ReadS [AddApplicationReferenceDataSourceResponse] # readPrec :: ReadPrec AddApplicationReferenceDataSourceResponse # readListPrec :: ReadPrec [AddApplicationReferenceDataSourceResponse] #
Show AddApplicationReferenceDataSourceResponse #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods showsPrec :: Int -> AddApplicationReferenceDataSourceResponse -> ShowS # show :: AddApplicationReferenceDataSourceResponse -> String # showList :: [AddApplicationReferenceDataSourceResponse] -> ShowS #
Generic AddApplicationReferenceDataSourceResponse #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Associated Types type Rep AddApplicationReferenceDataSourceResponse :: * -> * # Methods from :: AddApplicationReferenceDataSourceResponse -> Rep AddApplicationReferenceDataSourceResponse x # to :: Rep AddApplicationReferenceDataSourceResponse x -> AddApplicationReferenceDataSourceResponse #
NFData AddApplicationReferenceDataSourceResponse #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource Methods rnf :: AddApplicationReferenceDataSourceResponse -> () #
type Rep AddApplicationReferenceDataSourceResponse #
Instance details Defined in Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource type Rep AddApplicationReferenceDataSourceResponse = D1 (MetaData "AddApplicationReferenceDataSourceResponse" "Network.AWS.KinesisAnalytics.AddApplicationReferenceDataSource" "amazonka-kinesis-analytics-1.6.0-J4j3HlKETSB834VywMggVH" True) (C1 (MetaCons "AddApplicationReferenceDataSourceResponse'" PrefixI True) (S1 (MetaSel (Just "_aardsrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

aardsrsResponseStatus :: Lens' AddApplicationReferenceDataSourceResponse Int #

- | The response status code.