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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all user groups in Amazon QuickSight.

Synopsis

Creating a Request

data ListGroups Source #

See: newListGroups smart constructor.

Constructors

ListGroups'

Fields

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

Instances

Instances details

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

newListGroups Source #

Arguments

:: Text	`ListGroups`
-> Text	`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:maxResults:ListGroups', listGroups_maxResults - The maximum number of results to return.

ListGroups, listGroups_nextToken - A pagination token that can be used in a subsequent request.

ListGroups, listGroups_awsAccountId - The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

ListGroups, listGroups_namespace - The namespace that you want a list of groups from.

Request Lenses

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

The maximum number of results to return.

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

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

listGroups_awsAccountId :: Lens' ListGroups Text Source #

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

listGroups_namespace :: Lens' ListGroups Text Source #

The namespace that you want a list of groups from.

Destructuring the Response

data ListGroupsResponse Source #

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse'
Fields groupList :: Maybe [Group] The list of the groups. 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 ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Associated Types type Rep ListGroupsResponse :: Type -> Type # Methods from :: ListGroupsResponse -> Rep ListGroupsResponse x # to :: Rep ListGroupsResponse x -> ListGroupsResponse #
Read ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods readsPrec :: Int -> ReadS ListGroupsResponse # readList :: ReadS [ListGroupsResponse] # readPrec :: ReadPrec ListGroupsResponse # readListPrec :: ReadPrec [ListGroupsResponse] #
Show ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods showsPrec :: Int -> ListGroupsResponse -> ShowS # show :: ListGroupsResponse -> String # showList :: [ListGroupsResponse] -> ShowS #
NFData ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods rnf :: ListGroupsResponse -> () #
Eq ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods (==) :: ListGroupsResponse -> ListGroupsResponse -> Bool # (/=) :: ListGroupsResponse -> ListGroupsResponse -> Bool #
type Rep ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.QuickSight.ListGroups" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "ListGroupsResponse'" '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))))

newListGroupsResponse Source #

Arguments

:: Int	`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:groupList:ListGroupsResponse', listGroupsResponse_groupList - The list of the groups.

ListGroups, listGroupsResponse_nextToken - A pagination token that can be used in a subsequent request.

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

ListGroupsResponse, listGroupsResponse_status - The HTTP status of the request.

Response Lenses

listGroupsResponse_groupList :: Lens' ListGroupsResponse (Maybe [Group]) Source #

The list of the groups.

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

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

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

The Amazon Web Services request ID for this operation.

listGroupsResponse_status :: Lens' ListGroupsResponse Int Source #

The HTTP status of the request.