Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.ListGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the groups associated with a user pool.

Calling this action requires developer credentials.

This operation returns paginated results.

Synopsis

data ListGroups = ListGroups' {
- nextToken :: Maybe Text
- limit :: Maybe Natural
- userPoolId :: Text
}
newListGroups :: Text -> ListGroups
listGroups_nextToken :: Lens' ListGroups (Maybe Text)
listGroups_limit :: Lens' ListGroups (Maybe Natural)
listGroups_userPoolId :: Lens' ListGroups Text
data ListGroupsResponse = ListGroupsResponse' {
- groups :: Maybe [GroupType]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListGroupsResponse :: Int -> ListGroupsResponse
listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupType])
listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int

Creating a Request

data ListGroups Source #

See: newListGroups smart constructor.

Constructors

ListGroups'
Fields nextToken :: Maybe Text An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. limit :: Maybe Natural The limit of the request to list groups. userPoolId :: Text The user pool ID for the user pool.

Instances

Instances details

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

newListGroups Source #

Arguments

:: Text	`$sel:userPoolId:ListGroups'`
-> ListGroups

Create a value of ListGroups 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:nextToken:ListGroups', listGroups_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

$sel:limit:ListGroups', listGroups_limit - The limit of the request to list groups.

$sel:userPoolId:ListGroups', listGroups_userPoolId - The user pool ID for the user pool.

Request Lenses

listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listGroups_limit :: Lens' ListGroups (Maybe Natural) Source #

The limit of the request to list groups.

listGroups_userPoolId :: Lens' ListGroups Text Source #

The user pool ID for the user pool.

Destructuring the Response

data ListGroupsResponse Source #

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse'
Fields groups :: Maybe [GroupType] The group objects for the groups. nextToken :: Maybe Text An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListGroupsResponse Source #

Arguments

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

Create a value of ListGroupsResponse 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:groups:ListGroupsResponse', listGroupsResponse_groups - The group objects for the groups.

$sel:nextToken:ListGroups', listGroupsResponse_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listGroupsResponse_groups :: Lens' ListGroupsResponse (Maybe [GroupType]) Source #

The group objects for the groups.

listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #

The response's http status code.