Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-thin-client ]

получить-среду

Описание

Возвращает информацию об окружении.

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

Синтаксис

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

Идентификатор среды, для которой требуется информация.

--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
  • таблица
  • 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.

Вывод

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

Описание среды.

id -> (строка)

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

name -> (строка)

Имя среды.

desktopArn -> (строка)

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

desktopEndpoint -> (строка)

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

desktopType -> (строка)

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

activationCode -> (строка)

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

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

Количество зарегистрированных устройств в среде.

softwareSetUpdateSchedule -> (строка)

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

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

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

type -> (строка)

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

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

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

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

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

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

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

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

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

daysOfTheWeek -> (список)

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

(строка)

applyTimeOf -> (строка)

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

softwareSetUpdateMode -> (строка)

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

desiredSoftwareSetId -> (строка)

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

pendingSoftwareSetId -> (строка)

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

pendingSoftwareSetVersion -> (строка)

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

softwareSetComplianceStatus -> (строка)

Описывает, является ли установленная в настоящее время на всех устройствах в среде версия программного обеспечения поддерживаемой.

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

Временная метка создания среды.

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

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

arn -> (строка)

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

kmsKeyArn -> (строка)

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

tags -> (карта)

Ключи тегов и необязательные значения для ресурса.

key -> (строка)

value -> (строка)

deviceCreationTags -> (карта)

Ключи тегов и необязательные значения для вновь созданных устройств для этой среды.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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