Class: Aws::Wickr::Types::ListUsersRequest

Inherits:

Struct

• Object
• Struct
• Aws::Wickr::Types::ListUsersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-wickr/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:first_name, :last_name]

Instance Attribute Summary

• #first_name ⇒ String

  Filter results to only include users with first names matching this value.

• #group_id ⇒ String

  Filter results to only include users belonging to this security group.

• #last_name ⇒ String

  Filter results to only include users with last names matching this value.

• #max_results ⇒ Integer

  The maximum number of users to return in a single page.

• #network_id ⇒ String

  The ID of the Wickr network from which to list users.

• #next_token ⇒ String

  The token for retrieving the next page of results.

• #sort_direction ⇒ String

  The direction to sort results.

• #sort_fields ⇒ String

  The fields to sort users by.

• #status ⇒ Integer

  Filter results to only include users with this status (1 for pending, 2 for active).

• #username ⇒ String

  Filter results to only include users with usernames matching this value.

Instance Attribute Details

#first_name ⇒ String

Filter results to only include users with first names matching this value.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#group_id ⇒ String

Filter results to only include users belonging to this security group.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#last_name ⇒ String

Filter results to only include users with last names matching this value.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

Returns:

• (Integer)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#network_id ⇒ String

The ID of the Wickr network from which to list users.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#next_token ⇒ String

The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#sort_direction ⇒ String

The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#sort_fields ⇒ String

The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#status ⇒ Integer

Filter results to only include users with this status (1 for pending, 2 for active).

Returns:

• (Integer)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end

#username ⇒ String

Filter results to only include users with usernames matching this value.

Returns:

• (String)

# File 'lib/aws-sdk-wickr/types.rb', line 2244

class ListUsersRequest < Struct.new(
  :network_id,
  :next_token,
  :max_results,
  :sort_fields,
  :sort_direction,
  :first_name,
  :last_name,
  :username,
  :status,
  :group_id)
  SENSITIVE = [:first_name, :last_name]
  include Aws::Structure
end