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.GetIdentityPoolRoles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Synopsis

data GetIdentityPoolRoles = GetIdentityPoolRoles' {
- identityPoolId :: Text
}
newGetIdentityPoolRoles :: Text -> GetIdentityPoolRoles
getIdentityPoolRoles_identityPoolId :: Lens' GetIdentityPoolRoles Text
data GetIdentityPoolRolesResponse = GetIdentityPoolRolesResponse' {
- identityPoolId :: Maybe Text
- roleMappings :: Maybe (HashMap Text RoleMapping)
- roles :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newGetIdentityPoolRolesResponse :: Int -> GetIdentityPoolRolesResponse
getIdentityPoolRolesResponse_identityPoolId :: Lens' GetIdentityPoolRolesResponse (Maybe Text)
getIdentityPoolRolesResponse_roleMappings :: Lens' GetIdentityPoolRolesResponse (Maybe (HashMap Text RoleMapping))
getIdentityPoolRolesResponse_roles :: Lens' GetIdentityPoolRolesResponse (Maybe (HashMap Text Text))
getIdentityPoolRolesResponse_httpStatus :: Lens' GetIdentityPoolRolesResponse Int

Creating a Request

data GetIdentityPoolRoles Source #

Input to the GetIdentityPoolRoles action.

See: newGetIdentityPoolRoles smart constructor.

Constructors

GetIdentityPoolRoles'
Fields identityPoolId :: Text An identity pool ID in the format REGION:GUID.

Instances

Instances details

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

newGetIdentityPoolRoles Source #

Arguments

:: Text	`GetIdentityPoolRoles`
-> GetIdentityPoolRoles

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

GetIdentityPoolRoles, getIdentityPoolRoles_identityPoolId - An identity pool ID in the format REGION:GUID.

Request Lenses

getIdentityPoolRoles_identityPoolId :: Lens' GetIdentityPoolRoles Text Source #

An identity pool ID in the format REGION:GUID.

Destructuring the Response

data GetIdentityPoolRolesResponse Source #

Returned in response to a successful GetIdentityPoolRoles operation.

See: newGetIdentityPoolRolesResponse smart constructor.

Constructors

GetIdentityPoolRolesResponse'

Fields

identityPoolId :: Maybe Text
An identity pool ID in the format REGION:GUID.
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".
roles :: Maybe (HashMap Text Text)
The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetIdentityPoolRoles Associated Types type Rep GetIdentityPoolRolesResponse :: Type -> Type # Methods from :: GetIdentityPoolRolesResponse -> Rep GetIdentityPoolRolesResponse x # to :: Rep GetIdentityPoolRolesResponse x -> GetIdentityPoolRolesResponse #
Read GetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetIdentityPoolRoles Methods readsPrec :: Int -> ReadS GetIdentityPoolRolesResponse # readList :: ReadS [GetIdentityPoolRolesResponse] # readPrec :: ReadPrec GetIdentityPoolRolesResponse # readListPrec :: ReadPrec [GetIdentityPoolRolesResponse] #
Show GetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetIdentityPoolRoles Methods showsPrec :: Int -> GetIdentityPoolRolesResponse -> ShowS # show :: GetIdentityPoolRolesResponse -> String # showList :: [GetIdentityPoolRolesResponse] -> ShowS #
NFData GetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetIdentityPoolRoles Methods rnf :: GetIdentityPoolRolesResponse -> () #
Eq GetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetIdentityPoolRoles Methods (==) :: GetIdentityPoolRolesResponse -> GetIdentityPoolRolesResponse -> Bool # (/=) :: GetIdentityPoolRolesResponse -> GetIdentityPoolRolesResponse -> Bool #
type Rep GetIdentityPoolRolesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetIdentityPoolRoles type Rep GetIdentityPoolRolesResponse = D1 ('MetaData "GetIdentityPoolRolesResponse" "Amazonka.CognitoIdentity.GetIdentityPoolRoles" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "GetIdentityPoolRolesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "roleMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RoleMapping)))) :: (S1 ('MetaSel ('Just "roles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetIdentityPoolRolesResponse Source #

Arguments

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

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

GetIdentityPoolRoles, getIdentityPoolRolesResponse_identityPoolId - An identity pool ID in the format REGION:GUID.

$sel:roleMappings:GetIdentityPoolRolesResponse', getIdentityPoolRolesResponse_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".

$sel:roles:GetIdentityPoolRolesResponse', getIdentityPoolRolesResponse_roles - The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

$sel:httpStatus:GetIdentityPoolRolesResponse', getIdentityPoolRolesResponse_httpStatus - The response's http status code.

Response Lenses

getIdentityPoolRolesResponse_identityPoolId :: Lens' GetIdentityPoolRolesResponse (Maybe Text) Source #

An identity pool ID in the format REGION:GUID.

getIdentityPoolRolesResponse_roleMappings :: Lens' GetIdentityPoolRolesResponse (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".

getIdentityPoolRolesResponse_roles :: Lens' GetIdentityPoolRolesResponse (Maybe (HashMap Text Text)) Source #

The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

getIdentityPoolRolesResponse_httpStatus :: Lens' GetIdentityPoolRolesResponse Int Source #

The response's http status code.