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

Inherits:

Struct

• Object
• Struct
• Aws::Chime::Types::ListUsersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-chime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:user_email]

Instance Attribute Summary

• #account_id ⇒ String

  The Amazon Chime account ID.

• #max_results ⇒ Integer

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

• #next_token ⇒ String

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

• #user_email ⇒ String

  Optional.

• #user_type ⇒ String

  The user type.

Instance Attribute Details

#account_id ⇒ String

The Amazon Chime account ID.

Returns:

• (String)

# File 'lib/aws-sdk-chime/types.rb', line 5856

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-chime/types.rb', line 5856

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

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-chime/types.rb', line 5856

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

#user_email ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-chime/types.rb', line 5856

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

#user_type ⇒ String

The user type.

Returns:

• (String)

# File 'lib/aws-sdk-chime/types.rb', line 5856

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