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.IAM.UpdateSAMLProvider

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the metadata document for an existing SAML provider resource object.

This operation requires Signature Version 4.

Creating a Request

data UpdateSAMLProvider Source #

See: newUpdateSAMLProvider smart constructor.

Constructors

UpdateSAMLProvider'

Fields

sAMLMetadataDocument :: Text
An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.
sAMLProviderArn :: Text
The Amazon Resource Name (ARN) of the SAML provider to update.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Instances

Instances details

ToHeaders UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods toHeaders :: UpdateSAMLProvider -> [Header] #
ToPath UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods toPath :: UpdateSAMLProvider -> ByteString #
ToQuery UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods toQuery :: UpdateSAMLProvider -> QueryString #
AWSRequest UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Associated Types type AWSResponse UpdateSAMLProvider # Methods request :: (Service -> Service) -> UpdateSAMLProvider -> Request UpdateSAMLProvider # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateSAMLProvider -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateSAMLProvider))) #
Generic UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Associated Types type Rep UpdateSAMLProvider :: Type -> Type # Methods from :: UpdateSAMLProvider -> Rep UpdateSAMLProvider x # to :: Rep UpdateSAMLProvider x -> UpdateSAMLProvider #
Read UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods readsPrec :: Int -> ReadS UpdateSAMLProvider # readList :: ReadS [UpdateSAMLProvider] # readPrec :: ReadPrec UpdateSAMLProvider # readListPrec :: ReadPrec [UpdateSAMLProvider] #
Show UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods showsPrec :: Int -> UpdateSAMLProvider -> ShowS # show :: UpdateSAMLProvider -> String # showList :: [UpdateSAMLProvider] -> ShowS #
NFData UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods rnf :: UpdateSAMLProvider -> () #
Eq UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods (==) :: UpdateSAMLProvider -> UpdateSAMLProvider -> Bool # (/=) :: UpdateSAMLProvider -> UpdateSAMLProvider -> Bool #
Hashable UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider Methods hashWithSalt :: Int -> UpdateSAMLProvider -> Int # hash :: UpdateSAMLProvider -> Int #
type AWSResponse UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider type AWSResponse UpdateSAMLProvider = UpdateSAMLProviderResponse
type Rep UpdateSAMLProvider Source #
Instance details Defined in Amazonka.IAM.UpdateSAMLProvider type Rep UpdateSAMLProvider = D1 ('MetaData "UpdateSAMLProvider" "Amazonka.IAM.UpdateSAMLProvider" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateSAMLProvider'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sAMLMetadataDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sAMLProviderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateSAMLProvider Source #

Arguments

:: Text	`$sel:sAMLMetadataDocument:UpdateSAMLProvider'`
-> Text	`UpdateSAMLProvider`
-> UpdateSAMLProvider

Create a value of UpdateSAMLProvider 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:sAMLMetadataDocument:UpdateSAMLProvider', updateSAMLProvider_sAMLMetadataDocument - An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

UpdateSAMLProvider, updateSAMLProvider_sAMLProviderArn - The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Request Lenses

updateSAMLProvider_sAMLMetadataDocument :: Lens' UpdateSAMLProvider Text Source #

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

updateSAMLProvider_sAMLProviderArn :: Lens' UpdateSAMLProvider Text Source #

The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Destructuring the Response

data UpdateSAMLProviderResponse Source #

Contains the response to a successful UpdateSAMLProvider request.

See: newUpdateSAMLProviderResponse smart constructor.

Constructors

UpdateSAMLProviderResponse'
Fields sAMLProviderArn :: Maybe Text The Amazon Resource Name (ARN) of the SAML provider that was updated. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateSAMLProviderResponse Source #

Arguments

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

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

UpdateSAMLProvider, updateSAMLProviderResponse_sAMLProviderArn - The Amazon Resource Name (ARN) of the SAML provider that was updated.

$sel:httpStatus:UpdateSAMLProviderResponse', updateSAMLProviderResponse_httpStatus - The response's http status code.

Response Lenses

updateSAMLProviderResponse_sAMLProviderArn :: Lens' UpdateSAMLProviderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SAML provider that was updated.

updateSAMLProviderResponse_httpStatus :: Lens' UpdateSAMLProviderResponse Int Source #

The response's http status code.