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.
ListedUser
Returns properties of the user that you specify.
Contents
- Arn
-
This property is 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.
Required: Yes
- HomeDirectory
-
This value 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
- Role
-
The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP 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
Pattern:
arn:.*role/.*Required: No
- SshPublicKeyCount
-
This value is the number of SSH public keys stored for the user you specified.
Type: Integer
Required: No
- UserName
-
The name of the user whose ARN was specified. User names are used for authentication purposes.
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:
