libZSservicesZSamazonka-appstreamZSamazonka-appstream
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppStream.DescribeUsers

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeUsers Source #

See: newDescribeUsers smart constructor.

Constructors

DescribeUsers' 

Fields

Instances

Instances details
Eq DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Read DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Show DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Generic DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Associated Types

type Rep DescribeUsers :: Type -> Type #

NFData DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Methods

rnf :: DescribeUsers -> () #

Hashable DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

ToJSON DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

AWSPager DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

AWSRequest DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Associated Types

type AWSResponse DescribeUsers #

ToHeaders DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

ToPath DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

ToQuery DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

type Rep DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

type Rep DescribeUsers = D1 ('MetaData "DescribeUsers" "Amazonka.AppStream.DescribeUsers" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "DescribeUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationType))))
type AWSResponse DescribeUsers Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

newDescribeUsers Source #

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:nextToken: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.

$sel:maxResults:DescribeUsers', describeUsers_maxResults - The maximum size of each page of results.

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

Request Lenses

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_maxResults :: Lens' DescribeUsers (Maybe Int) Source #

The maximum size of each page of results.

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

  • users :: Maybe [User]

    Information about users in the user pool.

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Show DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Generic DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Associated Types

type Rep DescribeUsersResponse :: Type -> Type #

NFData DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

Methods

rnf :: DescribeUsersResponse -> () #

type Rep DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeUsers

type Rep DescribeUsersResponse = D1 ('MetaData "DescribeUsersResponse" "Amazonka.AppStream.DescribeUsers" "libZSservicesZSamazonka-appstreamZSamazonka-appstream" 'False) (C1 ('MetaCons "DescribeUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [User])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUsersResponse Source #

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:

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

$sel:nextToken: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:httpStatus:DescribeUsersResponse', describeUsersResponse_httpStatus - The response's http status code.

Response Lenses

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

Information about users in the user pool.

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.