You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Chime::Types::ListUsersRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListUsersRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  account_id: "NonEmptyString", # required
  user_email: "EmailAddress",
  user_type: "PrivateUser", # accepts PrivateUser, SharedDevice
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Chime account ID.

Returns:

  • (String)

    The Amazon Chime account ID.

#max_resultsInteger

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

Returns:

  • (Integer)

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

#next_tokenString

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

Returns:

  • (String)

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

#user_emailString

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

Returns:

  • (String)

    Optional.

#user_typeString

The user type.

Possible values:

  • PrivateUser
  • SharedDevice

Returns:

  • (String)

    The user type.