Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-thin-client ]

list-environments

Описание

Возвращает список сред.

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

list-environments — это операция с постраничной загрузкой. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную загрузку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: environments

Синтаксис

  list-environments
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания места начала постраничной загрузки. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя командной строки AWS.

--page-size (целое число)

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

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов, которое нужно вернуть в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную загрузку, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя командной строки AWS.

--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 для вывода.

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

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

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

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

Вывод

environments -> (список)

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

(структура)

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

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) среды.

nextToken -> (строка)

Если nextToken возвращено, доступны дополнительные результаты. Значение nextToken — уникальный токен постраничной загрузки для каждой страницы. Выполните вызов снова с возвращенным токеном, чтобы получить следующую страницу. Сохраните все остальные аргументы без изменений. Каждый токен постраничной загрузки действует 24 часа. Использование истекшего токена постраничной загрузки вернет ошибку HTTP 400 InvalidToken.

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

Spec-Zone.ru

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