Spec-Zone.ru › AWS CLI v2

[ aws . panorama ]

list-devices

Описание

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

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

Синтаксис

  list-devices
[--device-aggregated-status-filter <value>]
[--max-results <value>]
[--name-filter <value>]
[--next-token <value>]
[--sort-by <value>]
[--sort-order <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]

Параметры

--device-aggregated-status-filter (строка)

Фильтр по статусу устройства.

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

  • ERROR
  • AWAITING_PROVISIONING
  • PENDING
  • FAILED
  • DELETING
  • ONLINE
  • OFFLINE
  • LEASE_EXPIRED
  • UPDATE_NEEDED
  • REBOOTING

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

Максимальное количество устройств, возвращаемых на одной странице результатов.

--name-filter (строка)

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

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

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

--sort-by (строка)

Целевая колонка для сортировки. По умолчанию сортировка по столбцу CREATED_TIME.

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

  • DEVICE_ID
  • CREATED_TIME
  • NAME
  • DEVICE_AGGREGATED_STATUS

--sort-order (строка)

Порядок сортировки возвращаемого списка. По умолчанию SortOrder — DESCENDING, основанный на CREATED_TIME. В противном случае SortOrder — ASCENDING.

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

  • ASCENDING
  • DESCENDING

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

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Устройства -> (список)

Список устройств.

(структура)

Устройство.

Бренд -> (строка)

Производитель устройства.

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

Время создания устройства.

CurrentSoftware -> (строка)

Текущее программное обеспечение устройства.

Description -> (строка)

Описание устройства.

DeviceAggregatedStatus -> (строка)

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

DeviceId -> (строка)

Идентификатор устройства.

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

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

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

Последняя задача устройства. Включает целевую версию изображения и статус задачи обновления.

ImageVersion -> (строка)

Целевая версия программного обеспечения устройства.

JobType -> (строка)

Тип задачи.

Status -> (строка)

Статус последней задачи устройства.

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

Дата окончания аренды устройства.

Name -> (строка)

Имя устройства.

ProvisioningStatus -> (строка)

Статус подготовки устройства.

Tags -> (отображение)

Теги устройства.

ключ -> (строка)

значение -> (строка)

Type -> (строка)

Тип устройства.

NextToken -> (строка)

Маркер пагинации, который включен, если доступны дополнительные результаты.

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

Spec-Zone.ru

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