register-workspace-directory

Описание

Регистрирует указанный каталог. Данная операция асинхронная и возвращает результат до регистрации каталога WorkSpace. Если это первая регистрация каталога, необходимо создать роль workspaces_DefaultRole, прежде чем регистрировать каталог. Дополнительную информацию см. в разделе Создание роли workspaces_DefaultRole.

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

Синтаксис

  register-workspace-directory
[--directory-id <value>]
[--subnet-ids <value>]
[--enable-self-service | --no-enable-self-service]
[--tenancy <value>]
[--tags <value>]
[--workspace-directory-name <value>]
[--workspace-directory-description <value>]
[--user-identity-type <value>]
[--idc-instance-arn <value>]
[--microsoft-entra-config <value>]
[--workspace-type <value>]
[--active-directory-config <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]

Параметры

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

--subnet-ids (список)

Синтаксис:

"string" "string" ...

--enable-self-service | --no-enable-self-service (булево)

--tenancy (строка)

--tags (список)

Упрощённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--workspace-directory-name (строка)

--workspace-directory-description (строка)

--user-identity-type (строка)

--idc-instance-arn (строка)

--microsoft-entra-config (структура)

Упрощённый синтаксис:

TenantId=string,ApplicationConfigSecretArn=string

Синтаксис JSON:

{
  "TenantId": "string",
  "ApplicationConfigSecretArn": "string"
}

--workspace-type (строка)

--active-directory-config (структура)

Упрощённый синтаксис:

DomainName=string,ServiceAccountSecretArn=string

Синтаксис JSON:

{
  "DomainName": "string",
  "ServiceAccountSecretArn": "string"
}

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

Примеры

Для регистрации каталога

Следующий register-workspace-directory пример регистрирует указанный каталог для использования с Amazon WorkSpaces.

aws workspaces register-workspace-directory \
    --directory-id d-926722edaf \
    --no-enable-work-docs

Эта команда не генерирует вывод.

Дополнительную информацию см. в разделе Регистрация каталога с WorkSpaces в руководстве по администрированию Amazon WorkSpaces.

Вывод

DirectoryId -> (строка)

State -> (строка)