Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Amplify.UpdateApp

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing Amplify app.

Synopsis

data UpdateApp = UpdateApp' {
- enableBranchAutoBuild :: Maybe Bool
- oauthToken :: Maybe (Sensitive Text)
- accessToken :: Maybe (Sensitive Text)
- customHeaders :: Maybe Text
- platform :: Maybe Platform
- basicAuthCredentials :: Maybe (Sensitive Text)
- repository :: Maybe Text
- buildSpec :: Maybe Text
- enableBranchAutoDeletion :: Maybe Bool
- customRules :: Maybe [CustomRule]
- iamServiceRoleArn :: Maybe Text
- autoBranchCreationPatterns :: Maybe [Text]
- name :: Maybe Text
- autoBranchCreationConfig :: Maybe AutoBranchCreationConfig
- environmentVariables :: Maybe (HashMap Text Text)
- enableAutoBranchCreation :: Maybe Bool
- enableBasicAuth :: Maybe Bool
- description :: Maybe Text
- appId :: Text
}
newUpdateApp :: Text -> UpdateApp
updateApp_enableBranchAutoBuild :: Lens' UpdateApp (Maybe Bool)
updateApp_oauthToken :: Lens' UpdateApp (Maybe Text)
updateApp_accessToken :: Lens' UpdateApp (Maybe Text)
updateApp_customHeaders :: Lens' UpdateApp (Maybe Text)
updateApp_platform :: Lens' UpdateApp (Maybe Platform)
updateApp_basicAuthCredentials :: Lens' UpdateApp (Maybe Text)
updateApp_repository :: Lens' UpdateApp (Maybe Text)
updateApp_buildSpec :: Lens' UpdateApp (Maybe Text)
updateApp_enableBranchAutoDeletion :: Lens' UpdateApp (Maybe Bool)
updateApp_customRules :: Lens' UpdateApp (Maybe [CustomRule])
updateApp_iamServiceRoleArn :: Lens' UpdateApp (Maybe Text)
updateApp_autoBranchCreationPatterns :: Lens' UpdateApp (Maybe [Text])
updateApp_name :: Lens' UpdateApp (Maybe Text)
updateApp_autoBranchCreationConfig :: Lens' UpdateApp (Maybe AutoBranchCreationConfig)
updateApp_environmentVariables :: Lens' UpdateApp (Maybe (HashMap Text Text))
updateApp_enableAutoBranchCreation :: Lens' UpdateApp (Maybe Bool)
updateApp_enableBasicAuth :: Lens' UpdateApp (Maybe Bool)
updateApp_description :: Lens' UpdateApp (Maybe Text)
updateApp_appId :: Lens' UpdateApp Text
data UpdateAppResponse = UpdateAppResponse' {
- httpStatus :: Int
- app :: App
}
newUpdateAppResponse :: Int -> App -> UpdateAppResponse
updateAppResponse_httpStatus :: Lens' UpdateAppResponse Int
updateAppResponse_app :: Lens' UpdateAppResponse App

Creating a Request

data UpdateApp Source #

The request structure for the update app request.

See: newUpdateApp smart constructor.

Constructors

UpdateApp'

Fields

enableBranchAutoBuild :: Maybe Bool
Enables branch auto-building for an Amplify app.
oauthToken :: Maybe (Sensitive Text)
The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
accessToken :: Maybe (Sensitive Text)
The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored.
customHeaders :: Maybe Text
The custom HTTP headers for an Amplify app.
platform :: Maybe Platform
The platform for an Amplify app.
basicAuthCredentials :: Maybe (Sensitive Text)
The basic authorization credentials for an Amplify app.
repository :: Maybe Text
The name of the repository for an Amplify app
buildSpec :: Maybe Text
The build specification (build spec) for an Amplify app.
enableBranchAutoDeletion :: Maybe Bool
Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
customRules :: Maybe [CustomRule]
The custom redirect and rewrite rules for an Amplify app.
iamServiceRoleArn :: Maybe Text
The AWS Identity and Access Management (IAM) service role for an Amplify app.
autoBranchCreationPatterns :: Maybe [Text]
Describes the automated branch creation glob patterns for an Amplify app.
name :: Maybe Text
The name for an Amplify app.
autoBranchCreationConfig :: Maybe AutoBranchCreationConfig
The automated branch creation configuration for an Amplify app.
environmentVariables :: Maybe (HashMap Text Text)
The environment variables for an Amplify app.
enableAutoBranchCreation :: Maybe Bool
Enables automated branch creation for an Amplify app.
enableBasicAuth :: Maybe Bool
Enables basic authorization for an Amplify app.
description :: Maybe Text
The description for an Amplify app.
appId :: Text
The unique ID for an Amplify app.

