Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Lists the groups that the user belongs to.

Calling this action requires developer credentials.

This operation returns paginated results.

Creating a Request

data AdminListGroupsForUser

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

ToJSON AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

toJSON :: AdminListGroupsForUser -> Value

toEncoding :: AdminListGroupsForUser -> Encoding

toJSONList :: [AdminListGroupsForUser] -> Value

toEncodingList :: [AdminListGroupsForUser] -> Encoding

ToHeaders AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

toHeaders :: AdminListGroupsForUser -> [Header]

ToPath AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

toPath :: AdminListGroupsForUser -> ByteString

ToQuery AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

toQuery :: AdminListGroupsForUser -> QueryString

AWSPager AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

page :: AdminListGroupsForUser -> AWSResponse AdminListGroupsForUser -> Maybe AdminListGroupsForUser

AWSRequest AdminListGroupsForUser

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

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

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

showsPrec :: Int -> AdminListGroupsForUser -> ShowS

show :: AdminListGroupsForUser -> String

showList :: [AdminListGroupsForUser] -> ShowS

NFData AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

rnf :: AdminListGroupsForUser -> ()

Eq AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

(==) :: AdminListGroupsForUser -> AdminListGroupsForUser -> Bool

(/=) :: AdminListGroupsForUser -> AdminListGroupsForUser -> Bool

Hashable AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

hashWithSalt :: Int -> AdminListGroupsForUser -> Int

hash :: AdminListGroupsForUser -> Int

type AWSResponse AdminListGroupsForUser

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

type AWSResponse AdminListGroupsForUser = AdminListGroupsForUserResponse

type Rep AdminListGroupsForUser

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

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)

The limit of the request to list groups.

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

adminListGroupsForUser_username :: Lens' AdminListGroupsForUser Text

The username for the user.

adminListGroupsForUser_userPoolId :: Lens' AdminListGroupsForUser Text

The user pool ID for the user pool.

Destructuring the Response

data AdminListGroupsForUserResponse

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

Generic AdminListGroupsForUserResponse

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

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

readsPrec :: Int -> ReadS AdminListGroupsForUserResponse

readList :: ReadS [AdminListGroupsForUserResponse]

readPrec :: ReadPrec AdminListGroupsForUserResponse

readListPrec :: ReadPrec [AdminListGroupsForUserResponse]

Show AdminListGroupsForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

showsPrec :: Int -> AdminListGroupsForUserResponse -> ShowS

show :: AdminListGroupsForUserResponse -> String

showList :: [AdminListGroupsForUserResponse] -> ShowS

NFData AdminListGroupsForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

rnf :: AdminListGroupsForUserResponse -> ()

Eq AdminListGroupsForUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminListGroupsForUser

Methods

(==) :: AdminListGroupsForUserResponse -> AdminListGroupsForUserResponse -> Bool

(/=) :: AdminListGroupsForUserResponse -> AdminListGroupsForUserResponse -> Bool

type Rep AdminListGroupsForUserResponse

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

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])

The groups that the user belongs to.

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

adminListGroupsForUserResponse_httpStatus :: Lens' AdminListGroupsForUserResponse Int

The response's http status code.