Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.KinesisAnalyticsV2.CreateApplication

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.

Synopsis

Creating a Request

data CreateApplication Source #

See: newCreateApplication smart constructor.

Constructors

CreateApplication'

Fields

applicationConfiguration :: Maybe ApplicationConfiguration
Use this parameter to configure the application.
applicationDescription :: Maybe Text
A summary description of the application.
applicationMode :: Maybe ApplicationMode
Use the STREAMING mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode.
cloudWatchLoggingOptions :: Maybe [CloudWatchLoggingOption]
Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
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
The name of your application (for example, sample-app).
runtimeEnvironment :: RuntimeEnvironment
The runtime environment for the application.
serviceExecutionRole :: Text
The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

Instances

Instances details

ToJSON CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods toJSON :: CreateApplication -> Value # toEncoding :: CreateApplication -> Encoding # toJSONList :: [CreateApplication] -> Value # toEncodingList :: [CreateApplication] -> Encoding #
ToHeaders CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods toHeaders :: CreateApplication -> [Header] #
ToPath CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods toPath :: CreateApplication -> ByteString #
ToQuery CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods toQuery :: CreateApplication -> QueryString #
AWSRequest CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Associated Types type AWSResponse CreateApplication # Methods request :: (Service -> Service) -> CreateApplication -> Request CreateApplication # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateApplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApplication))) #
Generic CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Associated Types type Rep CreateApplication :: Type -> Type # Methods from :: CreateApplication -> Rep CreateApplication x # to :: Rep CreateApplication x -> CreateApplication #
Read CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods readsPrec :: Int -> ReadS CreateApplication # readList :: ReadS [CreateApplication] # readPrec :: ReadPrec CreateApplication # readListPrec :: ReadPrec [CreateApplication] #
Show CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods showsPrec :: Int -> CreateApplication -> ShowS # show :: CreateApplication -> String # showList :: [CreateApplication] -> ShowS #
NFData CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods rnf :: CreateApplication -> () #
Eq CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods (==) :: CreateApplication -> CreateApplication -> Bool # (/=) :: CreateApplication -> CreateApplication -> Bool #
Hashable CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods hashWithSalt :: Int -> CreateApplication -> Int # hash :: CreateApplication -> Int #
type AWSResponse CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication type AWSResponse CreateApplication = CreateApplicationResponse
type Rep CreateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication type Rep CreateApplication = D1 ('MetaData "CreateApplication" "Amazonka.KinesisAnalyticsV2.CreateApplication" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "CreateApplication'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplicationConfiguration)) :: S1 ('MetaSel ('Just "applicationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "applicationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplicationMode)) :: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CloudWatchLoggingOption])))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "runtimeEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RuntimeEnvironment) :*: S1 ('MetaSel ('Just "serviceExecutionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateApplication Source #

Arguments

:: Text	`CreateApplication`
-> RuntimeEnvironment	`CreateApplication`
-> Text	`CreateApplication`
-> CreateApplication

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:applicationConfiguration:CreateApplication', createApplication_applicationConfiguration - Use this parameter to configure the application.

CreateApplication, createApplication_applicationDescription - A summary description of the application.

CreateApplication, createApplication_applicationMode - Use the STREAMING mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode.

$sel:cloudWatchLoggingOptions:CreateApplication', createApplication_cloudWatchLoggingOptions - Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

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

CreateApplication, createApplication_applicationName - The name of your application (for example, sample-app).

CreateApplication, createApplication_runtimeEnvironment - The runtime environment for the application.

CreateApplication, createApplication_serviceExecutionRole - The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

Request Lenses

createApplication_applicationConfiguration :: Lens' CreateApplication (Maybe ApplicationConfiguration) Source #

Use this parameter to configure the application.

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

A summary description of the application.

createApplication_applicationMode :: Lens' CreateApplication (Maybe ApplicationMode) Source #

Use the STREAMING mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode.

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

Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

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 #

The name of your application (for example, sample-app).

createApplication_runtimeEnvironment :: Lens' CreateApplication RuntimeEnvironment Source #

The runtime environment for the application.

createApplication_serviceExecutionRole :: Lens' CreateApplication Text Source #

The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

Destructuring the Response

data CreateApplicationResponse Source #

See: newCreateApplicationResponse smart constructor.

Constructors

CreateApplicationResponse'
Fields httpStatus :: Int The response's http status code. applicationDetail :: ApplicationDetail In response to your `CreateApplication` request, Kinesis Data Analytics returns a response with details of the application it created.

Instances

Instances details

Generic CreateApplicationResponse Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Associated Types type Rep CreateApplicationResponse :: Type -> Type # Methods from :: CreateApplicationResponse -> Rep CreateApplicationResponse x # to :: Rep CreateApplicationResponse x -> CreateApplicationResponse #
Read CreateApplicationResponse Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods readsPrec :: Int -> ReadS CreateApplicationResponse # readList :: ReadS [CreateApplicationResponse] # readPrec :: ReadPrec CreateApplicationResponse # readListPrec :: ReadPrec [CreateApplicationResponse] #
Show CreateApplicationResponse Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods showsPrec :: Int -> CreateApplicationResponse -> ShowS # show :: CreateApplicationResponse -> String # showList :: [CreateApplicationResponse] -> ShowS #
NFData CreateApplicationResponse Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods rnf :: CreateApplicationResponse -> () #
Eq CreateApplicationResponse Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication Methods (==) :: CreateApplicationResponse -> CreateApplicationResponse -> Bool # (/=) :: CreateApplicationResponse -> CreateApplicationResponse -> Bool #
type Rep CreateApplicationResponse Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.CreateApplication type Rep CreateApplicationResponse = D1 ('MetaData "CreateApplicationResponse" "Amazonka.KinesisAnalyticsV2.CreateApplication" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "CreateApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "applicationDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApplicationDetail)))

newCreateApplicationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateApplicationResponse'`
-> ApplicationDetail	`$sel:applicationDetail:CreateApplicationResponse'`
-> CreateApplicationResponse

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:applicationDetail:CreateApplicationResponse', createApplicationResponse_applicationDetail - In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.

Response Lenses

createApplicationResponse_httpStatus :: Lens' CreateApplicationResponse Int Source #

The response's http status code.

createApplicationResponse_applicationDetail :: Lens' CreateApplicationResponse ApplicationDetail Source #

In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.