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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

This operation returns paginated results.

Synopsis

data ListUsers = ListUsers' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- userEmail :: Maybe (Sensitive Text)
- userType :: Maybe UserType
- accountId :: Text
}
newListUsers :: Text -> ListUsers
listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
listUsers_nextToken :: Lens' ListUsers (Maybe Text)
listUsers_userEmail :: Lens' ListUsers (Maybe Text)
listUsers_userType :: Lens' ListUsers (Maybe UserType)
listUsers_accountId :: Lens' ListUsers Text
data ListUsersResponse = ListUsersResponse' {
- nextToken :: Maybe Text
- users :: Maybe [User]
- httpStatus :: Int
}
newListUsersResponse :: Int -> ListUsersResponse
listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)
listUsersResponse_users :: Lens' ListUsersResponse (Maybe [User])
listUsersResponse_httpStatus :: 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 in a single call. Defaults to 100. nextToken :: Maybe Text The token to use to retrieve the next page of results. userEmail :: Maybe (Sensitive Text) Optional. The user email address used to filter results. Maximum 1. userType :: Maybe UserType The user type. accountId :: Text The Amazon Chime account ID.

Instances

Instances details

ToHeaders ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods toHeaders :: ListUsers -> [Header] #
ToPath ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods toPath :: ListUsers -> ByteString #
ToQuery ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods toQuery :: ListUsers -> QueryString #
AWSPager ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods page :: ListUsers -> AWSResponse ListUsers -> Maybe ListUsers #
AWSRequest ListUsers Source #
Instance details Defined in Amazonka.Chime.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.Chime.ListUsers Associated Types type Rep ListUsers :: Type -> Type # Methods from :: ListUsers -> Rep ListUsers x # to :: Rep ListUsers x -> ListUsers #
Show ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods showsPrec :: Int -> ListUsers -> ShowS # show :: ListUsers -> String # showList :: [ListUsers] -> ShowS #
NFData ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods rnf :: ListUsers -> () #
Eq ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods (==) :: ListUsers -> ListUsers -> Bool # (/=) :: ListUsers -> ListUsers -> Bool #
Hashable ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods hashWithSalt :: Int -> ListUsers -> Int # hash :: ListUsers -> Int #
type AWSResponse ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers type AWSResponse ListUsers = ListUsersResponse
type Rep ListUsers Source #
Instance details Defined in Amazonka.Chime.ListUsers type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.Chime.ListUsers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" '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 "userEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "userType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserType)) :: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListUsers Source #

Arguments

:: 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 in a single call. Defaults to 100.

ListUsers, listUsers_nextToken - The token to use to retrieve the next page of results.

$sel:userEmail:ListUsers', listUsers_userEmail - Optional. The user email address used to filter results. Maximum 1.

ListUsers, listUsers_userType - The user type.

ListUsers, listUsers_accountId - The Amazon Chime account ID.

Request Lenses

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

The maximum number of results to return in a single call. Defaults to 100.

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

The token to use to retrieve the next page of results.

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

Optional. The user email address used to filter results. Maximum 1.

listUsers_userType :: Lens' ListUsers (Maybe UserType) Source #

The user type.

listUsers_accountId :: Lens' ListUsers Text Source #

The Amazon Chime account ID.

Destructuring the Response

data ListUsersResponse Source #

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. users :: Maybe [User] List of users and user details. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListUsersResponse Source #
Instance details Defined in Amazonka.Chime.ListUsers Associated Types type Rep ListUsersResponse :: Type -> Type # Methods from :: ListUsersResponse -> Rep ListUsersResponse x # to :: Rep ListUsersResponse x -> ListUsersResponse #
Show ListUsersResponse Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods showsPrec :: Int -> ListUsersResponse -> ShowS # show :: ListUsersResponse -> String # showList :: [ListUsersResponse] -> ShowS #
NFData ListUsersResponse Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods rnf :: ListUsersResponse -> () #
Eq ListUsersResponse Source #
Instance details Defined in Amazonka.Chime.ListUsers Methods (==) :: ListUsersResponse -> ListUsersResponse -> Bool # (/=) :: ListUsersResponse -> ListUsersResponse -> Bool #
type Rep ListUsersResponse Source #
Instance details Defined in Amazonka.Chime.ListUsers type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.Chime.ListUsers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ListUsersResponse'" '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))))

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:

ListUsers, listUsersResponse_nextToken - The token to use to retrieve the next page of results.

$sel:users:ListUsersResponse', listUsersResponse_users - List of users and user details.

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

Response Lenses

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

The token to use to retrieve the next page of results.

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

List of users and user details.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.