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.ListIdentityProviders

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists information about all IdPs for a user pool.

This operation returns paginated results.

Synopsis

Creating a Request

data ListIdentityProviders Source #

See: newListIdentityProviders smart constructor.

Constructors

ListIdentityProviders'
Fields maxResults :: Maybe Natural The maximum number of IdPs to return. nextToken :: Maybe Text A pagination token. userPoolId :: Text The user pool ID.

Instances

Instances details

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

newListIdentityProviders Source #

Arguments

:: Text	`ListIdentityProviders`
-> ListIdentityProviders

Create a value of ListIdentityProviders 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:maxResults:ListIdentityProviders', listIdentityProviders_maxResults - The maximum number of IdPs to return.

ListIdentityProviders, listIdentityProviders_nextToken - A pagination token.

ListIdentityProviders, listIdentityProviders_userPoolId - The user pool ID.

Request Lenses

listIdentityProviders_maxResults :: Lens' ListIdentityProviders (Maybe Natural) Source #

The maximum number of IdPs to return.

listIdentityProviders_nextToken :: Lens' ListIdentityProviders (Maybe Text) Source #

A pagination token.

listIdentityProviders_userPoolId :: Lens' ListIdentityProviders Text Source #

The user pool ID.

Destructuring the Response

data ListIdentityProvidersResponse Source #

See: newListIdentityProvidersResponse smart constructor.

Constructors

ListIdentityProvidersResponse'
Fields nextToken :: Maybe Text A pagination token. httpStatus :: Int The response's http status code. providers :: [ProviderDescription] A list of IdP objects.

Instances

Instances details

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

newListIdentityProvidersResponse Source #

Arguments

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

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

ListIdentityProviders, listIdentityProvidersResponse_nextToken - A pagination token.

$sel:httpStatus:ListIdentityProvidersResponse', listIdentityProvidersResponse_httpStatus - The response's http status code.

$sel:providers:ListIdentityProvidersResponse', listIdentityProvidersResponse_providers - A list of IdP objects.

Response Lenses

listIdentityProvidersResponse_nextToken :: Lens' ListIdentityProvidersResponse (Maybe Text) Source #

A pagination token.

listIdentityProvidersResponse_httpStatus :: Lens' ListIdentityProvidersResponse Int Source #

The response's http status code.

listIdentityProvidersResponse_providers :: Lens' ListIdentityProvidersResponse [ProviderDescription] Source #

A list of IdP objects.