amazonka-cognito-identity-1.6.0: Amazon Cognito Identity SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentity.SetIdentityPoolRoles

Contents

Description

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

Synopsis

Creating a Request

setIdentityPoolRoles #

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

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

  • siprRoleMappings - How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". Up to 25 rules can be specified per identity provider.
  • siprIdentityPoolId - An identity pool ID in the format REGION:GUID.
  • siprRoles - The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

data SetIdentityPoolRoles #

Input to the SetIdentityPoolRoles action.

See: setIdentityPoolRoles smart constructor.

Instances

Eq SetIdentityPoolRoles # 
Data SetIdentityPoolRoles # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetIdentityPoolRoles -> c SetIdentityPoolRoles #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetIdentityPoolRoles #

toConstr :: SetIdentityPoolRoles -> Constr #

dataTypeOf :: SetIdentityPoolRoles -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetIdentityPoolRoles) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetIdentityPoolRoles) #

gmapT :: (forall b. Data b => b -> b) -> SetIdentityPoolRoles -> SetIdentityPoolRoles #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetIdentityPoolRoles -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetIdentityPoolRoles -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetIdentityPoolRoles -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetIdentityPoolRoles -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetIdentityPoolRoles -> m SetIdentityPoolRoles #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetIdentityPoolRoles -> m SetIdentityPoolRoles #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetIdentityPoolRoles -> m SetIdentityPoolRoles #

Read SetIdentityPoolRoles # 
Show SetIdentityPoolRoles # 
Generic SetIdentityPoolRoles # 
Hashable SetIdentityPoolRoles # 
ToJSON SetIdentityPoolRoles # 
NFData SetIdentityPoolRoles # 

Methods

rnf :: SetIdentityPoolRoles -> () #

AWSRequest SetIdentityPoolRoles # 
ToHeaders SetIdentityPoolRoles # 
ToPath SetIdentityPoolRoles # 
ToQuery SetIdentityPoolRoles # 
type Rep SetIdentityPoolRoles # 
type Rep SetIdentityPoolRoles = D1 * (MetaData "SetIdentityPoolRoles" "Network.AWS.CognitoIdentity.SetIdentityPoolRoles" "amazonka-cognito-identity-1.6.0-7Jg9Nyngsx05LwQn1SZzEq" False) (C1 * (MetaCons "SetIdentityPoolRoles'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_siprRoleMappings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text RoleMapping)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_siprIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_siprRoles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Map Text Text))))))
type Rs SetIdentityPoolRoles # 

Request Lenses

siprRoleMappings :: Lens' SetIdentityPoolRoles (HashMap Text RoleMapping) #

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id". Up to 25 rules can be specified per identity provider.

siprIdentityPoolId :: Lens' SetIdentityPoolRoles Text #

An identity pool ID in the format REGION:GUID.

siprRoles :: Lens' SetIdentityPoolRoles (HashMap Text Text) #

The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

Destructuring the Response

setIdentityPoolRolesResponse :: SetIdentityPoolRolesResponse #

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

data SetIdentityPoolRolesResponse #

See: setIdentityPoolRolesResponse smart constructor.

Instances

Eq SetIdentityPoolRolesResponse # 
Data SetIdentityPoolRolesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetIdentityPoolRolesResponse -> c SetIdentityPoolRolesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetIdentityPoolRolesResponse #

toConstr :: SetIdentityPoolRolesResponse -> Constr #

dataTypeOf :: SetIdentityPoolRolesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetIdentityPoolRolesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetIdentityPoolRolesResponse) #

gmapT :: (forall b. Data b => b -> b) -> SetIdentityPoolRolesResponse -> SetIdentityPoolRolesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetIdentityPoolRolesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetIdentityPoolRolesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetIdentityPoolRolesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetIdentityPoolRolesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetIdentityPoolRolesResponse -> m SetIdentityPoolRolesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetIdentityPoolRolesResponse -> m SetIdentityPoolRolesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetIdentityPoolRolesResponse -> m SetIdentityPoolRolesResponse #

Read SetIdentityPoolRolesResponse # 
Show SetIdentityPoolRolesResponse # 
Generic SetIdentityPoolRolesResponse # 
NFData SetIdentityPoolRolesResponse # 
type Rep SetIdentityPoolRolesResponse # 
type Rep SetIdentityPoolRolesResponse = D1 * (MetaData "SetIdentityPoolRolesResponse" "Network.AWS.CognitoIdentity.SetIdentityPoolRoles" "amazonka-cognito-identity-1.6.0-7Jg9Nyngsx05LwQn1SZzEq" False) (C1 * (MetaCons "SetIdentityPoolRolesResponse'" PrefixI False) (U1 *))