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.AddApplicationOutput

Contents

Description

Adds an external destination to your Amazon Kinesis Analytics application.

If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see Understanding Application Output (Destination) .

Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

For the limits on the number of application inputs and outputs you can configure, see Limits .

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Synopsis

Creating a Request

addApplicationOutput #

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

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

  • aaoApplicationName - Name of the application to which you want to add the output configuration.
  • aaoCurrentApplicationVersionId - Version of the application to which you want to add the output configuration. 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.
  • aaoOutput - An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.

data AddApplicationOutput #

See: addApplicationOutput smart constructor.

Instances

Eq AddApplicationOutput # 
Data AddApplicationOutput # 

Methods

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

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

toConstr :: AddApplicationOutput -> Constr #

dataTypeOf :: AddApplicationOutput -> DataType #

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

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

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

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

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

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

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

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

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

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

Read AddApplicationOutput # 
Show AddApplicationOutput # 
Generic AddApplicationOutput # 
Hashable AddApplicationOutput # 
ToJSON AddApplicationOutput # 
NFData AddApplicationOutput # 

Methods

rnf :: AddApplicationOutput -> () #

AWSRequest AddApplicationOutput # 
ToHeaders AddApplicationOutput # 
ToPath AddApplicationOutput # 
ToQuery AddApplicationOutput # 
type Rep AddApplicationOutput # 
type Rep AddApplicationOutput = D1 * (MetaData "AddApplicationOutput" "Network.AWS.KinesisAnalytics.AddApplicationOutput" "amazonka-kinesis-analytics-1.6.0-CdiLxSMgN2H9NTRoTSSuux" False) (C1 * (MetaCons "AddApplicationOutput'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_aaoApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_aaoCurrentApplicationVersionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat)) (S1 * (MetaSel (Just Symbol "_aaoOutput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Output)))))
type Rs AddApplicationOutput # 

Request Lenses

aaoApplicationName :: Lens' AddApplicationOutput Text #

Name of the application to which you want to add the output configuration.

aaoCurrentApplicationVersionId :: Lens' AddApplicationOutput Natural #

Version of the application to which you want to add the output configuration. 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.

aaoOutput :: Lens' AddApplicationOutput Output #

An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.

Destructuring the Response

addApplicationOutputResponse #

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

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

data AddApplicationOutputResponse #

See: addApplicationOutputResponse smart constructor.

Instances

Eq AddApplicationOutputResponse # 
Data AddApplicationOutputResponse # 

Methods

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

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

toConstr :: AddApplicationOutputResponse -> Constr #

dataTypeOf :: AddApplicationOutputResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

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

Response Lenses