Network.AWS.IAM.CreateSAMLProvider

Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.

The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. 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, you upload an a SAML metadata document that you get from your IdP and that 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.

This operation requires Signature Version 4.

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
• csamlpName

data CreateSAMLProvider

See: createSAMLProvider smart constructor.

Instances

Eq CreateSAMLProvider

Methods

(==) :: CreateSAMLProvider -> CreateSAMLProvider -> Bool

(/=) :: CreateSAMLProvider -> CreateSAMLProvider -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS CreateSAMLProvider

readList :: ReadS [CreateSAMLProvider]

readPrec :: ReadPrec CreateSAMLProvider

readListPrec :: ReadPrec [CreateSAMLProvider]

Show CreateSAMLProvider

Methods

showsPrec :: Int -> CreateSAMLProvider -> ShowS

show :: CreateSAMLProvider -> String

showList :: [CreateSAMLProvider] -> ShowS

Generic CreateSAMLProvider

Associated Types

type Rep CreateSAMLProvider :: * -> *

Methods

from :: CreateSAMLProvider -> Rep CreateSAMLProvider x

to :: Rep CreateSAMLProvider x -> CreateSAMLProvider

Hashable CreateSAMLProvider

Methods

hashWithSalt :: Int -> CreateSAMLProvider -> Int

hash :: CreateSAMLProvider -> Int

NFData CreateSAMLProvider

Methods

rnf :: CreateSAMLProvider -> ()

AWSRequest CreateSAMLProvider

Associated Types

type Rs CreateSAMLProvider :: *

Methods

request :: CreateSAMLProvider -> Request CreateSAMLProvider

response :: MonadResource m => Logger -> Service -> Proxy * CreateSAMLProvider -> ClientResponse -> m (Response CreateSAMLProvider)

ToQuery CreateSAMLProvider

Methods

toQuery :: CreateSAMLProvider -> QueryString

ToPath CreateSAMLProvider

Methods

toPath :: CreateSAMLProvider -> ByteString

ToHeaders CreateSAMLProvider

Methods

toHeaders :: CreateSAMLProvider -> [Header]

type Rep CreateSAMLProvider

type Rep CreateSAMLProvider = D1 (MetaData "CreateSAMLProvider" "Network.AWS.IAM.CreateSAMLProvider" "amazonka-iam-1.4.2-IxxX1VashHkGLYx0CCJHht" False) (C1 (MetaCons "CreateSAMLProvider'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csamlpSAMLMetadataDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_csamlpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs 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.

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
• csamlprsResponseStatus

data CreateSAMLProviderResponse

Contains the response to a successful CreateSAMLProvider request.

See: createSAMLProviderResponse smart constructor.

Instances

Eq CreateSAMLProviderResponse

Methods

(==) :: CreateSAMLProviderResponse -> CreateSAMLProviderResponse -> Bool

(/=) :: CreateSAMLProviderResponse -> CreateSAMLProviderResponse -> Bool

Data CreateSAMLProviderResponse

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

Methods

readsPrec :: Int -> ReadS CreateSAMLProviderResponse

readList :: ReadS [CreateSAMLProviderResponse]

readPrec :: ReadPrec CreateSAMLProviderResponse

readListPrec :: ReadPrec [CreateSAMLProviderResponse]

Show CreateSAMLProviderResponse

Methods

showsPrec :: Int -> CreateSAMLProviderResponse -> ShowS

show :: CreateSAMLProviderResponse -> String

showList :: [CreateSAMLProviderResponse] -> ShowS

Generic CreateSAMLProviderResponse

Associated Types

type Rep CreateSAMLProviderResponse :: * -> *

Methods

from :: CreateSAMLProviderResponse -> Rep CreateSAMLProviderResponse x

to :: Rep CreateSAMLProviderResponse x -> CreateSAMLProviderResponse

NFData CreateSAMLProviderResponse

Methods

rnf :: CreateSAMLProviderResponse -> ()

type Rep CreateSAMLProviderResponse

type Rep CreateSAMLProviderResponse = D1 (MetaData "CreateSAMLProviderResponse" "Network.AWS.IAM.CreateSAMLProvider" "amazonka-iam-1.4.2-IxxX1VashHkGLYx0CCJHht" False) (C1 (MetaCons "CreateSAMLProviderResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csamlprsSAMLProviderARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csamlprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

csamlprsSAMLProviderARN :: Lens' CreateSAMLProviderResponse (Maybe Text)

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

csamlprsResponseStatus :: Lens' CreateSAMLProviderResponse Int

The response status code.