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.AppStream.DescribeUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list that describes one or more specified users in the user pool.

This operation returns paginated results.

Creating a Request

data DescribeUsers Source #

See: newDescribeUsers smart constructor.

Constructors

DescribeUsers'
Fields maxResults :: Maybe Int The maximum size of each page of results. nextToken :: Maybe Text The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page. authenticationType :: AuthenticationType The authentication type for the users in the user pool to describe. You must specify USERPOOL.

Instances

Instances details

ToJSON DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods toJSON :: DescribeUsers -> Value # toEncoding :: DescribeUsers -> Encoding # toJSONList :: [DescribeUsers] -> Value # toEncodingList :: [DescribeUsers] -> Encoding #
ToHeaders DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods toHeaders :: DescribeUsers -> [Header] #
ToPath DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods toPath :: DescribeUsers -> ByteString #
ToQuery DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods toQuery :: DescribeUsers -> QueryString #
AWSPager DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods page :: DescribeUsers -> AWSResponse DescribeUsers -> Maybe DescribeUsers #
AWSRequest DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Associated Types type AWSResponse DescribeUsers # Methods request :: (Service -> Service) -> DescribeUsers -> Request DescribeUsers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUsers))) #
Generic DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Associated Types type Rep DescribeUsers :: Type -> Type # Methods from :: DescribeUsers -> Rep DescribeUsers x # to :: Rep DescribeUsers x -> DescribeUsers #
Read DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods readsPrec :: Int -> ReadS DescribeUsers # readList :: ReadS [DescribeUsers] # readPrec :: ReadPrec DescribeUsers # readListPrec :: ReadPrec [DescribeUsers] #
Show DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods showsPrec :: Int -> DescribeUsers -> ShowS # show :: DescribeUsers -> String # showList :: [DescribeUsers] -> ShowS #
NFData DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods rnf :: DescribeUsers -> () #
Eq DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods (==) :: DescribeUsers -> DescribeUsers -> Bool # (/=) :: DescribeUsers -> DescribeUsers -> Bool #
Hashable DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods hashWithSalt :: Int -> DescribeUsers -> Int # hash :: DescribeUsers -> Int #
type AWSResponse DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers type AWSResponse DescribeUsers = DescribeUsersResponse
type Rep DescribeUsers Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers type Rep DescribeUsers = D1 ('MetaData "DescribeUsers" "Amazonka.AppStream.DescribeUsers" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationType))))

newDescribeUsers Source #

Arguments

:: AuthenticationType	`DescribeUsers`
-> DescribeUsers

Create a value of DescribeUsers 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:DescribeUsers', describeUsers_maxResults - The maximum size of each page of results.

DescribeUsers, describeUsers_nextToken - The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

DescribeUsers, describeUsers_authenticationType - The authentication type for the users in the user pool to describe. You must specify USERPOOL.

Request Lenses

describeUsers_maxResults :: Lens' DescribeUsers (Maybe Int) Source #

The maximum size of each page of results.

describeUsers_nextToken :: Lens' DescribeUsers (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

describeUsers_authenticationType :: Lens' DescribeUsers AuthenticationType Source #

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

Destructuring the Response

data DescribeUsersResponse Source #

See: newDescribeUsersResponse smart constructor.

Constructors

DescribeUsersResponse'
Fields nextToken :: Maybe Text The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. users :: Maybe [User] Information about users in the user pool. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeUsersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Associated Types type Rep DescribeUsersResponse :: Type -> Type # Methods from :: DescribeUsersResponse -> Rep DescribeUsersResponse x # to :: Rep DescribeUsersResponse x -> DescribeUsersResponse #
Show DescribeUsersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods showsPrec :: Int -> DescribeUsersResponse -> ShowS # show :: DescribeUsersResponse -> String # showList :: [DescribeUsersResponse] -> ShowS #
NFData DescribeUsersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods rnf :: DescribeUsersResponse -> () #
Eq DescribeUsersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers Methods (==) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool # (/=) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool #
type Rep DescribeUsersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeUsers type Rep DescribeUsersResponse = D1 ('MetaData "DescribeUsersResponse" "Amazonka.AppStream.DescribeUsers" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [User])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUsersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUsersResponse'`
-> DescribeUsersResponse

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

DescribeUsers, describeUsersResponse_nextToken - The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

$sel:users:DescribeUsersResponse', describeUsersResponse_users - Information about users in the user pool.

$sel:httpStatus:DescribeUsersResponse', describeUsersResponse_httpStatus - The response's http status code.

Response Lenses

describeUsersResponse_nextToken :: Lens' DescribeUsersResponse (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User]) Source #

Information about users in the user pool.

describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int Source #

The response's http status code.