put-group

Описание

Создает или обновляет сопоставление пользователей, имеющих доступ к документу, с группами.

Вы также можете сопоставлять подгруппы с группами. Например, группа «Команды по интеллектуальной собственности компании» включает подгруппы «Исследования» и «Инженерия». Эти подгруппы содержат свои собственные списки пользователей или людей, работающих в этих командах. Только пользователи, работающие в области исследований и инженерии, и, следовательно, входящие в группу интеллектуальной собственности, могут видеть конфиденциальные документы компании в результатах чата Amazon Q Business.

Существует два варианта создания групп: либо передача членов группы в строке, либо использование файла S3 через поле S3PathForGroupMembers. Для групп в строке ограничение составляет 1000 членов на группу, а для предоставленных файлов S3 — 100 тысяч членов. При создании группы с использованием файла S3 вы предоставляете как файл S3, так и RoleArn для доступа к файлу Amazon Q Buisness.

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

Синтаксис

  put-group
--application-id <value>
--index-id <value>
--group-name <value>
[--data-source-id <value>]
--type <value>
--group-members <value>
[--role-arn <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]

Параметры

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

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

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

--data-source-id (строка)

--type (строка)

--group-members (структура)

Сокращенный синтаксис:

memberGroups=[{groupName=string,type=string},{groupName=string,type=string}],memberUsers=[{userId=string,type=string},{userId=string,type=string}],s3PathForGroupMembers={bucket=string,key=string}

Синтаксис JSON:

{
  "memberGroups": [
    {
      "groupName": "string",
      "type": "INDEX"|"DATASOURCE"
    }
    ...
  ],
  "memberUsers": [
    {
      "userId": "string",
      "type": "INDEX"|"DATASOURCE"
    }
    ...
  ],
  "s3PathForGroupMembers": {
    "bucket": "string",
    "key": "string"
  }
}

--role-arn (строка)

--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
• текст
• таблица
• 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-auto-prompt (логическое значение)

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

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

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

Вывод

Нет