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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the groups that the user belongs to.

Calling this action requires developer credentials.

This operation returns paginated results.

Synopsis

data AdminListGroupsForUser = AdminListGroupsForUser' {
- limit :: Maybe Natural
- nextToken :: Maybe Text
- username :: Sensitive Text
- userPoolId :: Text
}
newAdminListGroupsForUser :: Text -> Text -> AdminListGroupsForUser
adminListGroupsForUser_limit :: Lens' AdminListGroupsForUser (Maybe Natural)
adminListGroupsForUser_nextToken :: Lens' AdminListGroupsForUser (Maybe Text)
adminListGroupsForUser_username :: Lens' AdminListGroupsForUser Text
adminListGroupsForUser_userPoolId :: Lens' AdminListGroupsForUser Text
data AdminListGroupsForUserResponse = AdminListGroupsForUserResponse' {
- groups :: Maybe [GroupType]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newAdminListGroupsForUserResponse :: Int -> AdminListGroupsForUserResponse
adminListGroupsForUserResponse_groups :: Lens' AdminListGroupsForUserResponse (Maybe [GroupType])
adminListGroupsForUserResponse_nextToken :: Lens' AdminListGroupsForUserResponse (Maybe Text)
adminListGroupsForUserResponse_httpStatus :: Lens' AdminListGroupsForUserResponse Int

Creating a Request

data AdminListGroupsForUser Source #

See: newAdminListGroupsForUser smart constructor.

Constructors

AdminListGroupsForUser'
Fields limit :: Maybe Natural The limit of the request to list 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. username :: Sensitive Text The username for the user. userPoolId :: Text The user pool ID for the user pool.

Instances

Instances details

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

newAdminListGroupsForUser Source #

Arguments

:: Text	`AdminListGroupsForUser`
-> Text	`AdminListGroupsForUser`
-> AdminListGroupsForUser

Create a value of AdminListGroupsForUser 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:AdminListGroupsForUser', adminListGroupsForUser_limit - The limit of the request to list groups.

AdminListGroupsForUser, adminListGroupsForUser_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.

AdminListGroupsForUser, adminListGroupsForUser_username - The username for the user.

AdminListGroupsForUser, adminListGroupsForUser_userPoolId - The user pool ID for the user pool.

Request Lenses

adminListGroupsForUser_limit :: Lens' AdminListGroupsForUser (Maybe Natural) Source #

The limit of the request to list groups.

adminListGroupsForUser_nextToken :: Lens' AdminListGroupsForUser (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.

adminListGroupsForUser_username :: Lens' AdminListGroupsForUser Text Source #

The username for the user.

adminListGroupsForUser_userPoolId :: Lens' AdminListGroupsForUser Text Source #

The user pool ID for the user pool.

Destructuring the Response

data AdminListGroupsForUserResponse Source #

See: newAdminListGroupsForUserResponse smart constructor.

Constructors

AdminListGroupsForUserResponse'
Fields groups :: Maybe [GroupType] The groups that the user belongs to. 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

Generic AdminListGroupsForUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser Associated Types type Rep AdminListGroupsForUserResponse :: Type -> Type # Methods from :: AdminListGroupsForUserResponse -> Rep AdminListGroupsForUserResponse x # to :: Rep AdminListGroupsForUserResponse x -> AdminListGroupsForUserResponse #
Read AdminListGroupsForUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser Methods readsPrec :: Int -> ReadS AdminListGroupsForUserResponse # readList :: ReadS [AdminListGroupsForUserResponse] # readPrec :: ReadPrec AdminListGroupsForUserResponse # readListPrec :: ReadPrec [AdminListGroupsForUserResponse] #
Show AdminListGroupsForUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser Methods showsPrec :: Int -> AdminListGroupsForUserResponse -> ShowS # show :: AdminListGroupsForUserResponse -> String # showList :: [AdminListGroupsForUserResponse] -> ShowS #
NFData AdminListGroupsForUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser Methods rnf :: AdminListGroupsForUserResponse -> () #
Eq AdminListGroupsForUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser Methods (==) :: AdminListGroupsForUserResponse -> AdminListGroupsForUserResponse -> Bool # (/=) :: AdminListGroupsForUserResponse -> AdminListGroupsForUserResponse -> Bool #
type Rep AdminListGroupsForUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser type Rep AdminListGroupsForUserResponse = D1 ('MetaData "AdminListGroupsForUserResponse" "Amazonka.CognitoIdentityProvider.AdminListGroupsForUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminListGroupsForUserResponse'" '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))))

newAdminListGroupsForUserResponse Source #

Arguments

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

Create a value of AdminListGroupsForUserResponse 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:AdminListGroupsForUserResponse', adminListGroupsForUserResponse_groups - The groups that the user belongs to.

AdminListGroupsForUser, adminListGroupsForUserResponse_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:AdminListGroupsForUserResponse', adminListGroupsForUserResponse_httpStatus - The response's http status code.

Response Lenses

adminListGroupsForUserResponse_groups :: Lens' AdminListGroupsForUserResponse (Maybe [GroupType]) Source #

The groups that the user belongs to.

adminListGroupsForUserResponse_nextToken :: Lens' AdminListGroupsForUserResponse (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.

adminListGroupsForUserResponse_httpStatus :: Lens' AdminListGroupsForUserResponse Int Source #

The response's http status code.