Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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

nextToken :: Maybe Text
A pagination token that can be used in a subsequent request.
maxResults :: Maybe Natural
The maximum number of results to return.
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. Currently, you should set this to default.

Instances

Instances details

Eq ListGroups Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods (==) :: ListGroups -> ListGroups -> Bool # (/=) :: ListGroups -> ListGroups -> Bool #
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 #
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 #
NFData ListGroups Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods rnf :: ListGroups -> () #
Hashable ListGroups Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods hashWithSalt :: Int -> ListGroups -> Int # hash :: ListGroups -> Int #
AWSRequest ListGroups Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Associated Types type AWSResponse ListGroups # Methods request :: ListGroups -> Request ListGroups # response :: MonadResource m => Logger -> Service -> Proxy ListGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGroups))) #
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 #
type Rep ListGroups Source #
Instance details Defined in Amazonka.QuickSight.ListGroups type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.QuickSight.ListGroups" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListGroups Source #
Instance details Defined in Amazonka.QuickSight.ListGroups type AWSResponse ListGroups = ListGroupsResponse

newListGroups Source #

Arguments

:: Text	`$sel:awsAccountId:ListGroups'`
-> Text	`$sel:namespace: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:nextToken:ListGroups', listGroups_nextToken - A pagination token that can be used in a subsequent request.

$sel:maxResults:ListGroups', listGroups_maxResults - The maximum number of results to return.

$sel:awsAccountId: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.

$sel:namespace:ListGroups', listGroups_namespace - The namespace. Currently, you should set this to default.

Request Lenses

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

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

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

The maximum number of results to return.

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. Currently, you should set this to default.

Destructuring the Response

data ListGroupsResponse Source #

See: newListGroupsResponse smart constructor.

Constructors

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

Instances

Instances details

Eq ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods (==) :: ListGroupsResponse -> ListGroupsResponse -> Bool # (/=) :: ListGroupsResponse -> ListGroupsResponse -> Bool #
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 #
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 #
NFData ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups Methods rnf :: ListGroupsResponse -> () #
type Rep ListGroupsResponse Source #
Instance details Defined in Amazonka.QuickSight.ListGroups type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.QuickSight.ListGroups" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "ListGroupsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "groupList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Group]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGroupsResponse Source #

Arguments

:: Int	`$sel:status: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:requestId:ListGroupsResponse', listGroupsResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:groupList:ListGroupsResponse', listGroupsResponse_groupList - The list of the groups.

$sel:nextToken:ListGroups', listGroupsResponse_nextToken - A pagination token that can be used in a subsequent request.

$sel:status:ListGroupsResponse', listGroupsResponse_status - The HTTP status of the request.

Response Lenses

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

The Amazon Web Services request ID for this operation.

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_status :: Lens' ListGroupsResponse Int Source #

The HTTP status of the request.