Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

list-users

Описание

Отображает список пользователей для сервера протокола передачи файлов, который вы указываете, передавая параметр ServerId.

См. также: Документацию API AWS

list-users является постраничной операцией. Для получения всего набора результатов могут быть отправлены несколько API-запросов. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Users

Синтаксис

  list-users
--server-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--server-id (строка)

Уникальный идентификатор, присвоенный системой, для сервера, которому назначены пользователи.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это значение не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер, указывающий, с какой точки начать постраничную обработку. Это значение NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы, получаемой в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов AWS-сервиса из-за превышения времени ожидания.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную обработку, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки API-запроса. Если предоставлено без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один запрос для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла с данными учетных записей.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/окружения.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Данные учетной записи не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут представлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурируемого формата cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы входных параметров CLI.

Вывод

NextToken -> (строка)

Когда вы можете получить дополнительные результаты из вызова ListUsers, параметр NextToken возвращается в выводе. Затем вы можете передать последующую команду в параметр NextToken, чтобы продолжить перечисление дополнительных пользователей.

ServerId -> (строка)

Уникальный идентификатор, назначенный системой, для сервера, которому назначены пользователи.

Users -> (список)

Возвращает пользователей семейства передачи и их свойства для значения ServerId, которое вы укажете.

(структура)

Возвращает свойства пользователя, который вы указали.

Arn -> (строка)

Предоставляет уникальное имя Amazon Resource Name (ARN) для пользователя, о котором вы хотите узнать.

HomeDirectory -> (строка)

Директория (папка) назначения для пользователя при входе на сервер с помощью клиента.

Пример HomeDirectory является /bucket_name/home/mydirectory.

Примечание

Параметр HomeDirectory используется только в том случае, если HomeDirectoryType установлен в значение PATH.

HomeDirectoryType -> (строка)

Тип директории (папки) назначения, которую вы хотите, чтобы была домашняя директория ваших пользователей при входе на сервер. Если вы установите его в значение PATH, пользователи увидят абсолютный путь к Amazon S3- или Amazon EFS-бакетам в своих клиентах протокола передачи файлов. Если вы установите его в значение LOGICAL, вам необходимо предоставить сопоставления в HomeDirectoryMappings, определяющие, как вы хотите отобразить пути Amazon S3 или Amazon EFS для ваших пользователей.

Примечание

Если HomeDirectoryType имеет значение LOGICAL, вы должны предоставить сопоставления, используя параметр HomeDirectoryMappings. Если же HomeDirectoryType имеет значение PATH, вы предоставляете абсолютный путь, используя параметр HomeDirectory. В вашем шаблоне нельзя использовать одновременно HomeDirectory и HomeDirectoryMappings.

Role -> (строка)

Имя Amazon Resource Name (ARN) роли управления идентификацией и доступом (IAM), которая контролирует доступ ваших пользователей к вашему Amazon S3-бакету или Amazon EFS-файловой системе. Политики, прикрепленные к этой роли, определяют уровень доступа, который вы хотите предоставить своим пользователям при передаче файлов в ваш Amazon S3-баккет или Amazon EFS-файловую систему. Роль IAM также должна содержать соглашение о доверии, которое позволяет серверу получать доступ к вашим ресурсам при обслуживании запросов на передачу ваших пользователей.

Примечание

Роль IAM, контролирующая доступ ваших пользователей к вашему Amazon S3-бакету для серверов с Domain=S3 или к вашей EFS-файловой системе для серверов с Domain=EFS.

Политики, прикрепленные к этой роли, определяют уровень доступа, который вы хотите предоставить вашим пользователям при передаче файлов в и из ваших S3-бакетов или EFS-файловых систем.

SshPublicKeyCount -> (целое число)

Указывает количество SSH-открытых ключей, сохранённых для указанного вами пользователя.

UserName -> (строка)

Указывает имя пользователя, чья ARN была указана. Имена пользователей используются для целей аутентификации.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API