# ListUsers


Lists the users for a file transfer protocol-enabled server that you specify by passing the `ServerId` parameter.

## Request Syntax


```
{
   "MaxResults": number,
   "NextToken": "string",
   "ServerId": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListUsers_RequestSyntax) **   <a name="TransferFamily-ListUsers-request-MaxResults"></a>
Specifies the number of users to return as a response to the `ListUsers` request.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListUsers_RequestSyntax) **   <a name="TransferFamily-ListUsers-request-NextToken"></a>
If there are additional results from the `ListUsers` call, a `NextToken` parameter is returned in the output. You can then pass the `NextToken` to a subsequent `ListUsers` command, to continue listing additional users.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.  
Required: No

 ** [ServerId](#API_ListUsers_RequestSyntax) **   <a name="TransferFamily-ListUsers-request-ServerId"></a>
A system-assigned unique identifier for a server that has users assigned to it.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: Yes

## Response Syntax


```
{
   "NextToken": "string",
   "ServerId": "string",
   "Users": [ 
      { 
         "Arn": "string",
         "HomeDirectory": "string",
         "HomeDirectoryType": "string",
         "Role": "string",
         "SshPublicKeyCount": number,
         "UserName": "string"
      }
   ]
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListUsers_ResponseSyntax) **   <a name="TransferFamily-ListUsers-response-NextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 6144.

 ** [ServerId](#API_ListUsers_ResponseSyntax) **   <a name="TransferFamily-ListUsers-response-ServerId"></a>
A system-assigned unique identifier for a server that the users are assigned to.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})` 

 ** [Users](#API_ListUsers_ResponseSyntax) **   <a name="TransferFamily-ListUsers-response-Users"></a>
Returns the Transfer Family users and their properties for the `ServerId` value that you specify.  
Type: Array of [ListedUser](API_ListedUser.md) objects

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
This exception is thrown when an error occurs in the AWS Transfer Family service.  
HTTP Status Code: 500

 ** InvalidNextTokenException **   
The `NextToken` parameter that was passed is invalid.  
HTTP Status Code: 400

 ** InvalidRequestException **   
This exception is thrown when the client submits a malformed request.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
This exception is thrown when a resource is not found by the AWSTransfer Family service.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The request has failed because the AWSTransfer Family service is not available.  
HTTP Status Code: 500

## Examples


### Example


The `ListUsers` API call returns a list of users associated with a server you specify.

#### Sample Request


```
     
         {
          "MaxResults": 100,
          "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
          "ServerId": "s-01234567890abcdef"
          }
```

### Example


This is a sample response for this API call.

#### Sample Response


```
{
   "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
   "ServerId": "s-01234567890abcdef",
   "Users": [ 
      { 
         "Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie",
         "HomeDirectory": "/tests/home/charlie",
         "SshPublicKeyCount": 1,
         "Role": "arn:aws:iam::176354371281:role/transfer-role1",
         "Tags": [ 
            { 
               "Key": "Name",
               "Value": "user1"
            }
         ],
         "UserName": "my_user"
      }
   ]
}
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/transfer-2018-11-05/ListUsers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/ListUsers)