[ aws . transfer ]



Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--server-id <value>
--user-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--server-id (string)

A system-assigned unique identifier for a server that has this user assigned.

--user-name (string)

The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer Family service and perform file transfer tasks.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


ServerId -> (string)

A system-assigned unique identifier for a server that has this user assigned.

User -> (structure)

An array containing the properties of the user account for the ServerID value that you specified.

Arn -> (string)

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

HomeDirectory -> (string)

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 * your-Amazon-S3-bucket-name>/home/username * .

HomeDirectoryMappings -> (list)

Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the “Entry ” and “Target ” pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target .

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (“chroot”). To do this, you can set Entry to ‘/’ and set Target to the HomeDirectory parameter value.


Represents an object that contains entries and targets for HomeDirectoryMappings .

Entry -> (string)

Represents an entry and a target for HomeDirectoryMappings .

Target -> (string)

Represents the map target that is used in a HomeDirectorymapEntry .

HomeDirectoryType -> (string)

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. 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.

Policy -> (string)

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

PosixProfile -> (structure)

Uid -> (long)

Gid -> (long)

SecondaryGids -> (list)


Role -> (string)

Specifies the IAM role that controls your users’ 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 a server to access your resources when servicing your users’ transfer requests.

SshPublicKeys -> (list)

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


Provides information about the public Secure Shell (SSH) key that is associated with a user account for the specific file transfer protocol-enabled server (as identified by ServerId ). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.

DateImported -> (timestamp)

Specifies the date that the public key was added to the user account.

SshPublicKeyBody -> (string)

Specifies the content of the SSH public key as specified by the PublicKeyId .

SshPublicKeyId -> (string)

Specifies the SshPublicKeyId parameter contains the identifier of the public key.

Tags -> (list)

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


Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

Key -> (string)

The name assigned to the tag that you create.

Value -> (string)

Contains one or more values that you assigned to the key name you create.

UserName -> (string)

Specifies 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 server.