Amazonka.WorkMail.ListUsers

Returns summaries of the organization's users.

This operation returns paginated results.

Creating a Request

data ListUsers

See: newListUsers smart constructor.

Constructors

ListUsers'

Fields

• maxResults :: Maybe Natural

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

• nextToken :: Maybe Text

  The token to use to retrieve the next page of results. The first call does not contain any tokens.

• organizationId :: Text

  The identifier for the organization under which the users exist.

Instances

ToJSON ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

toJSON :: ListUsers -> Value

toEncoding :: ListUsers -> Encoding

toJSONList :: [ListUsers] -> Value

toEncodingList :: [ListUsers] -> Encoding

ToHeaders ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

toHeaders :: ListUsers -> [Header]

ToPath ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

toPath :: ListUsers -> ByteString

ToQuery ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

toQuery :: ListUsers -> QueryString

AWSPager ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

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

AWSRequest ListUsers

Defined in Amazonka.WorkMail.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

Defined in Amazonka.WorkMail.ListUsers

Associated Types

type Rep ListUsers :: Type -> Type

Methods

from :: ListUsers -> Rep ListUsers x

to :: Rep ListUsers x -> ListUsers

Read ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

readsPrec :: Int -> ReadS ListUsers

readList :: ReadS [ListUsers]

readPrec :: ReadPrec ListUsers

readListPrec :: ReadPrec [ListUsers]

Show ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

showsPrec :: Int -> ListUsers -> ShowS

show :: ListUsers -> String

showList :: [ListUsers] -> ShowS

NFData ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

rnf :: ListUsers -> ()

Eq ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

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

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

Hashable ListUsers

Defined in Amazonka.WorkMail.ListUsers

Methods

hashWithSalt :: Int -> ListUsers -> Int

hash :: ListUsers -> Int

type AWSResponse ListUsers

Defined in Amazonka.WorkMail.ListUsers

type AWSResponse ListUsers = ListUsersResponse

type Rep ListUsers

Defined in Amazonka.WorkMail.ListUsers

type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.WorkMail.ListUsers" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" '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 "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListUsers

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.

ListUsers, listUsers_nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

ListUsers, listUsers_organizationId - The identifier for the organization under which the users exist.

Request Lenses

listUsers_maxResults :: Lens' ListUsers (Maybe Natural)

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

listUsers_nextToken :: Lens' ListUsers (Maybe Text)

The token to use to retrieve the next page of results. The first call does not contain any tokens.

listUsers_organizationId :: Lens' ListUsers Text

The identifier for the organization under which the users exist.

Destructuring the Response

data ListUsersResponse

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse'

Fields

• nextToken :: Maybe Text

  The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.

• users :: Maybe [User]

  The overview of users for an organization.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListUsersResponse

Defined in Amazonka.WorkMail.ListUsers

Associated Types

type Rep ListUsersResponse :: Type -> Type

Methods

from :: ListUsersResponse -> Rep ListUsersResponse x

to :: Rep ListUsersResponse x -> ListUsersResponse

Read ListUsersResponse

Defined in Amazonka.WorkMail.ListUsers

Methods

readsPrec :: Int -> ReadS ListUsersResponse

readList :: ReadS [ListUsersResponse]

readPrec :: ReadPrec ListUsersResponse

readListPrec :: ReadPrec [ListUsersResponse]

Show ListUsersResponse

Defined in Amazonka.WorkMail.ListUsers

Methods

showsPrec :: Int -> ListUsersResponse -> ShowS

show :: ListUsersResponse -> String

showList :: [ListUsersResponse] -> ShowS

NFData ListUsersResponse

Defined in Amazonka.WorkMail.ListUsers

Methods

rnf :: ListUsersResponse -> ()

Eq ListUsersResponse

Defined in Amazonka.WorkMail.ListUsers

Methods

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

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

type Rep ListUsersResponse

Defined in Amazonka.WorkMail.ListUsers

type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.WorkMail.ListUsers" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" '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

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. This value is `null` when there are no more results to return.

$sel:users:ListUsersResponse', listUsersResponse_users - The overview of users for an organization.

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

Response Lenses

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)

The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.

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

The overview of users for an organization.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int

The response's http status code.