Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . transfer ]

list-users

Description

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-users
[--max-results <value>]
[--next-token <value>]
--server-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

Specifies the number of users to return as a response to the ListUsers request.

--next-token (string)

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.

--server-id (string)

A system-assigned unique identifier for a file transfer protocol-enabled server that has users assigned to it.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Output

NextToken -> (string)

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.

ServerId -> (string)

A system-assigned unique identifier for a file transfer protocol-enabled server that the users are assigned to.

Users -> (list)

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

(structure)

Returns properties of the user that you specify.

Arn -> (string)

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

HomeDirectory -> (string)

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

HomeDirectoryType -> (string)

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.

Role -> (string)

The role 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.

SshPublicKeyCount -> (integer)

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

UserName -> (string)

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