Instances

Instances details

Eq UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods (==) :: UpdateApp -> UpdateApp -> Bool # (/=) :: UpdateApp -> UpdateApp -> Bool #
Show UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods showsPrec :: Int -> UpdateApp -> ShowS # show :: UpdateApp -> String # showList :: [UpdateApp] -> ShowS #
Generic UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Associated Types type Rep UpdateApp :: Type -> Type # Methods from :: UpdateApp -> Rep UpdateApp x # to :: Rep UpdateApp x -> UpdateApp #
NFData UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods rnf :: UpdateApp -> () #
Hashable UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods hashWithSalt :: Int -> UpdateApp -> Int # hash :: UpdateApp -> Int #
ToJSON UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods toJSON :: UpdateApp -> Value # toEncoding :: UpdateApp -> Encoding # toJSONList :: [UpdateApp] -> Value # toEncodingList :: [UpdateApp] -> Encoding #
AWSRequest UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Associated Types type AWSResponse UpdateApp # Methods request :: UpdateApp -> Request UpdateApp # response :: MonadResource m => Logger -> Service -> Proxy UpdateApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateApp))) #
ToHeaders UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods toHeaders :: UpdateApp -> [Header] #
ToPath UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods toPath :: UpdateApp -> ByteString #
ToQuery UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods toQuery :: UpdateApp -> QueryString #
type Rep UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp type Rep UpdateApp = D1 ('MetaData "UpdateApp" "Amazonka.Amplify.UpdateApp" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "UpdateApp'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "enableBranchAutoBuild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "oauthToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "customHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Platform)) :: S1 ('MetaSel ('Just "basicAuthCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "repository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "buildSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enableBranchAutoDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "customRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CustomRule])) :: S1 ('MetaSel ('Just "iamServiceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "autoBranchCreationPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "autoBranchCreationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoBranchCreationConfig))))) :: ((S1 ('MetaSel ('Just "environmentVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "enableAutoBranchCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "enableBasicAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))
type AWSResponse UpdateApp Source #
Instance details Defined in Amazonka.Amplify.UpdateApp type AWSResponse UpdateApp = UpdateAppResponse

newUpdateApp Source #

Arguments

:: Text	`$sel:appId:UpdateApp'`
-> UpdateApp

Create a value of UpdateApp 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:enableBranchAutoBuild:UpdateApp', updateApp_enableBranchAutoBuild - Enables branch auto-building for an Amplify app.

$sel:oauthToken:UpdateApp', updateApp_oauthToken - The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

$sel:accessToken:UpdateApp', updateApp_accessToken - The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored.

$sel:customHeaders:UpdateApp', updateApp_customHeaders - The custom HTTP headers for an Amplify app.

$sel:platform:UpdateApp', updateApp_platform - The platform for an Amplify app.

$sel:basicAuthCredentials:UpdateApp', updateApp_basicAuthCredentials - The basic authorization credentials for an Amplify app.

$sel:repository:UpdateApp', updateApp_repository - The name of the repository for an Amplify app

$sel:buildSpec:UpdateApp', updateApp_buildSpec - The build specification (build spec) for an Amplify app.

$sel:enableBranchAutoDeletion:UpdateApp', updateApp_enableBranchAutoDeletion - Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

$sel:customRules:UpdateApp', updateApp_customRules - The custom redirect and rewrite rules for an Amplify app.

$sel:iamServiceRoleArn:UpdateApp', updateApp_iamServiceRoleArn - The AWS Identity and Access Management (IAM) service role for an Amplify app.

$sel:autoBranchCreationPatterns:UpdateApp', updateApp_autoBranchCreationPatterns - Describes the automated branch creation glob patterns for an Amplify app.

$sel:name:UpdateApp', updateApp_name - The name for an Amplify app.

$sel:autoBranchCreationConfig:UpdateApp', updateApp_autoBranchCreationConfig - The automated branch creation configuration for an Amplify app.

$sel:environmentVariables:UpdateApp', updateApp_environmentVariables - The environment variables for an Amplify app.

$sel:enableAutoBranchCreation:UpdateApp', updateApp_enableAutoBranchCreation - Enables automated branch creation for an Amplify app.

$sel:enableBasicAuth:UpdateApp', updateApp_enableBasicAuth - Enables basic authorization for an Amplify app.

$sel:description:UpdateApp', updateApp_description - The description for an Amplify app.

$sel:appId:UpdateApp', updateApp_appId - The unique ID for an Amplify app.

Request Lenses

updateApp_enableBranchAutoBuild :: Lens' UpdateApp (Maybe Bool) Source #

Enables branch auto-building for an Amplify app.

updateApp_oauthToken :: Lens' UpdateApp (Maybe Text) Source #

The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

updateApp_accessToken :: Lens' UpdateApp (Maybe Text) Source #

The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored.

updateApp_customHeaders :: Lens' UpdateApp (Maybe Text) Source #

The custom HTTP headers for an Amplify app.

updateApp_platform :: Lens' UpdateApp (Maybe Platform) Source #

The platform for an Amplify app.

updateApp_basicAuthCredentials :: Lens' UpdateApp (Maybe Text) Source #

The basic authorization credentials for an Amplify app.

updateApp_repository :: Lens' UpdateApp (Maybe Text) Source #

The name of the repository for an Amplify app

updateApp_buildSpec :: Lens' UpdateApp (Maybe Text) Source #

The build specification (build spec) for an Amplify app.

updateApp_enableBranchAutoDeletion :: Lens' UpdateApp (Maybe Bool) Source #

Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

updateApp_customRules :: Lens' UpdateApp (Maybe [CustomRule]) Source #

The custom redirect and rewrite rules for an Amplify app.

updateApp_iamServiceRoleArn :: Lens' UpdateApp (Maybe Text) Source #

The AWS Identity and Access Management (IAM) service role for an Amplify app.

updateApp_autoBranchCreationPatterns :: Lens' UpdateApp (Maybe [Text]) Source #

Describes the automated branch creation glob patterns for an Amplify app.

updateApp_name :: Lens' UpdateApp (Maybe Text) Source #

The name for an Amplify app.

updateApp_autoBranchCreationConfig :: Lens' UpdateApp (Maybe AutoBranchCreationConfig) Source #

The automated branch creation configuration for an Amplify app.

updateApp_environmentVariables :: Lens' UpdateApp (Maybe (HashMap Text Text)) Source #

The environment variables for an Amplify app.

updateApp_enableAutoBranchCreation :: Lens' UpdateApp (Maybe Bool) Source #

Enables automated branch creation for an Amplify app.

updateApp_enableBasicAuth :: Lens' UpdateApp (Maybe Bool) Source #

Enables basic authorization for an Amplify app.

updateApp_description :: Lens' UpdateApp (Maybe Text) Source #

The description for an Amplify app.

updateApp_appId :: Lens' UpdateApp Text Source #

The unique ID for an Amplify app.

Destructuring the Response

data UpdateAppResponse Source #

The result structure for an Amplify app update request.

See: newUpdateAppResponse smart constructor.

Constructors

UpdateAppResponse'
Fields httpStatus :: Int The response's http status code. app :: App Represents the updated Amplify app.

Instances

Instances details

Eq UpdateAppResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods (==) :: UpdateAppResponse -> UpdateAppResponse -> Bool # (/=) :: UpdateAppResponse -> UpdateAppResponse -> Bool #
Show UpdateAppResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods showsPrec :: Int -> UpdateAppResponse -> ShowS # show :: UpdateAppResponse -> String # showList :: [UpdateAppResponse] -> ShowS #
Generic UpdateAppResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Associated Types type Rep UpdateAppResponse :: Type -> Type # Methods from :: UpdateAppResponse -> Rep UpdateAppResponse x # to :: Rep UpdateAppResponse x -> UpdateAppResponse #
NFData UpdateAppResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateApp Methods rnf :: UpdateAppResponse -> () #
type Rep UpdateAppResponse Source #
Instance details Defined in Amazonka.Amplify.UpdateApp type Rep UpdateAppResponse = D1 ('MetaData "UpdateAppResponse" "Amazonka.Amplify.UpdateApp" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "UpdateAppResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "app") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 App)))

newUpdateAppResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateAppResponse'`
-> App	`$sel:app:UpdateAppResponse'`
-> UpdateAppResponse

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

$sel:app:UpdateAppResponse', updateAppResponse_app - Represents the updated Amplify app.

Response Lenses

updateAppResponse_httpStatus :: Lens' UpdateAppResponse Int Source #

The response's http status code.

updateAppResponse_app :: Lens' UpdateAppResponse App Source #

Represents the updated Amplify app.