[ aws . iotsitewise ]
обновить-свойство-актива
Описание
Обновляет псевдоним и состояние уведомлений свойства актива.
Предупреждение
Данная операция перезаписывает существующий псевдоним и состояние уведомлений свойства. Чтобы сохранить существующий псевдоним или состояние уведомлений свойства, необходимо включить существующие значения в запросе UpdateAssetProperty. Для получения дополнительной информации см. DescribeAssetProperty.См. также: Документация API AWS
Синтаксис
update-asset-property
--asset-id <value>
--property-id <value>
[--property-alias <value>]
[--property-notification-state <value>]
[--client-token <value>]
[--property-unit <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]
Параметры
--asset-id (строка)
externalId:, за которым следует внешний идентификатор, если он есть. Для получения дополнительной информации см. Ссылка на объекты с внешними идентификаторами в Руководстве пользователя IoT SiteWise.--property-id (строка)
externalId:, за которым следует внешний идентификатор, если он есть. Для получения дополнительной информации см. Ссылка на объекты с внешними идентификаторами в Руководстве пользователя IoT SiteWise.--property-alias (строка)
Псевдоним, идентифицирующий свойство, например, путь к потоку данных сервера OPC-UA (например, /company/windfarm/3/turbine/7/temperature). Для получения дополнительной информации см. Сопоставление промышленных потоков данных со свойствами активов в Руководстве пользователя IoT SiteWise.
Если этот параметр опущен, псевдоним удаляется из свойства.
--property-notification-state (строка)
Состояние уведомления MQTT (включено или выключено) для данного свойства актива. При включенном состоянии уведомления IoT SiteWise публикует обновления значений свойств на уникальную тему MQTT. Для получения дополнительной информации см. Взаимодействие с другими службами в Руководстве пользователя IoT SiteWise.
Если этот параметр опущен, состояние уведомлений устанавливается в значение DISABLED.
Возможные значения:
ENABLEDDISABLED
--client-token (строка)
--property-unit (строка)
assetModelProperty в модели актива.--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 (строка)
Переопределить адрес по умолчанию команды указанным адресом.
--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.
Пример 1: Обновление псевдонима свойства актива
Следующий update-asset-property пример обновляет псевдоним свойства «мощность» актива ветряной турбины.
aws iotsitewise update-asset-property \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
--property-id a1b2c3d4-5678-90ab-cdef-55555EXAMPLE \
--property-alias "/examplecorp/windfarm/1/turbine/1/power" \
--property-notification-state DISABLED
Эта команда не выводит данных.
Для получения дополнительной информации см. Сопоставление промышленных потоков данных со свойствами активов в Руководстве пользователя AWS IoT SiteWise.
Пример 2: Включение уведомлений о свойствах актива
Следующий update-asset-property пример включает уведомления об обновлениях свойств актива для свойства «мощность» актива ветряной турбины. Обновления значений свойств публикуются на тему MQTT $aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, где каждый ID заменяется идентификатором свойства, актива и модели свойства актива.
aws iotsitewise update-asset-property \
--asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
--property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
--property-notification-state ENABLED \
--property-alias "/examplecorp/windfarm/1/turbine/1/power"
Эта команда не выводит данных.
Для получения дополнительной информации см. Взаимодействие с другими службами в Руководстве пользователя AWS IoT SiteWise.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.