Network.AWS.CognitoIdentityProvider.DescribeUserPool

Returns the configuration information and metadata of the specified user pool.

Creating a Request

describeUserPool

Arguments

:: Text

dUserPoolId

-> DescribeUserPool

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

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

• dUserPoolId - The user pool ID for the user pool you want to describe.

data DescribeUserPool

Represents the request to describe the user pool.

See: describeUserPool smart constructor.

Instances

Eq DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

(==) :: DescribeUserPool -> DescribeUserPool -> Bool

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

Data DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

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

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

toConstr :: DescribeUserPool -> Constr

dataTypeOf :: DescribeUserPool -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

readsPrec :: Int -> ReadS DescribeUserPool

readList :: ReadS [DescribeUserPool]

readPrec :: ReadPrec DescribeUserPool

readListPrec :: ReadPrec [DescribeUserPool]

Show DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

showsPrec :: Int -> DescribeUserPool -> ShowS

show :: DescribeUserPool -> String

showList :: [DescribeUserPool] -> ShowS

Generic DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Associated Types

type Rep DescribeUserPool :: Type -> Type

Methods

from :: DescribeUserPool -> Rep DescribeUserPool x

to :: Rep DescribeUserPool x -> DescribeUserPool

Hashable DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

hashWithSalt :: Int -> DescribeUserPool -> Int

hash :: DescribeUserPool -> Int

ToJSON DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

toJSON :: DescribeUserPool -> Value

toEncoding :: DescribeUserPool -> Encoding

toJSONList :: [DescribeUserPool] -> Value

toEncodingList :: [DescribeUserPool] -> Encoding

AWSRequest DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Associated Types

type Rs DescribeUserPool :: Type

Methods

request :: DescribeUserPool -> Request DescribeUserPool

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

ToHeaders DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

toHeaders :: DescribeUserPool -> [Header]

ToPath DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

toPath :: DescribeUserPool -> ByteString

ToQuery DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

toQuery :: DescribeUserPool -> QueryString

NFData DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

rnf :: DescribeUserPool -> ()

type Rep DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

type Rep DescribeUserPool = D1 (MetaData "DescribeUserPool" "Network.AWS.CognitoIdentityProvider.DescribeUserPool" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" True) (C1 (MetaCons "DescribeUserPool'" PrefixI True) (S1 (MetaSel (Just "_dUserPoolId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs DescribeUserPool

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

type Rs DescribeUserPool = DescribeUserPoolResponse

Request Lenses

dUserPoolId :: Lens' DescribeUserPool Text

The user pool ID for the user pool you want to describe.

Destructuring the Response

describeUserPoolResponse

Arguments

:: Int

duprsResponseStatus

-> DescribeUserPoolResponse

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

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

• duprsUserPool - The container of metadata returned by the server to describe the pool.
• duprsResponseStatus - -- | The response status code.

data DescribeUserPoolResponse

Represents the response to describe the user pool.

See: describeUserPoolResponse smart constructor.

Instances

Eq DescribeUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

(==) :: DescribeUserPoolResponse -> DescribeUserPoolResponse -> Bool

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

Data DescribeUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

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

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

toConstr :: DescribeUserPoolResponse -> Constr

dataTypeOf :: DescribeUserPoolResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

readsPrec :: Int -> ReadS DescribeUserPoolResponse

readList :: ReadS [DescribeUserPoolResponse]

readPrec :: ReadPrec DescribeUserPoolResponse

readListPrec :: ReadPrec [DescribeUserPoolResponse]

Show DescribeUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

showsPrec :: Int -> DescribeUserPoolResponse -> ShowS

show :: DescribeUserPoolResponse -> String

showList :: [DescribeUserPoolResponse] -> ShowS

Generic DescribeUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Associated Types

type Rep DescribeUserPoolResponse :: Type -> Type

Methods

from :: DescribeUserPoolResponse -> Rep DescribeUserPoolResponse x

to :: Rep DescribeUserPoolResponse x -> DescribeUserPoolResponse

NFData DescribeUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

Methods

rnf :: DescribeUserPoolResponse -> ()

type Rep DescribeUserPoolResponse

Defined in Network.AWS.CognitoIdentityProvider.DescribeUserPool

type Rep DescribeUserPoolResponse = D1 (MetaData "DescribeUserPoolResponse" "Network.AWS.CognitoIdentityProvider.DescribeUserPool" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "DescribeUserPoolResponse'" PrefixI True) (S1 (MetaSel (Just "_duprsUserPool") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UserPoolType)) :*: S1 (MetaSel (Just "_duprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

duprsUserPool :: Lens' DescribeUserPoolResponse (Maybe UserPoolType)

The container of metadata returned by the server to describe the pool.

duprsResponseStatus :: Lens' DescribeUserPoolResponse Int

• - | The response status code.