Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

describe-user

Описание

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

Ответ на этот вызов возвращает свойства пользователя, связанного со значением ServerId, которое было указано.

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

Синтаксис

  describe-user
--server-id <value>
--user-name <value>
[--cli-input-json | --cli-input-yaml]
[--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 (строка)

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

--user-name (строка)

Имя пользователя, назначенного одному или нескольким серверам. Имена пользователей являются частью учетных данных для входа в службу Transfer Family и выполнения задач передачи файлов.

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

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

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

--debug (логическое значение)

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

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

ServerId -> (строка)

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

User -> (структура)

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

Arn -> (строка)

Указывает уникальное имя Amazon Resource Name (ARN) пользователя, описание которого было запрошено.

HomeDirectory -> (строка)

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

Пример HomeDirectory - /bucket_name/home/mydirectory.

Примечание

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

HomeDirectoryMappings -> (список)

Логические сопоставления директорий, определяющие, какие пути и ключи Amazon S3 или Amazon EFS должны быть видны пользователю и как их отображать. Вы должны указать пару Entry и Target, где Entry показывает, как отображается путь, а Target — фактический путь Amazon S3 или Amazon EFS. Если вы укажете только целевой путь, он отображается как есть. Также необходимо убедиться, что ваша роль Identity and Access Management (IAM) предоставляет доступ к путям в Target. Это значение может быть установлено только при условии, что HomeDirectoryType установлено в значение LOGICAL.

В большинстве случаев это значение можно использовать вместо политики сеанса для ограничения пользователя заданной домашней директорией («chroot»). Для этого можно установить Entry в ‘/’ и установить значение параметра Target в значение параметра HomeDirectory.

(структура)

Представляет объект, содержащий записи и цели для HomeDirectoryMappings.

Ниже приведен пример пары Entry и Target для chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

Entry -> (строка)

Представляет запись для HomeDirectoryMappings.

Target -> (строка)

Представляет целевой объект сопоставления, используемый в HomeDirectoryMapEntry.

Type -> (строка)

Указывает тип сопоставления. Установите значение FILE, если нужно, чтобы сопоставление указывало на файл, или DIRECTORY для указания на директорию.

Примечание

По умолчанию сопоставления домашней директории имеют значение Type DIRECTORY при создании сервера семейства Transfer. Вам потребуется явно установить Type в значение FILE, если вы хотите, чтобы сопоставление имело целевой файл.

HomeDirectoryType -> (строка)

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

Примечание

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

Policy -> (строка)

Политика сеанса для вашего пользователя, чтобы вы могли использовать ту же роль Identity and Access Management (IAM) для нескольких пользователей. Эта политика сужает доступ пользователя к частям вашего Amazon S3 ведра. Переменные, которые можно использовать в этой политике, включают ${Transfer:UserName} , ${Transfer:HomeDirectory} и ${Transfer:HomeBucket}.

PosixProfile -> (структура)

Указывает полную информацию о профиле POSIX, включая идентификатор пользователя (Uid), идентификатор группы (Gid) и любые идентификаторы дополнительных групп (SecondaryGids), которые управляют доступом ваших пользователей к файловым системам Amazon Elastic File System (Amazon EFS). Разрешения POSIX, заданные на файлах и директориях в вашей файловой системе, определяют уровень доступа ваших пользователей при передаче файлов в Amazon EFS и из нее.

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

Идентификатор пользователя POSIX, используемый для всех операций EFS этим пользователем.

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

Идентификатор группы POSIX, используемый для всех операций EFS этим пользователем.

SecondaryGids -> (список)

Дополнительные идентификаторы групп POSIX, используемые для всех операций EFS этим пользователем.

(целое число)

Role -> (строка)

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

SshPublicKeys -> (список)

Указывает открытую часть ключей Secure Shell (SSH), хранящихся для описанного пользователя.

Примечание

Чтобы удалить открытый ключ, установите его значение в нуль ключей, как показано здесь:

SshPublicKeys: []

(структура)

Предоставляет информацию об открытом ключе Secure Shell (SSH), связанном с пользователем семейства Transfer для конкретного сервера, поддерживающего протокол передачи файлов (как указано в ServerId). Возвращаемая информация включает дату импорта ключа, содержимое открытого ключа и идентификатор открытого ключа. Пользователь может хранить более одного открытого ключа SSH, связанного с его именем пользователя, на конкретном сервере.

DateImported -> (временная метка)

Указывает дату добавления открытого ключа к пользователю семейства Transfer.

SshPublicKeyBody -> (строка)

Указывает содержимое открытого ключа SSH, как указано в PublicKeyId.

Семейство Transfer поддерживает ключи RSA, ECDSA и ED25519.

SshPublicKeyId -> (строка)

Указывает, что параметр SshPublicKeyId содержит идентификатор открытого ключа.

Tags -> (список)

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

(структура)

Создает пару ключ-значение для конкретного ресурса. Теги — это метаданные, которые можно использовать для поиска и группировки ресурса в различных целях. Вы можете применять теги к серверам, пользователям и ролям. Ключ тега может принимать несколько значений. Например, чтобы сгруппировать серверы в целях учета, можно создать тег под названием Group и назначить значения Research и Accounting этой группе.

Key -> (строка)

Название, присвоенное созданному тегу.

Value -> (строка)

Содержит одно или несколько значений, присвоенных вами имени ключа.

UserName -> (строка)

Указывает имя пользователя, описание которого было запрошено. Имена пользователей используются для целей аутентификации. Это строка, которую будет использовать ваш пользователь при входе на сервер.

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

Spec-Zone.ru

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