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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the users in the specified group.

Calling this action requires developer credentials.

This operation returns paginated results.

Synopsis

data ListUsersInGroup = ListUsersInGroup' {
- limit :: Maybe Natural
- nextToken :: Maybe Text
- userPoolId :: Text
- groupName :: Text
}
newListUsersInGroup :: Text -> Text -> ListUsersInGroup
listUsersInGroup_limit :: Lens' ListUsersInGroup (Maybe Natural)
listUsersInGroup_nextToken :: Lens' ListUsersInGroup (Maybe Text)
listUsersInGroup_userPoolId :: Lens' ListUsersInGroup Text
listUsersInGroup_groupName :: Lens' ListUsersInGroup Text
data ListUsersInGroupResponse = ListUsersInGroupResponse' {
- nextToken :: Maybe Text
- users :: Maybe [UserType]
- httpStatus :: Int
}
newListUsersInGroupResponse :: Int -> ListUsersInGroupResponse
listUsersInGroupResponse_nextToken :: Lens' ListUsersInGroupResponse (Maybe Text)
listUsersInGroupResponse_users :: Lens' ListUsersInGroupResponse (Maybe [UserType])
listUsersInGroupResponse_httpStatus :: Lens' ListUsersInGroupResponse Int

Creating a Request

data ListUsersInGroup Source #

See: newListUsersInGroup smart constructor.

Constructors

ListUsersInGroup'
Fields limit :: Maybe Natural The limit of the request to list users. 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. userPoolId :: Text The user pool ID for the user pool. groupName :: Text The name of the group.

Instances

Instances details

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

newListUsersInGroup Source #

Arguments

:: Text	`ListUsersInGroup`
-> Text	`ListUsersInGroup`
-> ListUsersInGroup

Create a value of ListUsersInGroup 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:limit:ListUsersInGroup', listUsersInGroup_limit - The limit of the request to list users.

ListUsersInGroup, listUsersInGroup_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.

ListUsersInGroup, listUsersInGroup_userPoolId - The user pool ID for the user pool.

ListUsersInGroup, listUsersInGroup_groupName - The name of the group.

Request Lenses

listUsersInGroup_limit :: Lens' ListUsersInGroup (Maybe Natural) Source #

The limit of the request to list users.

listUsersInGroup_nextToken :: Lens' ListUsersInGroup (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.

listUsersInGroup_userPoolId :: Lens' ListUsersInGroup Text Source #

The user pool ID for the user pool.

listUsersInGroup_groupName :: Lens' ListUsersInGroup Text Source #

The name of the group.

Destructuring the Response

data ListUsersInGroupResponse Source #

See: newListUsersInGroupResponse smart constructor.

Constructors

ListUsersInGroupResponse'
Fields nextToken :: Maybe Text An identifier that you can use in a later request to return the next set of items in the list. users :: Maybe [UserType] The users returned in the request to list users. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListUsersInGroupResponse Source #

Arguments

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

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

ListUsersInGroup, listUsersInGroupResponse_nextToken - An identifier that you can use in a later request to return the next set of items in the list.

$sel:users:ListUsersInGroupResponse', listUsersInGroupResponse_users - The users returned in the request to list users.

$sel:httpStatus:ListUsersInGroupResponse', listUsersInGroupResponse_httpStatus - The response's http status code.

Response Lenses

listUsersInGroupResponse_nextToken :: Lens' ListUsersInGroupResponse (Maybe Text) Source #

An identifier that you can use in a later request to return the next set of items in the list.

listUsersInGroupResponse_users :: Lens' ListUsersInGroupResponse (Maybe [UserType]) Source #

The users returned in the request to list users.

listUsersInGroupResponse_httpStatus :: Lens' ListUsersInGroupResponse Int Source #

The response's http status code.