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.CognitoIdentityProvider.DescribeUserPool

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeUserPool Source #

Represents the request to describe the user pool.

See: newDescribeUserPool smart constructor.

Constructors

DescribeUserPool'
Fields userPoolId :: Text The user pool ID for the user pool you want to describe.

Instances

Instances details

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

newDescribeUserPool Source #

Arguments

:: Text	`DescribeUserPool`
-> DescribeUserPool

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

DescribeUserPool, describeUserPool_userPoolId - The user pool ID for the user pool you want to describe.

Request Lenses

describeUserPool_userPoolId :: Lens' DescribeUserPool Text Source #

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

Destructuring the Response

data DescribeUserPoolResponse Source #

Represents the response to describe the user pool.

See: newDescribeUserPoolResponse smart constructor.

Constructors

DescribeUserPoolResponse'
Fields userPool :: Maybe UserPoolType The container of metadata returned by the server to describe the pool. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeUserPoolResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool Associated Types type Rep DescribeUserPoolResponse :: Type -> Type # Methods from :: DescribeUserPoolResponse -> Rep DescribeUserPoolResponse x # to :: Rep DescribeUserPoolResponse x -> DescribeUserPoolResponse #
Read DescribeUserPoolResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool Methods readsPrec :: Int -> ReadS DescribeUserPoolResponse # readList :: ReadS [DescribeUserPoolResponse] # readPrec :: ReadPrec DescribeUserPoolResponse # readListPrec :: ReadPrec [DescribeUserPoolResponse] #
Show DescribeUserPoolResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool Methods showsPrec :: Int -> DescribeUserPoolResponse -> ShowS # show :: DescribeUserPoolResponse -> String # showList :: [DescribeUserPoolResponse] -> ShowS #
NFData DescribeUserPoolResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool Methods rnf :: DescribeUserPoolResponse -> () #
Eq DescribeUserPoolResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool Methods (==) :: DescribeUserPoolResponse -> DescribeUserPoolResponse -> Bool # (/=) :: DescribeUserPoolResponse -> DescribeUserPoolResponse -> Bool #
type Rep DescribeUserPoolResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool type Rep DescribeUserPoolResponse = D1 ('MetaData "DescribeUserPoolResponse" "Amazonka.CognitoIdentityProvider.DescribeUserPool" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "DescribeUserPoolResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserPoolType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeUserPoolResponse Source #

Arguments

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

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

$sel:userPool:DescribeUserPoolResponse', describeUserPoolResponse_userPool - The container of metadata returned by the server to describe the pool.

$sel:httpStatus:DescribeUserPoolResponse', describeUserPoolResponse_httpStatus - The response's http status code.

Response Lenses

describeUserPoolResponse_userPool :: Lens' DescribeUserPoolResponse (Maybe UserPoolType) Source #

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

describeUserPoolResponse_httpStatus :: Lens' DescribeUserPoolResponse Int Source #

The response's http status code.