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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListUsersRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

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)

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

#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)

    When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output.

#server_idString

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

Returns:

  • (String)

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