AWS Transfer for SFTP
User Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListUsers

Lists the users for the 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.

The request accepts the following data in JSON format.

MaxResults

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

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.

Required: No

ServerId

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

Type: String

Pattern: ^s-([0-9a-f]{17})$

Required: Yes

Response Syntax

{ "NextToken": "string", "ServerId": "string", "Users": [ { "Arn": "string", "HomeDirectory": "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

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

A system-assigned unique identifier for an SFTP server that the users are assigned to.

Type: String

Pattern: ^s-([0-9a-f]{17})$

Users

Returns the user accounts and their properties for the ServerId value that you specify.

Type: Array of ListedUser objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer for SFTP 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 AWS Transfer for SFTP service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWS Transfer for SFTP service is not available.

HTTP Status Code: 500

Examples

Example

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

Sample Request

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

Example

Sample Response

{ "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ=="", "Users": [ { "Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie", "HomeDirectory": "/sftp-tests/home/charlie", "PublicKeys": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC9BLcKD9wgCLdi2gyVpB8N6TFVaUlzWbHCDeWwi79rZb2eeP91fR2m3knzckD4a1BVm+I3Ig/vuD/EKVzdHNpwYOG1XOqPSwHW8GIHDY9jMP/AzX6SML8jVSCRsrM7CJxtCoXVi3ysAnvLN6caHL1IuJ+yC1QZzLKOtEbpduRKxkcynDBSUb9lheewXEto1PdlR4vFgWe6c/dRlioSN6h1TB7nUaEm6axd+zEexdvg3mmZTcOVKgV7DOZWN9zRQGzH+gcUw0pXxa3stKDjeaGic2BoJoTZK5FZfgOGPzRfGEZ0Zc3XCg16iyNvTR6/Hcse5JuddqH2dLdDkzC6GB7t", "Role": "arn:aws:iam::176354371281:role/transfer-role1", "Tags": [ { "Key": "Name", "Value": "user1" } ], "UserName": "sftp_user" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: