Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

describe-asset-model-composite-model

Описание

Получает информацию об агрегированной модели (также известной как компонент модели) модели актива. Дополнительную информацию см. в разделе "Пользовательское создание составных моделей (компоненты)" в Руководстве пользователя IoT SiteWise.

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

Синтаксис

  describe-asset-model-composite-model
--asset-model-id <value>
--asset-model-composite-model-id <value>
[--asset-model-version <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-model-id (строка)

Идентификатор модели актива. Это может быть фактический идентификатор в формате UUID, или же externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе "Ссылка на объекты с внешними идентификаторами" в Руководстве пользователя IoT SiteWise.

--asset-model-composite-model-id (строка)

Идентификатор составной модели в рамках этой модели актива. Это может быть фактический идентификатор в формате UUID, или же externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе "Ссылка на объекты с внешними идентификаторами" в Руководстве пользователя IoT SiteWise.

--asset-model-version (строка)

Псевдоним версии, который определяет последнюю или активную версию модели актива. Детали возвращаются в ответе. Значение по умолчанию - LATEST. См. раздел "Версии моделей актива" в Руководстве пользователя IoT SiteWise.

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

Вывод

assetModelId -> (строка)

Идентификатор модели актива в формате UUID.

assetModelCompositeModelId -> (строка)

Идентификатор составной модели в рамках этой модели актива.

assetModelCompositeModelExternalId -> (строка)

Внешний идентификатор составной модели в рамках этой модели актива.

assetModelCompositeModelPath -> (список)

Путь к составной модели, отображающий родительские составные модели.

(структура)

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

id -> (строка)

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

name -> (строка)

Имя сегмента пути.

assetModelCompositeModelName -> (строка)

Уникальное, понятное имя составной модели.

assetModelCompositeModelDescription -> (строка)

Описание составной модели.

assetModelCompositeModelType -> (строка)

Тип составной модели. Допустимые значения - AWS/ALARM, CUSTOM или AWS/L4E_ANOMALY.

assetModelCompositeModelProperties -> (список)

Определения свойств составной модели.

(структура)

Содержит информацию об свойстве модели актива.

id -> (строка)

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

  • Если вы вызываете UpdateAssetModel для создания нового свойства: Вы можете указать его ID здесь, если хотите. IoT SiteWise автоматически генерирует для вас уникальный ID, поэтому этот параметр никогда не требуется. Однако, если вы предпочитаете указать свой собственный ID, вы можете указать его здесь в формате UUID. Если вы укажете свой собственный ID, он должен быть глобально уникальным.
  • Если вы вызываете UpdateAssetModel для изменения существующего свойства: Это может быть фактический ID в формате UUID, или же externalId:, за которым следует внешний ID, если он есть. Дополнительную информацию см. в разделе "Ссылка на объекты с внешними идентификаторами" в Руководстве пользователя IoT SiteWise.

externalId -> (строка)

Внешний ID (если есть), предоставленный в операции CreateAssetModel или UpdateAssetModel. Вы можете назначить внешний ID, указав это значение в рамках вызова UpdateAssetModel. Однако вы не можете изменить внешний ID, если он уже назначен. Дополнительную информацию см. в разделе "Использование внешних идентификаторов" в Руководстве пользователя IoT SiteWise.

name -> (строка)

Имя свойства модели актива.

dataType -> (строка)

Тип данных свойства модели актива.

Если вы указываете STRUCT, вы также должны указать dataTypeSpec, чтобы определить тип структуры для этого свойства.

dataTypeSpec -> (строка)

Тип данных структуры для этого свойства. Этот параметр существует для свойств, имеющих тип STRUCT.

unit -> (строка)

Единица измерения свойства модели актива, например, Newtons или RPM.

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

Тип свойства (см. PropertyType).

атрибут -> (структура)

Указывает свойство атрибута актива. Атрибут обычно содержит статическую информацию, например, серийный номер ветряной турбины IIoT.

значениеПоУмолчанию -> (строка)

Значение по умолчанию для атрибута свойства модели актива. Все активы, созданные по этой модели актива, содержат это значение атрибута. Вы можете обновить значение атрибута после создания актива. Дополнительную информацию см. в руководстве пользователя IoT SiteWise в разделе «Обновление значений атрибутов».

измерение -> (структура)

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

конфигурацияОбработки -> (структура)

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

конфигурацияПередачи -> (структура)

Конфигурация передачи для данного свойства измерения.

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

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

преобразование -> (структура)

Указывает свойство преобразования актива. Преобразование содержит математическое выражение, которое отображает данные точек свойства из одной формы в другую, например, преобразование единиц измерения с Цельсия на Фаренгейт.

выражение -> (строка)

Математическое выражение, определяющее функцию преобразования. Вы можете указать до 10 переменных на выражение. Вы можете указать до 10 функций на выражение.

Дополнительную информацию см. в разделе «Квоты» в руководстве пользователя IoT SiteWise.

переменные -> (список)

Список переменных, используемых в выражении.

(структура)

Содержит информацию о переменных выражения.

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

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

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

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

idСвойства -> (строка)

Идентификатор свойства для использования в качестве переменной. Вы можете использовать свойство name, если оно относится к той же модели актива. Если свойство имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительную информацию см. в руководстве пользователя IoT SiteWise в разделе «Использование внешних идентификаторов».

idИерархии -> (строка)

Идентификатор иерархии для поиска идентификатора свойства. Вы можете использовать имя иерархии вместо идентификатора иерархии. Если иерархия имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительную информацию см. в руководстве пользователя IoT SiteWise в разделе «Использование внешних идентификаторов».

Идентификатор иерархии используется вместо идентификатора модели, так как может быть несколько иерархий, использующих одну модель и, следовательно, один и тот же propertyId. Например, вы можете иметь отдельные группы активов, которые происходят из одной модели актива. Дополнительную информацию см. в руководстве пользователя IoT SiteWise в разделе «Иерархии активов».

путьСвойства -> (список)

Путь к свойству.

(структура)

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

id -> (строка)

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

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

Имя сегмента пути.

конфигурацияОбработки -> (структура)

Конфигурация обработки для данного свойства преобразования. Вы можете настроить преобразования, чтобы они хранились на границе или передавались в облако Amazon Web Services. Также можно настроить преобразования на вычисление на границе или в облаке.

местоВычисления -> (строка)

Место вычисления для данного свойства преобразования.

конфигурацияПередачи -> (структура)

Конфигурация передачи для данного свойства.

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

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

метрика -> (структура)

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

выражение -> (строка)

Математическое выражение, определяющее функцию агрегации метрики. Вы можете указать до 10 переменных на выражение. Вы можете указать до 10 функций на выражение.

Дополнительную информацию см. в разделе «Квоты» в руководстве пользователя IoT SiteWise.

переменные -> (список)

Список переменных, используемых в выражении.

(структура)

Содержит информацию о переменных выражения.

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

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

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

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

idСвойства -> (строка)

Идентификатор свойства для использования в качестве переменной. Вы можете использовать свойство name, если оно относится к той же модели актива. Если свойство имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительную информацию см. в руководстве пользователя IoT SiteWise в разделе «Использование внешних идентификаторов».

idИерархии -> (строка)

Идентификатор иерархии для поиска идентификатора свойства. Вы можете использовать имя иерархии вместо идентификатора иерархии. Если иерархия имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительную информацию см. в руководстве пользователя IoT SiteWise в разделе «Использование внешних идентификаторов».

Идентификатор иерархии используется вместо идентификатора модели, так как может быть несколько иерархий, использующих одну модель и, следовательно, один и тот же propertyId. Например, вы можете иметь отдельные группы активов, которые происходят из одной модели актива. Дополнительную информацию см. в руководстве пользователя IoT SiteWise в разделе «Иерархии активов».

путьСвойства -> (список)

Путь к свойству.

(структура)

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

id -> (строка)

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

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

Имя сегмента пути.

окно -> (структура)

Окно (интервал времени), в течение которого IoT SiteWise вычисляет выражение агрегации метрики. IoT SiteWise вычисляет одну точку данных за window.

скользящий -> (структура)

Окно скользящего интервала времени.

интервал -> (строка)

Интервал времени для окна скользящего интервала. Интервал времени должен быть от 1 минуты до 1 недели.

IoT SiteWise вычисляет 1w интервал в конце воскресенья в полночь каждую неделю (UTC), 1d интервал в конце каждого дня в полночь (UTC), 1h интервал в конце каждого часа и т. д.

При агрегации точек данных для вычисления метрик, начало каждого интервала исключается, а конец — включается. IoT SiteWise помещает вычисленную точку данных в конце интервала.

смещение -> (строка)

Смещение для окна скользящего интервала. Параметр 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) на следующий день.

