ListedUser - AWS Transfer Family

ListedUser

Returns properties of the user that you specify.

Contents

Arn

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

Type: String

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

Pattern: arn:.*

Required: Yes

HomeDirectory

Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^$|/.*

Required: No

HomeDirectoryType

Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Type: String

Valid Values: PATH | LOGICAL

Required: No

Role

Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

Type: String

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

Pattern: arn:.*role/.*

Required: No

SshPublicKeyCount

Specifies the number of SSH public keys stored for the user you specified.

Type: Integer

Required: No

UserName

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Pattern: ^[\w][\w@.-]{2,99}$

Required: No

See Also

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