Network.AWS.KinesisAnalytics.CreateApplication

Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works .

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.

To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.

For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started .

Creating a Request

createApplication

Arguments

:: Text

caApplicationName

-> CreateApplication

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

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

• caApplicationDescription - Summary description of the application.
• caInputs - Use this parameter to configure the application input. You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table). For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf. To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
• caCloudWatchLoggingOptions - Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs .
• caOutputs - You can configure application output to write data from any of the in-application streams to up to five destinations. These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, or both. In the configuration, you specify the in-application stream name, the destination stream Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. In the output configuration, you also provide the output stream Amazon Resource Name (ARN) and the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to this stream on your behalf.
• caApplicationCode - One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more inforamtion about the typical pattern, see Application Code . You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps. Note that the application code must create the streams with names specified in the Outputs . For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2 , then your application code must create these streams.
• caApplicationName - Name of your Amazon Kinesis Analytics application (for example, sample-app ).

data CreateApplication

TBD

See: createApplication smart constructor.

Instances

Eq CreateApplication

Methods

(==) :: CreateApplication -> CreateApplication -> Bool

(/=) :: CreateApplication -> CreateApplication -> Bool

Data CreateApplication

Methods

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

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

toConstr :: CreateApplication -> Constr

dataTypeOf :: CreateApplication -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateApplication -> CreateApplication

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

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

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

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

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

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

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

Read CreateApplication

Methods

readsPrec :: Int -> ReadS CreateApplication

readList :: ReadS [CreateApplication]

readPrec :: ReadPrec CreateApplication

readListPrec :: ReadPrec [CreateApplication]

Show CreateApplication

Methods

showsPrec :: Int -> CreateApplication -> ShowS

show :: CreateApplication -> String

showList :: [CreateApplication] -> ShowS

Generic CreateApplication

Associated Types

type Rep CreateApplication :: * -> *

Methods

from :: CreateApplication -> Rep CreateApplication x

to :: Rep CreateApplication x -> CreateApplication

Hashable CreateApplication

Methods

hashWithSalt :: Int -> CreateApplication -> Int

hash :: CreateApplication -> Int

ToJSON CreateApplication

Methods

toJSON :: CreateApplication -> Value

toEncoding :: CreateApplication -> Encoding

toJSONList :: [CreateApplication] -> Value

toEncodingList :: [CreateApplication] -> Encoding

NFData CreateApplication

Methods

rnf :: CreateApplication -> ()

AWSRequest CreateApplication

Associated Types

type Rs CreateApplication :: *

Methods

request :: CreateApplication -> Request CreateApplication

response :: MonadResource m => Logger -> Service -> Proxy * CreateApplication -> ClientResponse -> m (Response CreateApplication)

ToQuery CreateApplication

Methods

toQuery :: CreateApplication -> QueryString

ToPath CreateApplication

Methods

toPath :: CreateApplication -> ByteString

ToHeaders CreateApplication

Methods

toHeaders :: CreateApplication -> [Header]

type Rep CreateApplication

type Rep CreateApplication = D1 (MetaData "CreateApplication" "Network.AWS.KinesisAnalytics.CreateApplication" "amazonka-kinesis-analytics-1.5.0-Aag53z1k8npIGaZevnWzPh" False) (C1 (MetaCons "CreateApplication'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_caApplicationDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_caInputs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Input]))) (S1 (MetaSel (Just Symbol "_caCloudWatchLoggingOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CloudWatchLoggingOption]))))) ((:*:) (S1 (MetaSel (Just Symbol "_caOutputs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Output]))) ((:*:) (S1 (MetaSel (Just Symbol "_caApplicationCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_caApplicationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateApplication

type Rs CreateApplication = CreateApplicationResponse

Request Lenses

caApplicationDescription :: Lens' CreateApplication (Maybe Text)

Summary description of the application.

caInputs :: Lens' CreateApplication [Input]

Use this parameter to configure the application input. You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table). For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf. To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

caCloudWatchLoggingOptions :: Lens' CreateApplication [CloudWatchLoggingOption]

Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs .

caOutputs :: Lens' CreateApplication [Output]

You can configure application output to write data from any of the in-application streams to up to five destinations. These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, or both. In the configuration, you specify the in-application stream name, the destination stream Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. In the output configuration, you also provide the output stream Amazon Resource Name (ARN) and the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to this stream on your behalf.

caApplicationCode :: Lens' CreateApplication (Maybe Text)

One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more inforamtion about the typical pattern, see Application Code . You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps. Note that the application code must create the streams with names specified in the Outputs . For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2 , then your application code must create these streams.

caApplicationName :: Lens' CreateApplication Text

Name of your Amazon Kinesis Analytics application (for example, sample-app ).

Destructuring the Response

createApplicationResponse

Arguments

:: Int

carsResponseStatus

-> ApplicationSummary

carsApplicationSummary

-> CreateApplicationResponse

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

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

• carsResponseStatus - -- | The response status code.
• carsApplicationSummary - In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.

data CreateApplicationResponse

TBD

See: createApplicationResponse smart constructor.

Instances

Eq CreateApplicationResponse

Methods

(==) :: CreateApplicationResponse -> CreateApplicationResponse -> Bool

(/=) :: CreateApplicationResponse -> CreateApplicationResponse -> Bool

Data CreateApplicationResponse

Methods

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

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

toConstr :: CreateApplicationResponse -> Constr

dataTypeOf :: CreateApplicationResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateApplicationResponse -> CreateApplicationResponse

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

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

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

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

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

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

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

Read CreateApplicationResponse

Methods

readsPrec :: Int -> ReadS CreateApplicationResponse

readList :: ReadS [CreateApplicationResponse]

readPrec :: ReadPrec CreateApplicationResponse

readListPrec :: ReadPrec [CreateApplicationResponse]

Show CreateApplicationResponse

Methods

showsPrec :: Int -> CreateApplicationResponse -> ShowS

show :: CreateApplicationResponse -> String

showList :: [CreateApplicationResponse] -> ShowS

Generic CreateApplicationResponse

Associated Types

type Rep CreateApplicationResponse :: * -> *

Methods

from :: CreateApplicationResponse -> Rep CreateApplicationResponse x

to :: Rep CreateApplicationResponse x -> CreateApplicationResponse

NFData CreateApplicationResponse

Methods

rnf :: CreateApplicationResponse -> ()

type Rep CreateApplicationResponse

type Rep CreateApplicationResponse = D1 (MetaData "CreateApplicationResponse" "Network.AWS.KinesisAnalytics.CreateApplication" "amazonka-kinesis-analytics-1.5.0-Aag53z1k8npIGaZevnWzPh" False) (C1 (MetaCons "CreateApplicationResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_carsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_carsApplicationSummary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ApplicationSummary))))

Response Lenses

carsResponseStatus :: Lens' CreateApplicationResponse Int

• - | The response status code.

carsApplicationSummary :: Lens' CreateApplicationResponse ApplicationSummary

In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.