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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

Returns:

  • (Integer)


1281
1282
1283
1284
1285
1286
1287
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1281

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

#next_tokenString

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)


1281
1282
1283
1284
1285
1286
1287
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1281

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

#server_idString

A system-assigned unique identifier for a server that has users assigned to it.

Returns:

  • (String)


1281
1282
1283
1284
1285
1286
1287
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1281

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