Spec-Zone.ru › AWS CLI v2

[ aws . workdocs ]

создать-пользователя

Описание

Создает пользователя в каталоге Simple AD или Microsoft AD. Статус вновь созданного пользователя — «АКТИВЕН». Новые пользователи могут получить доступ к Amazon WorkDocs.

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

Синтаксис

  create-user
[--organization-id <value>]
--username <value>
[--email-address <value>]
--given-name <value>
--surname <value>
--password <value>
[--time-zone-id <value>]
[--storage-rule <value>]
[--authentication-token <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]

Параметры

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

Идентификатор организации.

--username (строка)

Имя пользователя для входа.

--email-address (строка)

Электронный адрес пользователя.

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

Имя пользователя.

--surname (строка)

Фамилия пользователя.

--password (строка)

Пароль пользователя.

--time-zone-id (строка)

Идентификатор часового пояса пользователя.

--storage-rule (структура)

Объем хранилища для пользователя.

StorageAllocatedInBytes -> (длинное целое число)

Объем выделенного хранилища в байтах.

StorageType -> (строка)

Тип хранилища.

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

StorageAllocatedInBytes=long,StorageType=string

Синтаксис JSON:

{
  "StorageAllocatedInBytes": long,
  "StorageType": "UNLIMITED"|"QUOTA"
}

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

Токен аутентификации Amazon WorkDocs. Не требуется при использовании учетных данных администратора Amazon Web Services для доступа к API.

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, подобные Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для создания нового пользователя

В этом примере создается новый пользователь в каталоге Simple AD или Microsoft AD.

Команда:

aws workdocs create-user --organization-id d-926726012c --username exampleUser2 --email-address exampleUser2@site.awsapps.com --given-name example2Name --surname example2Surname --password examplePa$$w0rd

Вывод:

{
  "User": {
      "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "Username": "exampleUser2",
      "EmailAddress": "exampleUser2@site.awsapps.com",
      "GivenName": "example2Name",
      "Surname": "example2Surname",
      "OrganizationId": "d-926726012c",
      "RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390",
      "RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff",
      "Status": "ACTIVE",
      "Type": "MINIMALUSER",
      "CreatedTimestamp": 1535478836.584,
      "ModifiedTimestamp": 1535478836.584,
      "Storage": {
          "StorageUtilizedInBytes": 0,
          "StorageRule": {
              "StorageAllocatedInBytes": 0,
              "StorageType": "QUOTA"
          }
      }
  }
}

Вывод

Пользователь -> (структура)

Информация о пользователе.

Id -> (строка)

Идентификатор пользователя.

ИмяПользователя -> (строка)

Имя пользователя для входа.

EmailAddress -> (строка)

Электронный адрес пользователя.

GivenName -> (строка)

Имя пользователя.

Surname -> (строка)

Фамилия пользователя.

OrganizationId -> (строка)

Идентификатор организации.

RootFolderId -> (строка)

Идентификатор корневой папки.

RecycleBinFolderId -> (строка)

Идентификатор папки корзины.

Статус -> (строка)

Статус пользователя.

Тип -> (строка)

Тип пользователя.

CreatedTimestamp -> (отметка времени)

Дата создания пользователя.

ModifiedTimestamp -> (отметка времени)

Дата изменения пользователя.

TimeZoneId -> (строка)

Идентификатор часового пояса пользователя.

Locale -> (строка)

Локаль пользователя.

Хранилище -> (структура)

Хранилище пользователя.

StorageUtilizedInBytes -> (длинное целое число)

Объем используемого хранилища в байтах.

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

Хранилище пользователя.

StorageAllocatedInBytes -> (длинное целое число)

Объем выделенного хранилища в байтах.

StorageType -> (строка)

Тип хранилища.

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

Spec-Zone.ru

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