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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all of the Amazon QuickSight users belonging to this account.

Synopsis

data ListUsers = ListUsers' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- awsAccountId :: Text
- namespace :: Text
}
newListUsers :: Text -> Text -> ListUsers
listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
listUsers_nextToken :: Lens' ListUsers (Maybe Text)
listUsers_awsAccountId :: Lens' ListUsers Text
listUsers_namespace :: Lens' ListUsers Text
data ListUsersResponse = ListUsersResponse' {
- nextToken :: Maybe Text
- requestId :: Maybe Text
- userList :: Maybe [User]
- status :: Int
}
newListUsersResponse :: Int -> ListUsersResponse
listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)
listUsersResponse_requestId :: Lens' ListUsersResponse (Maybe Text)
listUsersResponse_userList :: Lens' ListUsersResponse (Maybe [User])
listUsersResponse_status :: Lens' ListUsersResponse Int

Creating a Request

data ListUsers Source #

See: newListUsers smart constructor.

Constructors

ListUsers'

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

newListUsers Source #

Arguments

:: Text	`ListUsers`
-> Text	`ListUsers`
-> ListUsers

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

ListUsers, listUsers_nextToken - A pagination token that can be used in a subsequent request.

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

ListUsers, listUsers_namespace - The namespace. Currently, you should set this to default.

Request Lenses

listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #

The maximum number of results to return from this request.

listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #

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

listUsers_awsAccountId :: Lens' ListUsers Text Source #

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

listUsers_namespace :: Lens' ListUsers Text Source #

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

Destructuring the Response

data ListUsersResponse Source #

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse'
Fields 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. userList :: Maybe [User] The list of users. status :: Int The HTTP status of the request.

Instances

Instances details

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

newListUsersResponse Source #

Arguments

:: Int	`ListUsersResponse`
-> ListUsersResponse

Create a value of ListUsersResponse 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:

ListUsers, listUsersResponse_nextToken - A pagination token that can be used in a subsequent request.

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

$sel:userList:ListUsersResponse', listUsersResponse_userList - The list of users.

ListUsersResponse, listUsersResponse_status - The HTTP status of the request.

Response Lenses

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

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

listUsersResponse_requestId :: Lens' ListUsersResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listUsersResponse_userList :: Lens' ListUsersResponse (Maybe [User]) Source #

The list of users.

listUsersResponse_status :: Lens' ListUsersResponse Int Source #

The HTTP status of the request.