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.FinSpace.UpdateEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Update your FinSpace environment.

Synopsis

data UpdateEnvironment = UpdateEnvironment' {
- description :: Maybe Text
- federationMode :: Maybe FederationMode
- federationParameters :: Maybe FederationParameters
- name :: Maybe Text
- environmentId :: Text
}
newUpdateEnvironment :: Text -> UpdateEnvironment
updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_federationMode :: Lens' UpdateEnvironment (Maybe FederationMode)
updateEnvironment_federationParameters :: Lens' UpdateEnvironment (Maybe FederationParameters)
updateEnvironment_name :: Lens' UpdateEnvironment (Maybe Text)
updateEnvironment_environmentId :: Lens' UpdateEnvironment Text
data UpdateEnvironmentResponse = UpdateEnvironmentResponse' {
- environment :: Maybe Environment
- httpStatus :: Int
}
newUpdateEnvironmentResponse :: Int -> UpdateEnvironmentResponse
updateEnvironmentResponse_environment :: Lens' UpdateEnvironmentResponse (Maybe Environment)
updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int

Creating a Request

data UpdateEnvironment Source #

See: newUpdateEnvironment smart constructor.

Constructors

UpdateEnvironment'

Fields

description :: Maybe Text
The description of the environment.
federationMode :: Maybe FederationMode
Authentication mode for the environment.
- FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
- LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.
federationParameters :: Maybe FederationParameters
name :: Maybe Text
The name of the environment.
environmentId :: Text
The identifier of the FinSpace environment.

Instances

Instances details

ToJSON UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods toJSON :: UpdateEnvironment -> Value # toEncoding :: UpdateEnvironment -> Encoding # toJSONList :: [UpdateEnvironment] -> Value # toEncodingList :: [UpdateEnvironment] -> Encoding #
ToHeaders UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods toHeaders :: UpdateEnvironment -> [Header] #
ToPath UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods toPath :: UpdateEnvironment -> ByteString #
ToQuery UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods toQuery :: UpdateEnvironment -> QueryString #
AWSRequest UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Associated Types type AWSResponse UpdateEnvironment # Methods request :: (Service -> Service) -> UpdateEnvironment -> Request UpdateEnvironment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateEnvironment))) #
Generic UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Associated Types type Rep UpdateEnvironment :: Type -> Type # Methods from :: UpdateEnvironment -> Rep UpdateEnvironment x # to :: Rep UpdateEnvironment x -> UpdateEnvironment #
Read UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods readsPrec :: Int -> ReadS UpdateEnvironment # readList :: ReadS [UpdateEnvironment] # readPrec :: ReadPrec UpdateEnvironment # readListPrec :: ReadPrec [UpdateEnvironment] #
Show UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods showsPrec :: Int -> UpdateEnvironment -> ShowS # show :: UpdateEnvironment -> String # showList :: [UpdateEnvironment] -> ShowS #
NFData UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods rnf :: UpdateEnvironment -> () #
Eq UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods (==) :: UpdateEnvironment -> UpdateEnvironment -> Bool # (/=) :: UpdateEnvironment -> UpdateEnvironment -> Bool #
Hashable UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment Methods hashWithSalt :: Int -> UpdateEnvironment -> Int # hash :: UpdateEnvironment -> Int #
type AWSResponse UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment type AWSResponse UpdateEnvironment = UpdateEnvironmentResponse
type Rep UpdateEnvironment Source #
Instance details Defined in Amazonka.FinSpace.UpdateEnvironment type Rep UpdateEnvironment = D1 ('MetaData "UpdateEnvironment" "Amazonka.FinSpace.UpdateEnvironment" "amazonka-finspace-2.0-D97KpJfy3e64ziV32Jkivv" 'False) (C1 ('MetaCons "UpdateEnvironment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "federationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationMode))) :: (S1 ('MetaSel ('Just "federationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FederationParameters)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateEnvironment Source #

Arguments

:: Text	`UpdateEnvironment`
-> UpdateEnvironment

Create a value of UpdateEnvironment 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:

UpdateEnvironment, updateEnvironment_description - The description of the environment.

UpdateEnvironment, updateEnvironment_federationMode - Authentication mode for the environment.

FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

UpdateEnvironment, updateEnvironment_federationParameters - Undocumented member.

UpdateEnvironment, updateEnvironment_name - The name of the environment.

UpdateEnvironment, updateEnvironment_environmentId - The identifier of the FinSpace environment.

Request Lenses

updateEnvironment_description :: Lens' UpdateEnvironment (Maybe Text) Source #

The description of the environment.

updateEnvironment_federationMode :: Lens' UpdateEnvironment (Maybe FederationMode) Source #

Authentication mode for the environment.

FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

updateEnvironment_federationParameters :: Lens' UpdateEnvironment (Maybe FederationParameters) Source #

Undocumented member.

updateEnvironment_name :: Lens' UpdateEnvironment (Maybe Text) Source #

The name of the environment.

updateEnvironment_environmentId :: Lens' UpdateEnvironment Text Source #

The identifier of the FinSpace environment.

Destructuring the Response

data UpdateEnvironmentResponse Source #

See: newUpdateEnvironmentResponse smart constructor.

Constructors

UpdateEnvironmentResponse'
Fields environment :: Maybe Environment Returns the FinSpace environment object. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateEnvironmentResponse'`
-> UpdateEnvironmentResponse

Create a value of UpdateEnvironmentResponse 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:environment:UpdateEnvironmentResponse', updateEnvironmentResponse_environment - Returns the FinSpace environment object.

$sel:httpStatus:UpdateEnvironmentResponse', updateEnvironmentResponse_httpStatus - The response's http status code.

Response Lenses

updateEnvironmentResponse_environment :: Lens' UpdateEnvironmentResponse (Maybe Environment) Source #

Returns the FinSpace environment object.

updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int Source #

The response's http status code.