Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.IAM.CreateSAMLProvider

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign-in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide .

Creating a Request

createSAMLProvider #

Arguments

:: Text	`csamlpSAMLMetadataDocument`
-> Text	`csamlpName`
-> CreateSAMLProvider

Creates a value of CreateSAMLProvider with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

csamlpSAMLMetadataDocument - 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. For more information, see About SAML 2.0-based Federation in the IAM User Guide
csamlpName - The name of the provider to create. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

data CreateSAMLProvider #

See: createSAMLProvider smart constructor.

Instances

Eq CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods (==) :: CreateSAMLProvider -> CreateSAMLProvider -> Bool # (/=) :: CreateSAMLProvider -> CreateSAMLProvider -> Bool #
Data CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateSAMLProvider -> c CreateSAMLProvider # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateSAMLProvider # toConstr :: CreateSAMLProvider -> Constr # dataTypeOf :: CreateSAMLProvider -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateSAMLProvider) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateSAMLProvider) # gmapT :: (forall b. Data b => b -> b) -> CreateSAMLProvider -> CreateSAMLProvider # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProvider -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProvider -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateSAMLProvider -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateSAMLProvider -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateSAMLProvider -> m CreateSAMLProvider # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProvider -> m CreateSAMLProvider # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProvider -> m CreateSAMLProvider #
Read CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods readsPrec :: Int -> ReadS CreateSAMLProvider # readList :: ReadS [CreateSAMLProvider] # readPrec :: ReadPrec CreateSAMLProvider # readListPrec :: ReadPrec [CreateSAMLProvider] #
Show CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods showsPrec :: Int -> CreateSAMLProvider -> ShowS # show :: CreateSAMLProvider -> String # showList :: [CreateSAMLProvider] -> ShowS #
Generic CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Associated Types type Rep CreateSAMLProvider :: Type -> Type # Methods from :: CreateSAMLProvider -> Rep CreateSAMLProvider x # to :: Rep CreateSAMLProvider x -> CreateSAMLProvider #
Hashable CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods hashWithSalt :: Int -> CreateSAMLProvider -> Int # hash :: CreateSAMLProvider -> Int #
AWSRequest CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Associated Types type Rs CreateSAMLProvider :: Type # Methods request :: CreateSAMLProvider -> Request CreateSAMLProvider # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateSAMLProvider -> ClientResponse -> m (Response CreateSAMLProvider) #
ToHeaders CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods toHeaders :: CreateSAMLProvider -> [Header] #
ToPath CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods toPath :: CreateSAMLProvider -> ByteString #
ToQuery CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods toQuery :: CreateSAMLProvider -> QueryString #
NFData CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods rnf :: CreateSAMLProvider -> () #
type Rep CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider type Rep CreateSAMLProvider = D1 (MetaData "CreateSAMLProvider" "Network.AWS.IAM.CreateSAMLProvider" "amazonka-iam-1.6.1-GVjkJ4xTMMc7GNa2rMCkPz" False) (C1 (MetaCons "CreateSAMLProvider'" PrefixI True) (S1 (MetaSel (Just "_csamlpSAMLMetadataDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_csamlpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs CreateSAMLProvider #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider type Rs CreateSAMLProvider = CreateSAMLProviderResponse

Request Lenses

csamlpSAMLMetadataDocument :: Lens' CreateSAMLProvider 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. For more information, see About SAML 2.0-based Federation in the IAM User Guide

csamlpName :: Lens' CreateSAMLProvider Text #

The name of the provider to create. This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Destructuring the Response

createSAMLProviderResponse #

Arguments

:: Int	`csamlprsResponseStatus`
-> CreateSAMLProviderResponse

Creates a value of CreateSAMLProviderResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

csamlprsSAMLProviderARN - The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.
csamlprsResponseStatus - -- | The response status code.

data CreateSAMLProviderResponse #

Contains the response to a successful CreateSAMLProvider request.

See: createSAMLProviderResponse smart constructor.

Instances

Eq CreateSAMLProviderResponse #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods (==) :: CreateSAMLProviderResponse -> CreateSAMLProviderResponse -> Bool # (/=) :: CreateSAMLProviderResponse -> CreateSAMLProviderResponse -> Bool #
Data CreateSAMLProviderResponse #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateSAMLProviderResponse -> c CreateSAMLProviderResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateSAMLProviderResponse # toConstr :: CreateSAMLProviderResponse -> Constr # dataTypeOf :: CreateSAMLProviderResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateSAMLProviderResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateSAMLProviderResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateSAMLProviderResponse -> CreateSAMLProviderResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProviderResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateSAMLProviderResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateSAMLProviderResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateSAMLProviderResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateSAMLProviderResponse -> m CreateSAMLProviderResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProviderResponse -> m CreateSAMLProviderResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateSAMLProviderResponse -> m CreateSAMLProviderResponse #
Read CreateSAMLProviderResponse #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods readsPrec :: Int -> ReadS CreateSAMLProviderResponse # readList :: ReadS [CreateSAMLProviderResponse] # readPrec :: ReadPrec CreateSAMLProviderResponse # readListPrec :: ReadPrec [CreateSAMLProviderResponse] #
Show CreateSAMLProviderResponse #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods showsPrec :: Int -> CreateSAMLProviderResponse -> ShowS # show :: CreateSAMLProviderResponse -> String # showList :: [CreateSAMLProviderResponse] -> ShowS #
Generic CreateSAMLProviderResponse #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Associated Types type Rep CreateSAMLProviderResponse :: Type -> Type # Methods from :: CreateSAMLProviderResponse -> Rep CreateSAMLProviderResponse x # to :: Rep CreateSAMLProviderResponse x -> CreateSAMLProviderResponse #
NFData CreateSAMLProviderResponse #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider Methods rnf :: CreateSAMLProviderResponse -> () #
type Rep CreateSAMLProviderResponse #
Instance details Defined in Network.AWS.IAM.CreateSAMLProvider type Rep CreateSAMLProviderResponse = D1 (MetaData "CreateSAMLProviderResponse" "Network.AWS.IAM.CreateSAMLProvider" "amazonka-iam-1.6.1-GVjkJ4xTMMc7GNa2rMCkPz" False) (C1 (MetaCons "CreateSAMLProviderResponse'" PrefixI True) (S1 (MetaSel (Just "_csamlprsSAMLProviderARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_csamlprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

csamlprsSAMLProviderARN :: Lens' CreateSAMLProviderResponse (Maybe Text) #

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

csamlprsResponseStatus :: Lens' CreateSAMLProviderResponse Int #

- | The response status code.