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.OpenSearchServerless.UpdateSecurityConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Synopsis

data UpdateSecurityConfig = UpdateSecurityConfig' {
- clientToken :: Maybe Text
- description :: Maybe Text
- samlOptions :: Maybe SamlConfigOptions
- configVersion :: Text
- id :: Text
}
newUpdateSecurityConfig :: Text -> Text -> UpdateSecurityConfig
updateSecurityConfig_clientToken :: Lens' UpdateSecurityConfig (Maybe Text)
updateSecurityConfig_description :: Lens' UpdateSecurityConfig (Maybe Text)
updateSecurityConfig_samlOptions :: Lens' UpdateSecurityConfig (Maybe SamlConfigOptions)
updateSecurityConfig_configVersion :: Lens' UpdateSecurityConfig Text
updateSecurityConfig_id :: Lens' UpdateSecurityConfig Text
data UpdateSecurityConfigResponse = UpdateSecurityConfigResponse' {
- securityConfigDetail :: Maybe SecurityConfigDetail
- httpStatus :: Int
}
newUpdateSecurityConfigResponse :: Int -> UpdateSecurityConfigResponse
updateSecurityConfigResponse_securityConfigDetail :: Lens' UpdateSecurityConfigResponse (Maybe SecurityConfigDetail)
updateSecurityConfigResponse_httpStatus :: Lens' UpdateSecurityConfigResponse Int

Creating a Request

data UpdateSecurityConfig Source #

See: newUpdateSecurityConfig smart constructor.

Constructors

UpdateSecurityConfig'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier to ensure idempotency of the request.
description :: Maybe Text
A description of the security configuration.
samlOptions :: Maybe SamlConfigOptions
SAML options in in the form of a key-value map.
configVersion :: Text
The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.
id :: Text
The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

Instances

Instances details

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

newUpdateSecurityConfig Source #

Arguments

:: Text	`UpdateSecurityConfig`
-> Text	`UpdateSecurityConfig`
-> UpdateSecurityConfig

Create a value of UpdateSecurityConfig 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:clientToken:UpdateSecurityConfig', updateSecurityConfig_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

UpdateSecurityConfig, updateSecurityConfig_description - A description of the security configuration.

UpdateSecurityConfig, updateSecurityConfig_samlOptions - SAML options in in the form of a key-value map.

UpdateSecurityConfig, updateSecurityConfig_configVersion - The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

UpdateSecurityConfig, updateSecurityConfig_id - The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

Request Lenses

updateSecurityConfig_clientToken :: Lens' UpdateSecurityConfig (Maybe Text) Source #

Unique, case-sensitive identifier to ensure idempotency of the request.

updateSecurityConfig_description :: Lens' UpdateSecurityConfig (Maybe Text) Source #

A description of the security configuration.

updateSecurityConfig_samlOptions :: Lens' UpdateSecurityConfig (Maybe SamlConfigOptions) Source #

SAML options in in the form of a key-value map.

updateSecurityConfig_configVersion :: Lens' UpdateSecurityConfig Text Source #

The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

updateSecurityConfig_id :: Lens' UpdateSecurityConfig Text Source #

The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

Destructuring the Response

data UpdateSecurityConfigResponse Source #

See: newUpdateSecurityConfigResponse smart constructor.

Constructors

UpdateSecurityConfigResponse'
Fields securityConfigDetail :: Maybe SecurityConfigDetail Details about the updated security configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateSecurityConfigResponse Source #

Arguments

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

Create a value of UpdateSecurityConfigResponse 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:securityConfigDetail:UpdateSecurityConfigResponse', updateSecurityConfigResponse_securityConfigDetail - Details about the updated security configuration.

$sel:httpStatus:UpdateSecurityConfigResponse', updateSecurityConfigResponse_httpStatus - The response's http status code.

Response Lenses

updateSecurityConfigResponse_securityConfigDetail :: Lens' UpdateSecurityConfigResponse (Maybe SecurityConfigDetail) Source #

Details about the updated security configuration.

updateSecurityConfigResponse_httpStatus :: Lens' UpdateSecurityConfigResponse Int Source #

The response's http status code.