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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.

Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.

You cannot update the RuntimeEnvironment of an existing application. If you need to update an application's RuntimeEnvironment, you must delete the application and create it again.

Synopsis

Creating a Request

data UpdateApplication Source #

See: newUpdateApplication smart constructor.

Constructors

UpdateApplication'

Fields

applicationConfigurationUpdate :: Maybe ApplicationConfigurationUpdate
Describes application configuration updates.
cloudWatchLoggingOptionUpdates :: Maybe [CloudWatchLoggingOptionUpdate]
Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
conditionalToken :: Maybe Text
A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.
currentApplicationVersionId :: Maybe Natural
The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.
runConfigurationUpdate :: Maybe RunConfigurationUpdate
Describes updates to the application's starting parameters.
serviceExecutionRoleUpdate :: Maybe Text
Describes updates to the service execution role.
applicationName :: Text
The name of the application to update.

Instances

Instances details

ToJSON UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods toJSON :: UpdateApplication -> Value # toEncoding :: UpdateApplication -> Encoding # toJSONList :: [UpdateApplication] -> Value # toEncodingList :: [UpdateApplication] -> Encoding #
ToHeaders UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods toHeaders :: UpdateApplication -> [Header] #
ToPath UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods toPath :: UpdateApplication -> ByteString #
ToQuery UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods toQuery :: UpdateApplication -> QueryString #
AWSRequest UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Associated Types type AWSResponse UpdateApplication # Methods request :: (Service -> Service) -> UpdateApplication -> Request UpdateApplication # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateApplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateApplication))) #
Generic UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Associated Types type Rep UpdateApplication :: Type -> Type # Methods from :: UpdateApplication -> Rep UpdateApplication x # to :: Rep UpdateApplication x -> UpdateApplication #
Read UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods readsPrec :: Int -> ReadS UpdateApplication # readList :: ReadS [UpdateApplication] # readPrec :: ReadPrec UpdateApplication # readListPrec :: ReadPrec [UpdateApplication] #
Show UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods showsPrec :: Int -> UpdateApplication -> ShowS # show :: UpdateApplication -> String # showList :: [UpdateApplication] -> ShowS #
NFData UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods rnf :: UpdateApplication -> () #
Eq UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods (==) :: UpdateApplication -> UpdateApplication -> Bool # (/=) :: UpdateApplication -> UpdateApplication -> Bool #
Hashable UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication Methods hashWithSalt :: Int -> UpdateApplication -> Int # hash :: UpdateApplication -> Int #
type AWSResponse UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication type AWSResponse UpdateApplication = UpdateApplicationResponse
type Rep UpdateApplication Source #
Instance details Defined in Amazonka.KinesisAnalyticsV2.UpdateApplication type Rep UpdateApplication = D1 ('MetaData "UpdateApplication" "Amazonka.KinesisAnalyticsV2.UpdateApplication" "amazonka-kinesisanalyticsv2-2.0-EuRTRS4ROZrHrkll3mMtCB" 'False) (C1 ('MetaCons "UpdateApplication'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationConfigurationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplicationConfigurationUpdate)) :: (S1 ('MetaSel ('Just "cloudWatchLoggingOptionUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CloudWatchLoggingOptionUpdate])) :: S1 ('MetaSel ('Just "conditionalToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "currentApplicationVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "runConfigurationUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RunConfigurationUpdate))) :: (S1 ('MetaSel ('Just "serviceExecutionRoleUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateApplication Source #

Arguments

:: Text	`UpdateApplication`
-> UpdateApplication

Create a value of UpdateApplication 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:applicationConfigurationUpdate:UpdateApplication', updateApplication_applicationConfigurationUpdate - Describes application configuration updates.

$sel:cloudWatchLoggingOptionUpdates:UpdateApplication', updateApplication_cloudWatchLoggingOptionUpdates - Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.

UpdateApplication, updateApplication_conditionalToken - A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

$sel:currentApplicationVersionId:UpdateApplication', updateApplication_currentApplicationVersionId - The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

$sel:runConfigurationUpdate:UpdateApplication', updateApplication_runConfigurationUpdate - Describes updates to the application's starting parameters.

$sel:serviceExecutionRoleUpdate:UpdateApplication', updateApplication_serviceExecutionRoleUpdate - Describes updates to the service execution role.

UpdateApplication, updateApplication_applicationName - The name of the application to update.

Request Lenses

updateApplication_applicationConfigurationUpdate :: Lens' UpdateApplication (Maybe ApplicationConfigurationUpdate) Source #

Describes application configuration updates.

updateApplication_cloudWatchLoggingOptionUpdates :: Lens' UpdateApplication (Maybe [CloudWatchLoggingOptionUpdate]) Source #

Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.

updateApplication_conditionalToken :: Lens' UpdateApplication (Maybe Text) Source #

A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

updateApplication_currentApplicationVersionId :: Lens' UpdateApplication (Maybe Natural) Source #

The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

updateApplication_runConfigurationUpdate :: Lens' UpdateApplication (Maybe RunConfigurationUpdate) Source #

Describes updates to the application's starting parameters.

updateApplication_serviceExecutionRoleUpdate :: Lens' UpdateApplication (Maybe Text) Source #

Describes updates to the service execution role.

updateApplication_applicationName :: Lens' UpdateApplication Text Source #

The name of the application to update.

Destructuring the Response

data UpdateApplicationResponse Source #

See: newUpdateApplicationResponse smart constructor.

Constructors

UpdateApplicationResponse'
Fields httpStatus :: Int The response's http status code. applicationDetail :: ApplicationDetail Describes application updates.

Instances

Instances details

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

newUpdateApplicationResponse Source #

Arguments

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

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

$sel:applicationDetail:UpdateApplicationResponse', updateApplicationResponse_applicationDetail - Describes application updates.

Response Lenses

updateApplicationResponse_httpStatus :: Lens' UpdateApplicationResponse Int Source #

The response's http status code.

updateApplicationResponse_applicationDetail :: Lens' UpdateApplicationResponse ApplicationDetail Source #

Describes application updates.