libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics
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.KinesisAnalytics.CreateApplication

Description

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

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

Synopsis

Creating a Request

data CreateApplication Source #

TBD

See: newCreateApplication smart constructor.

Constructors

CreateApplication' 

Fields

  • applicationDescription :: Maybe Text

    Summary description of the application.

  • inputs :: Maybe [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.

  • cloudWatchLoggingOptions :: Maybe [CloudWatchLoggingOption]

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

  • outputs :: Maybe [Output]

    You can configure application output to write data from any of the in-application streams to up to three destinations.

    These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.

    In the configuration, you specify the in-application stream name, the destination stream or Lambda function 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 or Lambda function on your behalf.

    In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide 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 the stream or Lambda function on your behalf.

  • applicationCode :: 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 information 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.

  • tags :: Maybe (NonEmpty Tag)

    A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

  • applicationName :: Text

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

Instances

Instances details
Eq CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Read CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Show CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Generic CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Associated Types

type Rep CreateApplication :: Type -> Type #

NFData CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Methods

rnf :: CreateApplication -> () #

Hashable CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

ToJSON CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

AWSRequest CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Associated Types

type AWSResponse CreateApplication #

ToHeaders CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

ToPath CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

ToQuery CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

type Rep CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

type Rep CreateApplication = D1 ('MetaData "CreateApplication" "Amazonka.KinesisAnalytics.CreateApplication" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "CreateApplication'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Input])) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CloudWatchLoggingOption])))) :*: ((S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Output])) :*: S1 ('MetaSel ('Just "applicationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateApplication Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

newCreateApplication Source #

Create a value of CreateApplication 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:applicationDescription:CreateApplication', createApplication_applicationDescription - Summary description of the application.

$sel:inputs:CreateApplication', createApplication_inputs - 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.

$sel:cloudWatchLoggingOptions:CreateApplication', createApplication_cloudWatchLoggingOptions - Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.

$sel:outputs:CreateApplication', createApplication_outputs - You can configure application output to write data from any of the in-application streams to up to three destinations.

These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.

In the configuration, you specify the in-application stream name, the destination stream or Lambda function 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 or Lambda function on your behalf.

In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide 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 the stream or Lambda function on your behalf.

$sel:applicationCode:CreateApplication', createApplication_applicationCode - 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 information 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.

$sel:tags:CreateApplication', createApplication_tags - A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

$sel:applicationName:CreateApplication', createApplication_applicationName - Name of your Amazon Kinesis Analytics application (for example, sample-app).

Request Lenses

createApplication_inputs :: Lens' CreateApplication (Maybe [Input]) Source #

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.

createApplication_cloudWatchLoggingOptions :: Lens' CreateApplication (Maybe [CloudWatchLoggingOption]) Source #

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

createApplication_outputs :: Lens' CreateApplication (Maybe [Output]) Source #

You can configure application output to write data from any of the in-application streams to up to three destinations.

These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.

In the configuration, you specify the in-application stream name, the destination stream or Lambda function 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 or Lambda function on your behalf.

In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide 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 the stream or Lambda function on your behalf.

createApplication_applicationCode :: Lens' CreateApplication (Maybe Text) Source #

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

createApplication_tags :: Lens' CreateApplication (Maybe (NonEmpty Tag)) Source #

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

createApplication_applicationName :: Lens' CreateApplication Text Source #

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

Destructuring the Response

data CreateApplicationResponse Source #

TBD

See: newCreateApplicationResponse smart constructor.

Constructors

CreateApplicationResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

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

Instances

Instances details
Eq CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Read CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Show CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Generic CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

Associated Types

type Rep CreateApplicationResponse :: Type -> Type #

NFData CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

type Rep CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.KinesisAnalytics.CreateApplication

type Rep CreateApplicationResponse = D1 ('MetaData "CreateApplicationResponse" "Amazonka.KinesisAnalytics.CreateApplication" "libZSservicesZSamazonka-kinesis-analyticsZSamazonka-kinesis-analytics" 'False) (C1 ('MetaCons "CreateApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "applicationSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApplicationSummary)))

newCreateApplicationResponse Source #

Create a value of CreateApplicationResponse 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:httpStatus:CreateApplicationResponse', createApplicationResponse_httpStatus - The response's http status code.

$sel:applicationSummary:CreateApplicationResponse', 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.

Response Lenses

createApplicationResponse_applicationSummary :: Lens' CreateApplicationResponse ApplicationSummary Source #

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.