libZSservicesZSamazonka-connectZSamazonka-connect
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.Connect.ListUsers

Description

Provides summary information about the users for the specified Amazon Connect instance.

This operation returns paginated results.

Synopsis

Creating a Request

data ListUsers Source #

See: newListUsers smart constructor.

Constructors

ListUsers' 

Fields

  • nextToken :: Maybe Text

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • maxResults :: Maybe Natural

    The maximum number of results to return per page.

  • instanceId :: Text

    The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details
Eq ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

(==) :: ListUsers -> ListUsers -> Bool #

(/=) :: ListUsers -> ListUsers -> Bool #

Read ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

readsPrec :: Int -> ReadS ListUsers #

readList :: ReadS [ListUsers] #

readPrec :: ReadPrec ListUsers #

readListPrec :: ReadPrec [ListUsers] #

Show ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

showsPrec :: Int -> ListUsers -> ShowS #

show :: ListUsers -> String #

showList :: [ListUsers] -> ShowS #

Generic ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Associated Types

type Rep ListUsers :: Type -> Type #

Methods

from :: ListUsers -> Rep ListUsers x #

to :: Rep ListUsers x -> ListUsers #

NFData ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

rnf :: ListUsers -> () #

Hashable ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

hashWithSalt :: Int -> ListUsers -> Int #

hash :: ListUsers -> Int #

AWSPager ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

page :: ListUsers -> AWSResponse ListUsers -> Maybe ListUsers #

AWSRequest ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Associated Types

type AWSResponse ListUsers #

Methods

request :: ListUsers -> Request ListUsers #

response :: MonadResource m => Logger -> Service -> Proxy ListUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUsers))) #

ToHeaders ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

toHeaders :: ListUsers -> [Header] #

ToPath ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

toPath :: ListUsers -> ByteString #

ToQuery ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

toQuery :: ListUsers -> QueryString #

type Rep ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.Connect.ListUsers" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListUsers'" '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 "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListUsers Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

type AWSResponse ListUsers = ListUsersResponse

newListUsers Source #

Arguments

:: Text

$sel:instanceId: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:nextToken:ListUsers', listUsers_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:maxResults:ListUsers', listUsers_maxResults - The maximum number of results to return per page.

$sel:instanceId:ListUsers', listUsers_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

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

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

The maximum number of results to return per page.

listUsers_instanceId :: Lens' ListUsers Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data ListUsersResponse Source #

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse' 

Fields

Instances

Instances details
Eq ListUsersResponse Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

(==) :: ListUsersResponse -> ListUsersResponse -> Bool #

(/=) :: ListUsersResponse -> ListUsersResponse -> Bool #

Read ListUsersResponse Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

readsPrec :: Int -> ReadS ListUsersResponse #

readList :: ReadS [ListUsersResponse] #

readPrec :: ReadPrec ListUsersResponse #

readListPrec :: ReadPrec [ListUsersResponse] #

Show ListUsersResponse Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

showsPrec :: Int -> ListUsersResponse -> ShowS #

show :: ListUsersResponse -> String #

showList :: [ListUsersResponse] -> ShowS #

Generic ListUsersResponse Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Associated Types

type Rep ListUsersResponse :: Type -> Type #

Methods

from :: ListUsersResponse -> Rep ListUsersResponse x #

to :: Rep ListUsersResponse x -> ListUsersResponse #

NFData ListUsersResponse Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

Methods

rnf :: ListUsersResponse -> () #

type Rep ListUsersResponse Source # 
Instance details

Defined in Amazonka.Connect.ListUsers

type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.Connect.ListUsers" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "userSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListUsersResponse Source #

Arguments

:: Int

$sel:httpStatus: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:

$sel:nextToken:ListUsers', listUsersResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:userSummaryList:ListUsersResponse', listUsersResponse_userSummaryList - Information about the users.

$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.

Response Lenses

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

If there are additional results, this is the token for the next set of results.

listUsersResponse_userSummaryList :: Lens' ListUsersResponse (Maybe [UserSummary]) Source #

Information about the users.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.