Class: Aws::Transfer::Types::ListUsersRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transfer/types.rb

Overview

Note:

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

{
  max_results: 1,
  next_token: "NextToken",
  server_id: "ServerId", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_results ⇒ Integer

Specifies the number of users to return as a response to the ‘ListUsers` request.

Returns:

  • (Integer) 


964
965
966
967
968
969
 
# File 'lib/aws-sdk-transfer/types.rb', line 964

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

#next_token ⇒ String

When you can get additional results from the ‘ListUsers` call, a `NextToken` parameter is returned in the output. You can then pass in a subsequent command to the `NextToken` parameter to continue listing additional users.

Returns:

  • (String) 


964
965
966
967
968
969
 
# File 'lib/aws-sdk-transfer/types.rb', line 964

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

#server_id ⇒ String

A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users assigned to it.

Returns:

  • (String) 


964
965
966
967
968
969
 
# File 'lib/aws-sdk-transfer/types.rb', line 964

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