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.

DescribedUser

Returns properties of the user that you want to describe.

Contents

Arn

This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Required: Yes

HomeDirectory

This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /bucket_name/home/username .

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^$|/.*

Required: No

Policy

Specifies the name of the policy in use for the described user.

Type: String

Required: No

Role

This property specifies the IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

Type: String

Pattern: arn:.*role/.*

Required: No

SshPublicKeys

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Type: Array of SshPublicKey objects

Array Members: Maximum number of 5 items.

Required: No

Tags

This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

UserName

This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

Type: String

Pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,31}$

Required: No

See Also

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

On this page: