Network.AWS.CognitoIdentity.GetCredentialsForIdentity

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

Creating a Request

getCredentialsForIdentity

Arguments

:: Text

gcfiIdentityId

-> GetCredentialsForIdentity

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

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

• gcfiCustomRoleARN - The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.
• gcfiLogins - A set of optional name-value pairs that map provider names to provider tokens.
• gcfiIdentityId - A unique identifier in the format REGION:GUID.

data GetCredentialsForIdentity

Input to the GetCredentialsForIdentity action.

See: getCredentialsForIdentity smart constructor.

Instances

Eq GetCredentialsForIdentity

Methods

(==) :: GetCredentialsForIdentity -> GetCredentialsForIdentity -> Bool

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

Data GetCredentialsForIdentity

Methods

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

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

toConstr :: GetCredentialsForIdentity -> Constr

dataTypeOf :: GetCredentialsForIdentity -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetCredentialsForIdentity -> GetCredentialsForIdentity

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

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

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

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

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

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

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

Read GetCredentialsForIdentity

Methods

readsPrec :: Int -> ReadS GetCredentialsForIdentity

readList :: ReadS [GetCredentialsForIdentity]

readPrec :: ReadPrec GetCredentialsForIdentity

readListPrec :: ReadPrec [GetCredentialsForIdentity]

Show GetCredentialsForIdentity

Methods

showsPrec :: Int -> GetCredentialsForIdentity -> ShowS

show :: GetCredentialsForIdentity -> String

showList :: [GetCredentialsForIdentity] -> ShowS

Generic GetCredentialsForIdentity

Associated Types

type Rep GetCredentialsForIdentity :: * -> *

Methods

from :: GetCredentialsForIdentity -> Rep GetCredentialsForIdentity x

to :: Rep GetCredentialsForIdentity x -> GetCredentialsForIdentity

Hashable GetCredentialsForIdentity

Methods

hashWithSalt :: Int -> GetCredentialsForIdentity -> Int

hash :: GetCredentialsForIdentity -> Int

ToJSON GetCredentialsForIdentity

Methods

toJSON :: GetCredentialsForIdentity -> Value

toEncoding :: GetCredentialsForIdentity -> Encoding

toJSONList :: [GetCredentialsForIdentity] -> Value

toEncodingList :: [GetCredentialsForIdentity] -> Encoding

NFData GetCredentialsForIdentity

Methods

rnf :: GetCredentialsForIdentity -> ()

AWSRequest GetCredentialsForIdentity

Associated Types

type Rs GetCredentialsForIdentity :: *

Methods

request :: GetCredentialsForIdentity -> Request GetCredentialsForIdentity

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

ToPath GetCredentialsForIdentity

Methods

toPath :: GetCredentialsForIdentity -> ByteString

ToHeaders GetCredentialsForIdentity

Methods

toHeaders :: GetCredentialsForIdentity -> [Header]

ToQuery GetCredentialsForIdentity

Methods

toQuery :: GetCredentialsForIdentity -> QueryString

type Rep GetCredentialsForIdentity

type Rep GetCredentialsForIdentity = D1 (MetaData "GetCredentialsForIdentity" "Network.AWS.CognitoIdentity.GetCredentialsForIdentity" "amazonka-cognito-identity-1.4.5-FQJQgy9jw2zGp3zOnk88Lj" False) (C1 (MetaCons "GetCredentialsForIdentity'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gcfiCustomRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gcfiLogins") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_gcfiIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetCredentialsForIdentity

type Rs GetCredentialsForIdentity = GetCredentialsForIdentityResponse

Request Lenses

gcfiCustomRoleARN :: Lens' GetCredentialsForIdentity (Maybe Text)

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

gcfiLogins :: Lens' GetCredentialsForIdentity (HashMap Text Text)

A set of optional name-value pairs that map provider names to provider tokens.

gcfiIdentityId :: Lens' GetCredentialsForIdentity Text

A unique identifier in the format REGION:GUID.

Destructuring the Response

getCredentialsForIdentityResponse

Arguments

:: Int

gcfirsResponseStatus

-> GetCredentialsForIdentityResponse

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

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

• gcfirsCredentials - Credentials for the provided identity ID.
• gcfirsIdentityId - A unique identifier in the format REGION:GUID.
• gcfirsResponseStatus - -- | The response status code.

data GetCredentialsForIdentityResponse

Returned in response to a successful GetCredentialsForIdentity operation.

See: getCredentialsForIdentityResponse smart constructor.

Instances

Eq GetCredentialsForIdentityResponse

Methods

(==) :: GetCredentialsForIdentityResponse -> GetCredentialsForIdentityResponse -> Bool

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

Data GetCredentialsForIdentityResponse

Methods

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

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

toConstr :: GetCredentialsForIdentityResponse -> Constr

dataTypeOf :: GetCredentialsForIdentityResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetCredentialsForIdentityResponse -> GetCredentialsForIdentityResponse

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

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

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

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

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

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

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

Read GetCredentialsForIdentityResponse

Methods

readsPrec :: Int -> ReadS GetCredentialsForIdentityResponse

readList :: ReadS [GetCredentialsForIdentityResponse]

readPrec :: ReadPrec GetCredentialsForIdentityResponse

readListPrec :: ReadPrec [GetCredentialsForIdentityResponse]

Show GetCredentialsForIdentityResponse

Methods

showsPrec :: Int -> GetCredentialsForIdentityResponse -> ShowS

show :: GetCredentialsForIdentityResponse -> String

showList :: [GetCredentialsForIdentityResponse] -> ShowS

Generic GetCredentialsForIdentityResponse

Associated Types

type Rep GetCredentialsForIdentityResponse :: * -> *

Methods

from :: GetCredentialsForIdentityResponse -> Rep GetCredentialsForIdentityResponse x

to :: Rep GetCredentialsForIdentityResponse x -> GetCredentialsForIdentityResponse

NFData GetCredentialsForIdentityResponse

Methods

rnf :: GetCredentialsForIdentityResponse -> ()

type Rep GetCredentialsForIdentityResponse

type Rep GetCredentialsForIdentityResponse = D1 (MetaData "GetCredentialsForIdentityResponse" "Network.AWS.CognitoIdentity.GetCredentialsForIdentity" "amazonka-cognito-identity-1.4.5-FQJQgy9jw2zGp3zOnk88Lj" False) (C1 (MetaCons "GetCredentialsForIdentityResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gcfirsCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Credentials))) ((:*:) (S1 (MetaSel (Just Symbol "_gcfirsIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gcfirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gcfirsCredentials :: Lens' GetCredentialsForIdentityResponse (Maybe Credentials)

Credentials for the provided identity ID.

gcfirsIdentityId :: Lens' GetCredentialsForIdentityResponse (Maybe Text)

A unique identifier in the format REGION:GUID.

gcfirsResponseStatus :: Lens' GetCredentialsForIdentityResponse Int

• - | The response status code.