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 - An identity pool ID in the format REGION:GUID.

data DescribeIdentityPool

Input to the DescribeIdentityPool action.

See: describeIdentityPool smart constructor.

Instances

Eq DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

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

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

Data DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.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

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

readsPrec :: Int -> ReadS DescribeIdentityPool

readList :: ReadS [DescribeIdentityPool]

readPrec :: ReadPrec DescribeIdentityPool

readListPrec :: ReadPrec [DescribeIdentityPool]

Show DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

showsPrec :: Int -> DescribeIdentityPool -> ShowS

show :: DescribeIdentityPool -> String

showList :: [DescribeIdentityPool] -> ShowS

Generic DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Associated Types

type Rep DescribeIdentityPool :: Type -> Type

Methods

from :: DescribeIdentityPool -> Rep DescribeIdentityPool x

to :: Rep DescribeIdentityPool x -> DescribeIdentityPool

Hashable DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

hashWithSalt :: Int -> DescribeIdentityPool -> Int

hash :: DescribeIdentityPool -> Int

ToJSON DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

toJSON :: DescribeIdentityPool -> Value

toEncoding :: DescribeIdentityPool -> Encoding

toJSONList :: [DescribeIdentityPool] -> Value

toEncodingList :: [DescribeIdentityPool] -> Encoding

AWSRequest DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Associated Types

type Rs DescribeIdentityPool :: Type

Methods

request :: DescribeIdentityPool -> Request DescribeIdentityPool

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

ToHeaders DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

toHeaders :: DescribeIdentityPool -> [Header]

ToPath DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

toPath :: DescribeIdentityPool -> ByteString

ToQuery DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

toQuery :: DescribeIdentityPool -> QueryString

NFData DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

Methods

rnf :: DescribeIdentityPool -> ()

type Rep DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.DescribeIdentityPool

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

type Rs DescribeIdentityPool

Defined in Network.AWS.CognitoIdentity.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 - An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
• ipSupportedLoginProviders - Optional key:value pairs mapping provider names to provider app IDs.
• ipDeveloperProviderName - The "domain" by which Cognito will refer to your users.
• ipOpenIdConnectProviderARNs - A list of OpendID Connect provider ARNs.
• ipCognitoIdentityProviders - A list representing an Amazon Cognito Identity User Pool and its client ID.
• ipIdentityPoolId - An identity pool ID in the format REGION:GUID.
• ipIdentityPoolName - A string that you provide.
• ipAllowUnauthenticatedIdentities - TRUE if the identity pool supports unauthenticated logins.

data IdentityPool

An object representing an Amazon Cognito identity pool.

See: identityPool smart constructor.

Instances

Eq IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

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

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

Data IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

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

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

readsPrec :: Int -> ReadS IdentityPool

readList :: ReadS [IdentityPool]

readPrec :: ReadPrec IdentityPool

readListPrec :: ReadPrec [IdentityPool]

Show IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

showsPrec :: Int -> IdentityPool -> ShowS

show :: IdentityPool -> String

showList :: [IdentityPool] -> ShowS

Generic IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

Associated Types

type Rep IdentityPool :: Type -> Type

Methods

from :: IdentityPool -> Rep IdentityPool x

to :: Rep IdentityPool x -> IdentityPool

Hashable IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

hashWithSalt :: Int -> IdentityPool -> Int

hash :: IdentityPool -> Int

ToJSON IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

toJSON :: IdentityPool -> Value

toEncoding :: IdentityPool -> Encoding

toJSONList :: [IdentityPool] -> Value

toEncodingList :: [IdentityPool] -> Encoding

FromJSON IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

parseJSON :: Value -> Parser IdentityPool

parseJSONList :: Value -> Parser [IdentityPool]

NFData IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

Methods

rnf :: IdentityPool -> ()

type Rep IdentityPool

Defined in Network.AWS.CognitoIdentity.Types.Product

type Rep IdentityPool = D1 (MetaData "IdentityPool" "Network.AWS.CognitoIdentity.Types.Product" "amazonka-cognito-identity-1.6.1-JxIOswo68EQKpplMh7b7yR" False) (C1 (MetaCons "IdentityPool'" PrefixI True) (((S1 (MetaSel (Just "_ipSamlProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_ipSupportedLoginProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) :*: (S1 (MetaSel (Just "_ipDeveloperProviderName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ipOpenIdConnectProviderARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_ipCognitoIdentityProviders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CognitoIdentityProvider])) :*: S1 (MetaSel (Just "_ipIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_ipIdentityPoolName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_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.