[ aws . iotsitewise ]
обновление-дашборда
Описание
Обновляет панель мониторинга IoT SiteWise.
См. также: Документацию API AWS
Синтаксис
update-dashboard
--dashboard-id <value>
--dashboard-name <value>
[--dashboard-description <value>]
--dashboard-definition <value>
[--client-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]
Параметры
--dashboard-id (строка)
--dashboard-name (строка)
--dashboard-description (строка)
--dashboard-definition (строка)
Новое определение панели мониторинга, как указано в JSON-литерале.
- IoT SiteWise Monitor (Классический) см. Создание панелей мониторинга (CLI)
- IoT SiteWise Monitor (с учетом ИИ) см. Создание панелей мониторинга (CLI)
в Руководстве пользователя IoT SiteWise
--client-token (строка)
--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.
Примеры
Примечание
Чтобы использовать следующие примеры, вам необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для обновления панели мониторинга
Следующий update-dashboard пример изменяет заголовок диаграммы линии панели мониторинга, которая отображает общую выработанную мощность для ветряной электростанции.
aws iotsitewise update-dashboard \
--project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \
--dashboard-name "Wind Farm" \
--dashboard-definition file://update-wind-farm-dashboard.json
Содержимое update-wind-farm-dashboard.json:
{
"widgets": [
{
"type": "monitor-line-chart",
"title": "Total Generated Power",
"x": 0,
"y": 0,
"height": 3,
"width": 3,
"metrics": [
{
"label": "Power",
"type": "iotsitewise",
"assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE"
}
]
}
]
}
Эта команда не выводит никаких данных.
Для получения более подробной информации см. Создание панелей мониторинга (CLI) в Руководстве пользователя AWS IoT SiteWise.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.