[ aws . iotsitewise ]
list-asset-model-properties
Описание
Получает постраничный список свойств, связанных с моделью актива. Если вы обновите свойства, связанные с моделью, прежде чем закончите перечисление всех свойств, вам необходимо начать сначала.
См. также: Документация API AWS
list-asset-model-properties — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный вывод, аргумент --query должен извлекать данные из результатов следующих выражений запроса: assetModelPropertySummaries
Синтаксис
list-asset-model-properties
--asset-model-id <value>
[--filter <value>]
[--asset-model-version <value>]
[--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]
Параметры
--asset-model-id (строка)
externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе «Ссылка на объекты с внешними идентификаторами» в руководстве пользователя IoT SiteWise.--filter (строка)
Фильтрует запрашиваемый список свойств модели актива. Вы можете выбрать один из следующих вариантов:
-
ALL— список включает все свойства модели актива для заданного идентификатора модели актива. -
BASE— список включает только базовые свойства модели актива для заданного идентификатора модели актива.
По умолчанию: BASE
Возможные значения:
ALLBASE
--asset-model-version (строка)
LATEST. См. раздел «Версии моделей актива» в руководстве пользователя IoT SiteWise.--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью JSON-предоставленного значения, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничного вывода. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.
--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.
Вывод
assetModelPropertySummaries -> (список)
Список, который обобщает свойства, связанные со специфицированной моделью актива.
(структура)
Содержит сводку свойства, связанного с моделью.
id -> (строка)
externalId -> (строка)
name -> (строка)
dataType -> (строка)
dataTypeSpec -> (строка)
STRUCT.unit -> (строка)
Newtons или RPM).type -> (структура)
Содержит тип свойства, который может быть одним из attribute , measurement , metric или transform .
attribute -> (структура)
Указывает свойство-атрибут актива. Атрибут обычно содержит статическую информацию, например, серийный номер ветряной турбины IIoT.
defaultValue -> (строка)
measurement -> (структура)
Указывает свойство-измерение актива. Измерение представляет собой поток сырых сенсорных данных устройства, например, временные метки значений температуры или временные метки значений мощности.
processingConfig -> (структура)
Настройка обработки для данного свойства измерения. Вы можете настроить измерения, чтобы они хранились на границе или передавались в облако Amazon Web Services. По умолчанию измерения передаются в облако.
forwardingConfig -> (структура)
Настройка переадресации для данного свойства измерения.
state -> (строка)
transform -> (структура)
Указывает свойство-преобразование актива. Преобразование содержит математическое выражение, которое отображает данные точек свойства из одной формы в другую, например, преобразование единиц измерения из Цельсия в Фаренгейт.
expression -> (строка)
Математическое выражение, определяющее функцию преобразования. Вы можете указать до 10 переменных на выражение. Вы можете указать до 10 функций на выражение.
Для получения дополнительной информации см. Квоты в руководстве пользователя IoT SiteWise.
variables -> (список)
Список переменных, используемых в выражении.
(структура)
Содержит информацию о переменных выражения.
name -> (строка)
value -> (структура)
Переменная, которая идентифицирует свойство актива для использования значений.
propertyId -> (строка)
name, если оно из той же модели актива. Если свойство имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Для получения дополнительной информации см. Использование внешних идентификаторов в руководстве пользователя IoT SiteWise.hierarchyId -> (строка)
Идентификатор иерархии для запроса идентификатора свойства. Вы можете использовать имя иерархии вместо идентификатора иерархии. Если иерархия имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Для получения дополнительной информации см. Использование внешних идентификаторов в руководстве пользователя IoT SiteWise.
Идентификатор иерархии используется вместо идентификатора модели, потому что у вас могут быть несколько иерархий, использующих одну и ту же модель, и, следовательно, тот же propertyId. Например, у вас могут быть отдельно сгруппированные активы, которые происходят из одной и той же модели актива. Для получения дополнительной информации см. Иерархии активов в руководстве пользователя IoT SiteWise.
propertyPath -> (список)
Путь к свойству.
(структура)
Представляет один уровень между свойством и корнем модели актива.
id -> (строка)
name -> (строка)
processingConfig -> (структура)
Настройка обработки для данного свойства преобразования. Вы можете настроить преобразования, чтобы они хранились на границе или передавались в облако Amazon Web Services. Вы также можете настроить преобразования, чтобы они вычислялись на границе или в облаке.
computeLocation -> (строка)
forwardingConfig -> (структура)
Настройка переадресации для данного свойства.
state -> (строка)
metric -> (структура)
Указывает свойство-метрику актива. Метрика содержит математическое выражение, которое использует агрегационные функции для обработки всех входных точек данных в течение интервала времени и вывода одной точки данных, например, для расчета средней часовой температуры.
expression -> (строка)
Математическое выражение, определяющее функцию агрегирования метрики. Вы можете указать до 10 переменных на выражение. Вы можете указать до 10 функций на выражение.
Для получения дополнительной информации см. Квоты в руководстве пользователя IoT SiteWise.
variables -> (список)
Список переменных, используемых в выражении.
(структура)
Содержит информацию о переменных выражения.
name -> (строка)
value -> (структура)
Переменная, которая идентифицирует свойство актива для использования значений.
propertyId -> (строка)
name, если оно из той же модели актива. Если свойство имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Для получения дополнительной информации см. Использование внешних идентификаторов в руководстве пользователя IoT SiteWise.hierarchyId -> (строка)
Идентификатор иерархии для запроса идентификатора свойства. Вы можете использовать имя иерархии вместо идентификатора иерархии. Если иерархия имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Для получения дополнительной информации см. Использование внешних идентификаторов в руководстве пользователя IoT SiteWise.
Идентификатор иерархии используется вместо идентификатора модели, потому что у вас могут быть несколько иерархий, использующих одну и ту же модель, и, следовательно, тот же propertyId. Например, у вас могут быть отдельно сгруппированные активы, которые происходят из одной и той же модели актива. Для получения дополнительной информации см. Иерархии активов в руководстве пользователя IoT SiteWise.
propertyPath -> (список)
Путь к свойству.
(структура)
Представляет один уровень между свойством и корнем модели актива.
id -> (строка)
name -> (строка)
window -> (структура)
Окно (интервал времени), в котором IoT SiteWise вычисляет выражение агрегирования метрики. IoT SiteWise вычисляет одну точку данных за window .
tumbling -> (структура)
Окно интервала времени для скользящего окна.
interval -> (строка)
Интервал времени для скользящего окна. Интервал времени должен быть от 1 минуты до 1 недели.
IoT SiteWise вычисляет 1w интервал в конце воскресенья в полночь каждую неделю (UTC), 1d интервал в конце каждого дня в полночь (UTC), 1h интервал в конце каждого часа и так далее.
При агрегировании точек данных для вычисления метрики начало каждого интервала является исключительным, а конец каждого интервала — включительным. IoT SiteWise помещает вычисленную точку данных в конце интервала.
offset -> (строка)
Смещение для скользящего окна. Параметр offset принимает следующие значения:
- Время смещения. Например, если вы укажете
18hдляoffsetи1dдляinterval, IoT SiteWise агрегирует данные следующим образом:- Если вы создадите метрику до или в 18:00 (UTC), вы получите первый результат агрегирования в 18:00 (UTC) в день создания метрики.
- Если вы создадите метрику после 18:00 (UTC), вы получите первый результат агрегирования в 18:00 (UTC) на следующий день.
- Формат ISO 8601. Например, если вы укажете
PT18Hдляoffsetи1dдляinterval, IoT SiteWise агрегирует данные следующим образом:- Если вы создадите метрику до или в 18:00 (UTC), вы получите первый результат агрегирования в 18:00 (UTC) в день создания метрики.
- Если вы создадите метрику после 18:00 (UTC), вы получите первый результат агрегирования в 18:00 (UTC) на следующий день.
- 24-часовой формат. Например, если вы укажете
00:03:00дляoffset,5mдляinterval, и вы создадите метрику в 14:00 (UTC), вы получите первый результат агрегирования в 14:03 (UTC). Вы получите второй результат агрегирования в 14:08 (UTC). - Часовой пояс смещения. Например, если вы укажете
2021-07-23T18:00-08дляoffsetи1dдляinterval, IoT SiteWise агрегирует данные следующим образом:- Если вы создадите метрику до или в 18:00 (PST), вы получите первый результат агрегирования в 18:00 (PST) в день создания метрики.
- Если вы создадите метрику после 18:00 (PST), вы получите первый результат агрегирования в 18:00 (PST) на следующий день.
processingConfig -> (структура)
Настройка обработки для данного свойства метрики. Вы можете настроить метрики, чтобы они вычислялись на границе или в облаке Amazon Web Services. По умолчанию метрики передаются в облако.
computeLocation -> (строка)
assetModelCompositeModelId -> (строка)
path -> (список)
Структурированный путь к свойству от корня модели актива.
(структура)
Представляет один уровень между свойством и корнем модели актива.
id -> (строка)
name -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.