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.QuickSight.ListUserGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

Synopsis

data ListUserGroups = ListUserGroups' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- userName :: Text
- awsAccountId :: Text
- namespace :: Text
}
newListUserGroups :: Text -> Text -> Text -> ListUserGroups
listUserGroups_maxResults :: Lens' ListUserGroups (Maybe Natural)
listUserGroups_nextToken :: Lens' ListUserGroups (Maybe Text)
listUserGroups_userName :: Lens' ListUserGroups Text
listUserGroups_awsAccountId :: Lens' ListUserGroups Text
listUserGroups_namespace :: Lens' ListUserGroups Text
data ListUserGroupsResponse = ListUserGroupsResponse' {
- groupList :: Maybe [Group]
- nextToken :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newListUserGroupsResponse :: Int -> ListUserGroupsResponse
listUserGroupsResponse_groupList :: Lens' ListUserGroupsResponse (Maybe [Group])
listUserGroupsResponse_nextToken :: Lens' ListUserGroupsResponse (Maybe Text)
listUserGroupsResponse_requestId :: Lens' ListUserGroupsResponse (Maybe Text)
listUserGroupsResponse_status :: Lens' ListUserGroupsResponse Int

Creating a Request

data ListUserGroups Source #

See: newListUserGroups smart constructor.

Constructors

ListUserGroups'

Fields

maxResults :: Maybe Natural
The maximum number of results to return from this request.
nextToken :: Maybe Text
A pagination token that can be used in a subsequent request.
userName :: Text
The Amazon QuickSight user name that you want to list group memberships for.
awsAccountId :: Text
The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
namespace :: Text
The namespace. Currently, you should set this to default.

Instances

Instances details

ToHeaders ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods toHeaders :: ListUserGroups -> [Header] #
ToPath ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods toPath :: ListUserGroups -> ByteString #
ToQuery ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods toQuery :: ListUserGroups -> QueryString #
AWSRequest ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Associated Types type AWSResponse ListUserGroups # Methods request :: (Service -> Service) -> ListUserGroups -> Request ListUserGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListUserGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUserGroups))) #
Generic ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Associated Types type Rep ListUserGroups :: Type -> Type # Methods from :: ListUserGroups -> Rep ListUserGroups x # to :: Rep ListUserGroups x -> ListUserGroups #
Read ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods readsPrec :: Int -> ReadS ListUserGroups # readList :: ReadS [ListUserGroups] # readPrec :: ReadPrec ListUserGroups # readListPrec :: ReadPrec [ListUserGroups] #
Show ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods showsPrec :: Int -> ListUserGroups -> ShowS # show :: ListUserGroups -> String # showList :: [ListUserGroups] -> ShowS #
NFData ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods rnf :: ListUserGroups -> () #
Eq ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods (==) :: ListUserGroups -> ListUserGroups -> Bool # (/=) :: ListUserGroups -> ListUserGroups -> Bool #
Hashable ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods hashWithSalt :: Int -> ListUserGroups -> Int # hash :: ListUserGroups -> Int #
type AWSResponse ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups type AWSResponse ListUserGroups = ListUserGroupsResponse
type Rep ListUserGroups Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups type Rep ListUserGroups = D1 ('MetaData "ListUserGroups" "Amazonka.QuickSight.ListUserGroups" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "ListUserGroups'" '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 "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListUserGroups Source #

Arguments

:: Text	`ListUserGroups`
-> Text	`ListUserGroups`
-> Text	`ListUserGroups`
-> ListUserGroups

Create a value of ListUserGroups 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:ListUserGroups', listUserGroups_maxResults - The maximum number of results to return from this request.

ListUserGroups, listUserGroups_nextToken - A pagination token that can be used in a subsequent request.

ListUserGroups, listUserGroups_userName - The Amazon QuickSight user name that you want to list group memberships for.

ListUserGroups, listUserGroups_awsAccountId - The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

ListUserGroups, listUserGroups_namespace - The namespace. Currently, you should set this to default.

Request Lenses

listUserGroups_maxResults :: Lens' ListUserGroups (Maybe Natural) Source #

The maximum number of results to return from this request.

listUserGroups_nextToken :: Lens' ListUserGroups (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listUserGroups_userName :: Lens' ListUserGroups Text Source #

The Amazon QuickSight user name that you want to list group memberships for.

listUserGroups_awsAccountId :: Lens' ListUserGroups Text Source #

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

listUserGroups_namespace :: Lens' ListUserGroups Text Source #

The namespace. Currently, you should set this to default.

Destructuring the Response

data ListUserGroupsResponse Source #

See: newListUserGroupsResponse smart constructor.

Constructors

ListUserGroupsResponse'
Fields groupList :: Maybe [Group] The list of groups the user is a member of. nextToken :: Maybe Text A pagination token that can be used in a subsequent request. requestId :: Maybe Text The Amazon Web Services request ID for this operation. status :: Int The HTTP status of the request.

Instances

Instances details

Generic ListUserGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Associated Types type Rep ListUserGroupsResponse :: Type -> Type # Methods from :: ListUserGroupsResponse -> Rep ListUserGroupsResponse x # to :: Rep ListUserGroupsResponse x -> ListUserGroupsResponse #
Read ListUserGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods readsPrec :: Int -> ReadS ListUserGroupsResponse # readList :: ReadS [ListUserGroupsResponse] # readPrec :: ReadPrec ListUserGroupsResponse # readListPrec :: ReadPrec [ListUserGroupsResponse] #
Show ListUserGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods showsPrec :: Int -> ListUserGroupsResponse -> ShowS # show :: ListUserGroupsResponse -> String # showList :: [ListUserGroupsResponse] -> ShowS #
NFData ListUserGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods rnf :: ListUserGroupsResponse -> () #
Eq ListUserGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups Methods (==) :: ListUserGroupsResponse -> ListUserGroupsResponse -> Bool # (/=) :: ListUserGroupsResponse -> ListUserGroupsResponse -> Bool #
type Rep ListUserGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListUserGroups type Rep ListUserGroupsResponse = D1 ('MetaData "ListUserGroupsResponse" "Amazonka.QuickSight.ListUserGroups" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "ListUserGroupsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groupList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Group])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUserGroupsResponse Source #

Arguments

:: Int	`ListUserGroupsResponse`
-> ListUserGroupsResponse

Create a value of ListUserGroupsResponse 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:groupList:ListUserGroupsResponse', listUserGroupsResponse_groupList - The list of groups the user is a member of.

ListUserGroups, listUserGroupsResponse_nextToken - A pagination token that can be used in a subsequent request.

$sel:requestId:ListUserGroupsResponse', listUserGroupsResponse_requestId - The Amazon Web Services request ID for this operation.

ListUserGroupsResponse, listUserGroupsResponse_status - The HTTP status of the request.

Response Lenses

listUserGroupsResponse_groupList :: Lens' ListUserGroupsResponse (Maybe [Group]) Source #

The list of groups the user is a member of.

listUserGroupsResponse_nextToken :: Lens' ListUserGroupsResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listUserGroupsResponse_requestId :: Lens' ListUserGroupsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listUserGroupsResponse_status :: Lens' ListUserGroupsResponse Int Source #

The HTTP status of the request.