Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-thin-client ]

создать-среду

Описание

Создает среду для ваших устройств тонких клиентов.

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

Синтаксис

  create-environment
[--name <value>]
--desktop-arn <value>
[--desktop-endpoint <value>]
[--software-set-update-schedule <value>]
[--maintenance-window <value>]
[--software-set-update-mode <value>]
[--desired-software-set-id <value>]
[--kms-key-arn <value>]
[--client-token <value>]
[--tags <value>]
[--device-creation-tags <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]

Параметры

--name (строка)

Имя среды.

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

Amazon Resource Name (ARN) рабочего стола для потоковой передачи из Amazon WorkSpaces, WorkSpaces Secure Browser или AppStream 2.0.

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

URL для входа в систему поставщика идентификации (только для сред, использующих AppStream 2.0).

--software-set-update-schedule (строка)

Параметр для определения, должны ли применяться обновления программного обеспечения в рамках окна обслуживания.

Возможные значения:

  • USE_MAINTENANCE_WINDOW
  • APPLY_IMMEDIATELY

--maintenance-window (структура)

Спецификация для временного интервала применения обновлений программного обеспечения.

type -> (строка)

Параметр для выбора стандартного или пользовательского окна обслуживания.

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

Час начала окна обслуживания (00 -23).

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

Минуты после часа начала окна обслуживания (00 -59).

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

Час окончания окна обслуживания (00 -23).

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

Минуты окончания окна обслуживания (00 -59).

daysOfTheWeek -> (список)

Дни недели, в которые открыто окно обслуживания.

(строка)

applyTimeOf -> (строка)

Параметр для установки окна обслуживания в местное время устройства или в универсальном скоординированном времени (UTC).

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

type=string,startTimeHour=integer,startTimeMinute=integer,endTimeHour=integer,endTimeMinute=integer,daysOfTheWeek=string,string,applyTimeOf=string

Синтаксис JSON:

{
  "type": "SYSTEM"|"CUSTOM",
  "startTimeHour": integer,
  "startTimeMinute": integer,
  "endTimeHour": integer,
  "endTimeMinute": integer,
  "daysOfTheWeek": ["MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY", ...],
  "applyTimeOf": "UTC"|"DEVICE"
}

--software-set-update-mode (строка)

Параметр для определения, какие обновления программного обеспечения применять.

Возможные значения:

  • USE_LATEST
  • USE_DESIRED

--desired-software-set-id (строка)

Идентификатор набора программного обеспечения для применения.

--kms-key-arn (строка)

Amazon Resource Name (ARN) ключа управления ключами для шифрования среды.

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

Указывает уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса. Это позволяет безопасно повторно отправлять запрос без случайного выполнения той же операции дважды. Передача того же значения в последующий вызов операции требует, чтобы вы также передали то же значение для всех других параметров. Рекомендуется использовать значение типа UUID.

Если вы не предоставите это значение, Amazon Web Services сгенерирует случайное для вас.

Если вы повторно отправляете операцию с тем же ClientToken, но с другими параметрами, повторная попытка завершится ошибкой IdempotentParameterMismatch.

--tags (карта)

Карта пар ключ-значение тега или тегов для назначения ресурсу.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--device-creation-tags (карта)

Карта пар ключ-значение тега или тегов для назначения новым созданным устройствам для этой среды.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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 (boolean)

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

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

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

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

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

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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

Описывает среду.

id -> (строка)

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

name -> (строка)

Имя среды.

desktopArn -> (строка)

Amazon Resource Name (ARN) рабочего стола для потоковой передачи из Amazon WorkSpaces, WorkSpaces Secure Browser или AppStream 2.0.

desktopEndpoint -> (строка)

URL для входа в систему поставщика идентификации (только для сред, использующих AppStream 2.0).

desktopType -> (строка)

Тип потокового рабочего стола для среды.

activationCode -> (строка)

Код активации для регистрации устройства в среде.

softwareSetUpdateSchedule -> (строка)

Параметр для определения, должны ли применяться обновления программного обеспечения в рамках окна обслуживания.

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

Спецификация временного интервала для применения обновлений программного обеспечения.

type -> (строка)

Параметр для выбора окна обслуживания по умолчанию или настраиваемого.

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

Час начала окна обслуживания (00 -23).

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

Минуты после часа начала окна обслуживания (00 -59).

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

Час окончания окна обслуживания (00 -23).

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

Минуты для окончания окна обслуживания (00 -59).

daysOfTheWeek -> (список)

Дни недели, в которые открыто окно обслуживания.

(строка)

applyTimeOf -> (строка)

Параметр для установки окна обслуживания в местном времени устройства или по Всемирному координированному времени (UTC).

softwareSetUpdateMode -> (строка)

Параметр для определения, какие обновления программного обеспечения применять.

desiredSoftwareSetId -> (строка)

Идентификатор набора программного обеспечения для применения.

pendingSoftwareSetId -> (строка)

Идентификатор набора программного обеспечения, ожидающего установки.

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

Маркер времени создания среды.

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

Маркер времени обновления устройства.

arn -> (строка)

Amazon Resource Name (ARN) среды.

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

Spec-Zone.ru

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