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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

Note:

When making an API call, you may pass ListUsersRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[:user_email]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Chime account ID.

Returns:

  • (String)


7044
7045
7046
7047
7048
7049
7050
7051
7052
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 7044

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :user_type,
  :max_results,
  :next_token)
  SENSITIVE = [:user_email]
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


7044
7045
7046
7047
7048
7049
7050
7051
7052
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 7044

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :user_type,
  :max_results,
  :next_token)
  SENSITIVE = [:user_email]
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


7044
7045
7046
7047
7048
7049
7050
7051
7052
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 7044

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :user_type,
  :max_results,
  :next_token)
  SENSITIVE = [:user_email]
  include Aws::Structure
end

#user_emailString

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

Returns:

  • (String)


7044
7045
7046
7047
7048
7049
7050
7051
7052
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 7044

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :user_type,
  :max_results,
  :next_token)
  SENSITIVE = [:user_email]
  include Aws::Structure
end

#user_typeString

The user type.

Returns:

  • (String)


7044
7045
7046
7047
7048
7049
7050
7051
7052
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 7044

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :user_type,
  :max_results,
  :next_token)
  SENSITIVE = [:user_email]
  include Aws::Structure
end