конфигурацияОбработки -> (структура)

Конфигурация обработки для данного свойства метрики. Вы можете настроить метрики для вычисления на границе или в облаке Amazon Web Services. По умолчанию метрики передаются в облако.

местоВычисления -> (строка)

Место вычисления для данного свойства метрики.

путь -> (список)

Структурированный путь к свойству от корня модели актива.

(структура)

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

id -> (строка)

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

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

Имя сегмента пути.

деталиСоставления -> (структура)

Метаданные для отношения составления, созданного с помощью composedAssetModelId в ` CreateAssetModelCompositeModel https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html`__ . Например, массив, содержащий путь отношения составления для этой составной модели.

отношениеСоставления -> (список)

Массив, содержащий отношение составления для этой составной модели.

(структура)

Представляет составную модель, которая объединила модель актива типа COMPONENT_MODEL.

id -> (строка)

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

assetModelCompositeModelSummaries -> (список)

Список сводок составного модели для составного модели.

(структура)

Содержит сводку составного модели.

id -> (строка)

Идентификатор составного модели, который описывает эта сводка.

externalId -> (строка)

Внешний идентификатор составного модели на этой модели актива. Дополнительную информацию см. в разделе Использование внешних идентификаторов в руководстве пользователя IoT SiteWise.

name -> (строка)

Имя составного модели, которое описывает эта сводка.

type -> (строка)

Тип составного модели. Допустимые значения — AWS/ALARM , CUSTOM или AWS/L4E_ANOMALY .

description -> (строка)

Описание составного модели, которое описывает эта сводка.

path -> (список)

Путь, включающий все компоненты, составляющие составное модели.

(структура)

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

id -> (строка)

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

name -> (строка)

Имя сегмента пути.

actionDefinitions -> (список)

Доступные действия для составного модели на этой модели актива.

(структура)

Содержит определение действия.

actionDefinitionId -> (строка)

Идентификатор определения действия.

actionName -> (строка)

Имя определения действия.

actionType -> (строка)

Тип определения действия.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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