libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.DescribeUserPool

Description

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

Synopsis

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
Eq DescribeUserPool Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

Methods

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

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

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 #

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 #

NFData DescribeUserPool Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

Methods

rnf :: DescribeUserPool -> () #

Hashable DescribeUserPool Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

Methods

hashWithSalt :: Int -> DescribeUserPool -> Int #

hash :: DescribeUserPool -> Int #

ToJSON DescribeUserPool Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

Methods

toJSON :: DescribeUserPool -> Value #

toEncoding :: DescribeUserPool -> Encoding #

toJSONList :: [DescribeUserPool] -> Value #

toEncodingList :: [DescribeUserPool] -> Encoding #

AWSRequest DescribeUserPool Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

Associated Types

type AWSResponse DescribeUserPool #

Methods

request :: DescribeUserPool -> Request DescribeUserPool #

response :: MonadResource m => Logger -> Service -> Proxy DescribeUserPool -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUserPool))) #

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 #

type Rep DescribeUserPool Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

type Rep DescribeUserPool = D1 ('MetaData "DescribeUserPool" "Amazonka.CognitoIdentityProvider.DescribeUserPool" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "DescribeUserPool'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeUserPool Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

type AWSResponse DescribeUserPool = DescribeUserPoolResponse

newDescribeUserPool Source #

Arguments

:: Text

$sel:userPoolId: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:

$sel:userPoolId: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

Instances

Instances details
Eq DescribeUserPoolResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

Methods

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

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

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 #

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 #

NFData DescribeUserPoolResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

Methods

rnf :: DescribeUserPoolResponse -> () #

type Rep DescribeUserPoolResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DescribeUserPool

type Rep DescribeUserPoolResponse = D1 ('MetaData "DescribeUserPoolResponse" "Amazonka.CognitoIdentityProvider.DescribeUserPool" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" '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.