Network.AWS.CognitoIdentity.DescribeIdentityPool

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Creating a Request

describeIdentityPool

Arguments

:: Text

dipIdentityPoolId

-> DescribeIdentityPool

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

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

• dipIdentityPoolId

data DescribeIdentityPool

Input to the DescribeIdentityPool action.

See: describeIdentityPool smart constructor.

Instances

Eq DescribeIdentityPool

Methods

(==) :: DescribeIdentityPool -> DescribeIdentityPool -> Bool

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

Data DescribeIdentityPool

Methods

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

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

toConstr :: DescribeIdentityPool -> Constr

dataTypeOf :: DescribeIdentityPool -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeIdentityPool

Methods

readsPrec :: Int -> ReadS DescribeIdentityPool

readList :: ReadS [DescribeIdentityPool]

readPrec :: ReadPrec DescribeIdentityPool

readListPrec :: ReadPrec [DescribeIdentityPool]

Show DescribeIdentityPool

Methods

showsPrec :: Int -> DescribeIdentityPool -> ShowS

show :: DescribeIdentityPool -> String

showList :: [DescribeIdentityPool] -> ShowS

Generic DescribeIdentityPool

Associated Types

type Rep DescribeIdentityPool :: * -> *

Methods

from :: DescribeIdentityPool -> Rep DescribeIdentityPool x

to :: Rep DescribeIdentityPool x -> DescribeIdentityPool

Hashable DescribeIdentityPool

Methods

hashWithSalt :: Int -> DescribeIdentityPool -> Int

hash :: DescribeIdentityPool -> Int

NFData DescribeIdentityPool

Methods

rnf :: DescribeIdentityPool -> ()

AWSRequest DescribeIdentityPool

Associated Types

type Rs DescribeIdentityPool :: *

Methods

request :: DescribeIdentityPool -> Request DescribeIdentityPool

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

ToPath DescribeIdentityPool

Methods

toPath :: DescribeIdentityPool -> ByteString

ToHeaders DescribeIdentityPool

Methods

toHeaders :: DescribeIdentityPool -> [Header]

ToQuery DescribeIdentityPool

Methods

toQuery :: DescribeIdentityPool -> QueryString

ToJSON DescribeIdentityPool

Methods

toJSON :: DescribeIdentityPool -> Value

toEncoding :: DescribeIdentityPool -> Encoding

type Rep DescribeIdentityPool

type Rep DescribeIdentityPool = D1 (MetaData "DescribeIdentityPool" "Network.AWS.CognitoIdentity.DescribeIdentityPool" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" True) (C1 (MetaCons "DescribeIdentityPool'" PrefixI True) (S1 (MetaSel (Just Symbol "_dipIdentityPoolId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs DescribeIdentityPool

type Rs DescribeIdentityPool = IdentityPool

Request Lenses

dipIdentityPoolId :: Lens' DescribeIdentityPool Text

An identity pool ID in the format REGION:GUID.

Destructuring the Response

identityPool

Arguments

:: Text

ipIdentityPoolId

-> Text

ipIdentityPoolName

-> Bool

ipAllowUnauthenticatedIdentities

-> IdentityPool

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

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

• ipSamlProviderARNs
• ipSupportedLoginProviders
• ipDeveloperProviderName
• ipOpenIdConnectProviderARNs
• ipCognitoIdentityProviders
• ipIdentityPoolId
• ipIdentityPoolName
• ipAllowUnauthenticatedIdentities

data IdentityPool

An object representing a Cognito identity pool.

See: identityPool smart constructor.

Instances

Eq IdentityPool

Methods

(==) :: IdentityPool -> IdentityPool -> Bool

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

Data IdentityPool

Methods

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

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

toConstr :: IdentityPool -> Constr

dataTypeOf :: IdentityPool -> DataType

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

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

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

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

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

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

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

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

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

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

Read IdentityPool

Methods

readsPrec :: Int -> ReadS IdentityPool

readList :: ReadS [IdentityPool]

readPrec :: ReadPrec IdentityPool

readListPrec :: ReadPrec [IdentityPool]

Show IdentityPool

Methods

showsPrec :: Int -> IdentityPool -> ShowS

show :: IdentityPool -> String

showList :: [IdentityPool] -> ShowS

Generic IdentityPool

Associated Types

type Rep IdentityPool :: * -> *

Methods

from :: IdentityPool -> Rep IdentityPool x

to :: Rep IdentityPool x -> IdentityPool

Hashable IdentityPool

Methods

hashWithSalt :: Int -> IdentityPool -> Int

hash :: IdentityPool -> Int

NFData IdentityPool

Methods

rnf :: IdentityPool -> ()

FromJSON IdentityPool

Methods

parseJSON :: Value -> Parser IdentityPool

ToJSON IdentityPool

Methods

toJSON :: IdentityPool -> Value

toEncoding :: IdentityPool -> Encoding

type Rep IdentityPool

type Rep IdentityPool = D1 (MetaData "IdentityPool" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "IdentityPool'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ipSamlProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_ipSupportedLoginProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ipDeveloperProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ipOpenIdConnectProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ipCognitoIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider]))) (S1 (MetaSel (Just Symbol "_ipIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ipIdentityPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ipAllowUnauthenticatedIdentities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))))

Response Lenses

ipSamlProviderARNs :: Lens' IdentityPool [Text]

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

ipSupportedLoginProviders :: Lens' IdentityPool (HashMap Text Text)

Optional key:value pairs mapping provider names to provider app IDs.

ipDeveloperProviderName :: Lens' IdentityPool (Maybe Text)

The "domain" by which Cognito will refer to your users.

ipOpenIdConnectProviderARNs :: Lens' IdentityPool [Text]

A list of OpendID Connect provider ARNs.

ipCognitoIdentityProviders :: Lens' IdentityPool [CognitoIdentityProvider]

A list representing an Amazon Cognito Identity User Pool and its client ID.

ipIdentityPoolId :: Lens' IdentityPool Text

An identity pool ID in the format REGION:GUID.

ipIdentityPoolName :: Lens' IdentityPool Text

A string that you provide.

ipAllowUnauthenticatedIdentities :: Lens' IdentityPool Bool

TRUE if the identity pool supports unauthenticated logins.