Spec-Zone.ru › AWS CLI v2

[ aws . workspaces ]

describe-workspaces-pools

Описание

Описывает указанные пулы WorkSpaces.

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

Синтаксис

  describe-workspaces-pools
[--pool-ids <value>]
[--filters <value>]
[--limit <value>]
[--next-token <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]

Параметры

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

Идентификатор пулов WorkSpaces.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Условие фильтрации для возвращаемого пула WorkSpaces.

(структура)

Описывает условия фильтрации для возврата пулов WorkSpaces.

Name -> (строка)

Имя пула для фильтрации.

Values -> (список)

Значения для фильтрации пулов WorkSpaces.

(строка)

Operator -> (строка)

Значения операторов для фильтрации пулов WorkSpaces.

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

Name=string,Values=string,string,Operator=string ...

Синтаксис JSON:

[
  {
    "Name": "PoolName",
    "Values": ["string", ...],
    "Operator": "EQUALS"|"NOTEQUALS"|"CONTAINS"|"NOTCONTAINS"
  }
  ...
]

--limit (целое число)

Максимальное количество возвращаемых элементов.

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

Если в предыдущем вызове, который был постраничным, вы получили NextToken, предоставьте этот токен, чтобы получить следующий набор результатов.

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

Вывод

WorkspacesPools -> (список)

Информация о пулах WorkSpaces.

(структура)

Описание пула WorkSpaces.

PoolId -> (строка)

Идентификатор пула.

PoolArn -> (строка)

Amazon Resource Name (ARN) пула.

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

Статус емкости для пула

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

Количество пользовательских сессий, в настоящее время доступных для потоковой передачи из вашего пула.

AvailableUserSessions = ActualUserSessions - ActiveUserSessions

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

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

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

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

ActualUserSessions = AvailableUserSessions + ActiveUserSessions

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

Количество пользовательских сессий, которые в настоящее время используются для вашего пула.

PoolName -> (строка)

Имя пула.

Description -> (строка)

Описание пула.

State -> (строка)

Текущее состояние пула.

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

Время создания пула.

BundleId -> (строка)

Идентификатор пакета, используемого пулом.

DirectoryId -> (строка)

Идентификатор каталога, используемого пулом.

Errors -> (список)

Ошибки пула.

(структура)

Описание ошибки пула.

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

Сообщение об ошибке.

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

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

Status -> (строка)

Указывает, включены ли постоянные параметры приложения для пользователей во время сессий пула.

SettingsGroup -> (строка)

Префикс пути для S3-ведра, где хранятся постоянные параметры приложения пользователей.

S3BucketName -> (строка)

S3-ведро, где хранятся постоянные параметры приложения пользователей. При первом включении постоянных параметров приложения для учетной записи в Amazon Web Services Region создается S3-ведро. Ведро уникально для учетной записи Amazon Web Services и Region.

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

Время, в течение которого сессия пула остается активной после отключения пользователей. Если они пытаются повторно подключиться к сессии пула после отключения или прерывания сети в течение этого интервала, они подключаются к своей предыдущей сессии. В противном случае они подключаются к новой сессии с новым экземпляром пула.

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

Указывает время в секундах, в течение которого сессия потоковой передачи остается активной после отключения пользователей. Если пользователи пытаются повторно подключиться к сессии потоковой передачи после отключения или прерывания сети в течение заданного времени, они подключаются к предыдущей сессии. В противном случае они подключаются к новой сессии с новым экземпляром потоковой передачи.

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

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

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

Указывает максимальное время в секундах, в течение которого сессия потоковой передачи может оставаться активной. Если пользователи все еще подключены к экземпляру потоковой передачи за пять минут до достижения этого ограничения, им предлагается сохранить любые открытые документы перед отключением. После истечения этого времени экземпляр завершается и заменяется новым.

RunningMode -> (строка)

Режим работы пула.

NextToken -> (строка)

Если в предыдущем вызове, который был постраничным, вы получили NextToken, предоставьте этот токен, чтобы получить следующий набор результатов.

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

Spec-Zone.ru

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