Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-thin-client ]

обновить-среду

Описание

Обновляет среду.

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

Синтаксис

  update-environment
--id <value>
[--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>]
[--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]

Параметры

--id (строка)

Идентификатор среды, которую нужно обновить.

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

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

--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 (логическое значение)

Включает отладочную регистрацию.

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

Вывод

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