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

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",
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The Amazon Chime account ID.

Returns:

  • (String)


1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1572

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1572

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1572

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :max_results,
  :next_token)
  include Aws::Structure
end

#user_emailString

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

Returns:

  • (String)


1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 1572

class ListUsersRequest < Struct.new(
  :account_id,
  :user_email,
  :max_results,
  :next_token)
  include Aws::Structure
end