Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

describe-access

Описание

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

Ответ на этот вызов возвращает свойства доступа, ассоциированные со значением ServerId, указанным в запросе.

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

Синтаксис

  describe-access
--server-id <value>
--external-id <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 (строка)

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

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

Уникальный идентификатор, необходимый для идентификации конкретных групп в вашей директории. Пользователи группы, которую вы ассоциируете, получают доступ к вашим ресурсам Amazon S3 или Amazon EFS через включенные протоколы с помощью Transfer Family. Если вам известны имена групп, вы можете просмотреть значения SID, выполнив следующую команду в Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "*YourGroupName* *"} -Properties * | Select SamAccountName,ObjectSid

В этой команде замените YourGroupName на имя вашей группы Active Directory.

Регулярное выражение, используемое для валидации этого параметра, представляет собой строку символов, состоящую из буквенно-цифровых символов верхнего и нижнего регистра без пробелов. Вы также можете включить подчеркивания или следующие символы: =,.@:/-

--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 (строка)

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

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

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

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

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

--output (строка)

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

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--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 -> (строка)

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

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

Внешний идентификатор сервера, к которому прикреплен доступ.

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 Family. Вам необходимо явно установить 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 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 также должна содержать отношения доверия, которые позволяют серверу получить доступ к вашим ресурсам при обслуживании запросов на передачу ваших пользователей.

ExternalId -> (строка)

Уникальный идентификатор, необходимый для идентификации определенных групп в вашей директории. Пользователи группы, которую вы ассоциируете, имеют доступ к вашим ресурсам Amazon S3 или Amazon EFS через включенные протоколы с помощью Transfer Family. Если вам известна группа, вы можете просмотреть значения SID, выполнив следующую команду с помощью Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "*YourGroupName* *"} -Properties * | Select SamAccountName,ObjectSid

В этой команде замените YourGroupName на имя вашей группы Active Directory.

Регулярное выражение, используемое для проверки этого параметра, — строка символов, состоящая из буквенно-цифровых символов верхнего и нижнего регистра без пробелов. Вы также можете использовать подчеркивания или любые из следующих символов: =,.@:/-

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

Spec-Zone.ru

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