create-asset-model

Description

Создает модель актива из указанных определений свойств и иерархии. Вы создаете активы из моделей активов. С помощью моделей активов вы можете легко создавать активы одного типа со стандартизированными определениями. Каждый актив, созданный из модели, наследует определения свойств и иерархии модели актива. Для получения дополнительной информации см. раздел Определение моделей активов в Руководстве пользователя IoT SiteWise .

Вы можете создать два типа моделей активов: ASSET_MODEL или COMPONENT_MODEL .

• ASSET_MODEL – (по умолчанию) Модель актива, которую можно использовать для создания активов. Не может быть включена в качестве компонента в другую модель актива.
• COMPONENT_MODEL – Многоразовый компонент, который можно включить в составные модели других моделей активов. Нельзя создавать активы непосредственно из этого типа модели актива.

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

Synopsis

  create-asset-model
--asset-model-name <value>
[--asset-model-type <value>]
[--asset-model-id <value>]
[--asset-model-external-id <value>]
[--asset-model-description <value>]
[--asset-model-properties <value>]
[--asset-model-hierarchies <value>]
[--asset-model-composite-models <value>]
[--client-token <value>]
[--tags <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]

Options

--asset-model-name (string)

--asset-model-type (string)

--asset-model-id (string)

--asset-model-external-id (string)

--asset-model-description (string)

--asset-model-properties (list)

Сокращенный синтаксис:

id=string,externalId=string,name=string,childAssetModelId=string ...

Синтаксис JSON:

[
  {
    "id": "string",
    "externalId": "string",
    "name": "string",
    "childAssetModelId": "string"
  }
  ...
]

--asset-model-composite-models (список)

Синтаксис JSON:

[
  {
    "id": "string",
    "externalId": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "properties": [
      {
        "id": "string",
        "externalId": "string",
        "name": "string",
        "dataType": "STRING"|"INTEGER"|"DOUBLE"|"BOOLEAN"|"STRUCT",
        "dataTypeSpec": "string",
        "unit": "string",
        "type": {
          "attribute": {
            "defaultValue": "string"
          },
          "measurement": {
            "processingConfig": {
              "forwardingConfig": {
                "state": "DISABLED"|"ENABLED"
              }
            }
          },
          "transform": {
            "expression": "string",
            "variables": [
              {
                "name": "string",
                "value": {
                  "propertyId": "string",
                  "hierarchyId": "string",
                  "propertyPath": [
                    {
                      "id": "string",
                      "name": "string"
                    }
                    ...
                  ]
                }
              }
              ...
            ],
            "processingConfig": {
              "computeLocation": "EDGE"|"CLOUD",
              "forwardingConfig": {
                "state": "DISABLED"|"ENABLED"
              }
            }
          },
          "metric": {
            "expression": "string",
            "variables": [
              {
                "name": "string",
                "value": {
                  "propertyId": "string",
                  "hierarchyId": "string",
                  "propertyPath": [
                    {
                      "id": "string",
                      "name": "string"
                    }
                    ...
                  ]
                }
              }
              ...
            ],
            "window": {
              "tumbling": {
                "interval": "string",
                "offset": "string"
              }
            },
            "processingConfig": {
              "computeLocation": "EDGE"|"CLOUD"
            }
          }
        }
      }
      ...
    ]
  }
  ...
]

--client-token (string)

--tags (map)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если в командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с использованием значения, предоставленного JSON, поскольку строка будет воспринята буквально. Это нельзя указывать вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если не указано значение или указано значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI, и в сгенерированном скелете JSON нет гарантий обратной совместимости.

Общие параметры

--debug (boolean)

Включить ведение журнала отладки.

--endpoint-url (string)

Переопределите URL по умолчанию для команды данным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии со службами AWS. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию при проверке сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую разбивку на страницы. Если автоматическая разбивка на страницы отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования выходных данных команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Пакет сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокироваться и не истечет. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокироваться и не истечет. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших двоичных объектов. Формат по умолчанию — 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 (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Чтобы создать модель актива

В следующем примере create-asset-model создается модель актива, которая определяет ветряную турбину со следующими свойствами:

• Серийный номер — серийный номер ветряной турбины
• Вырабатываемая мощность — поток данных о вырабатываемой мощности от ветряной турбины
• Температура C — поток данных о температуре от ветряной турбины в градусах Цельсия
• Температура F — сопоставленные точки данных о температуре от Цельсия к Фаренгейту

aws iotsitewise create-asset-model \
    --cli-input-json file://create-wind-turbine-model.json

Содержимое create-wind-turbine-model.json:

{
    "assetModelName": "Wind Turbine Model",
    "assetModelDescription": "Represents a wind turbine",
    "assetModelProperties": [
        {
            "name": "Serial Number",
            "dataType": "STRING",
            "type": {
                "attribute": {}
            }
        },
        {
            "name": "Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature C",
            "dataType": "DOUBLE",
            "unit": "Celsius",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature F",
            "dataType": "DOUBLE",
            "unit": "Fahrenheit",
            "type": {
                "transform": {
                    "expression": "temp_c * 9 / 5 + 32",
                    "variables": [
                        {
                            "name": "temp_c",
                            "value": {
                                "propertyId": "Temperature C"
                            }
                        }
                    ]
                }
            }
        },
        {
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "propertyId": "Generated Power"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        }
    ]
}

Вывод:

{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "assetModelStatus": {
        "state": "CREATING"
    }
}

Для получения дополнительной информации см. раздел Определение моделей активов в Руководстве пользователя AWS IoT SiteWise.

Вывод

assetModelId -> (string)

assetModelArn -> (string)

assetModelStatus -> (structure)