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.CognitoIdentity.SetIdentityPoolRoles

Contents

Creating a Request
Request Lenses
Destructuring the Response

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.

Creating a Request

data SetIdentityPoolRoles Source #

Input to the SetIdentityPoolRoles action.

See: newSetIdentityPoolRoles smart constructor.

Constructors

SetIdentityPoolRoles'

Fields

roleMappings :: Maybe (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.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
Up to 25 rules can be specified per identity provider.
identityPoolId :: Text
An identity pool ID in the format REGION:GUID.
roles :: 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.

Instances

Instances details

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

newSetIdentityPoolRoles Source #

Arguments

:: Text	`SetIdentityPoolRoles`
-> SetIdentityPoolRoles

Create a value of SetIdentityPoolRoles 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:roleMappings:SetIdentityPoolRoles', setIdentityPoolRoles_roleMappings - 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.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Up to 25 rules can be specified per identity provider.

SetIdentityPoolRoles, setIdentityPoolRoles_identityPoolId - An identity pool ID in the format REGION:GUID.

$sel:roles:SetIdentityPoolRoles', setIdentityPoolRoles_roles - 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.

Request Lenses

setIdentityPoolRoles_roleMappings :: Lens' SetIdentityPoolRoles (Maybe (HashMap Text RoleMapping)) Source #

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.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Up to 25 rules can be specified per identity provider.

setIdentityPoolRoles_identityPoolId :: Lens' SetIdentityPoolRoles Text Source #

An identity pool ID in the format REGION:GUID.

setIdentityPoolRoles_roles :: Lens' SetIdentityPoolRoles (HashMap Text Text) Source #

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

data SetIdentityPoolRolesResponse Source #

See: newSetIdentityPoolRolesResponse smart constructor.

Constructors

SetIdentityPoolRolesResponse'

Instances

Instances details

Generic SetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.SetIdentityPoolRoles Associated Types type Rep SetIdentityPoolRolesResponse :: Type -> Type # Methods from :: SetIdentityPoolRolesResponse -> Rep SetIdentityPoolRolesResponse x # to :: Rep SetIdentityPoolRolesResponse x -> SetIdentityPoolRolesResponse #
Read SetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.SetIdentityPoolRoles Methods readsPrec :: Int -> ReadS SetIdentityPoolRolesResponse # readList :: ReadS [SetIdentityPoolRolesResponse] # readPrec :: ReadPrec SetIdentityPoolRolesResponse # readListPrec :: ReadPrec [SetIdentityPoolRolesResponse] #
Show SetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.SetIdentityPoolRoles Methods showsPrec :: Int -> SetIdentityPoolRolesResponse -> ShowS # show :: SetIdentityPoolRolesResponse -> String # showList :: [SetIdentityPoolRolesResponse] -> ShowS #
NFData SetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.SetIdentityPoolRoles Methods rnf :: SetIdentityPoolRolesResponse -> () #
Eq SetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.SetIdentityPoolRoles Methods (==) :: SetIdentityPoolRolesResponse -> SetIdentityPoolRolesResponse -> Bool # (/=) :: SetIdentityPoolRolesResponse -> SetIdentityPoolRolesResponse -> Bool #
type Rep SetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.SetIdentityPoolRoles type Rep SetIdentityPoolRolesResponse = D1 ('MetaData "SetIdentityPoolRolesResponse" "Amazonka.CognitoIdentity.SetIdentityPoolRoles" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "SetIdentityPoolRolesResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetIdentityPoolRolesResponse :: SetIdentityPoolRolesResponse Source #

Create a value of SetIdentityPoolRolesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.