Actualización de un modelo de activo o componente (AWS CLI) - AWS IoT SiteWise

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Actualización de un modelo de activo o componente (AWS CLI)

Puede usar el AWS Command Line Interface (AWS CLI) para actualizar un modelo de activos o un modelo de componentes.

Utilice la API de UpdateAssetmodelos para actualizar el nombre, la descripción y las propiedades de un modelo de activos o un modelo de componentes. Solo en el caso de los modelos de activos, puede actualizar las jerarquías. Especifique los siguientes parámetros:

Especifique el modelo actualizado en la carga útil. Para obtener información sobre el formato esperado de un modelo de activos o un modelo de componentes, consulteCreación de modelos de activos.

aviso

La API de UpdateAssetmodelos sobrescribe el modelo existente con el modelo que usted proporciona en la carga útil. Para evitar eliminar las propiedades o jerarquías del modelo, debes incluir sus ID y definiciones en la carga útil del modelo actualizado. Para obtener información sobre cómo consultar la estructura existente del modelo, consulte la operación del DescribeAssetmodelo.

nota

El siguiente procedimiento solo puede actualizar modelos compuestos de este tipoAWS/ALARM. Si desea actualizar los modelos CUSTOM compuestos, utilice UpdateAssetModelCompositeModelo en su lugar. Para obtener más información, consulte Actualización de modelos compuestos personalizados (componentes).

Para actualizar un modelo de activos o un modelo de componentes (AWS CLI)

  1. Ejecute el siguiente comando para recuperar la definición del modelo existente. Sustituya asset-model-id por el ID o el ID externo del modelo de activos o del modelo de componentes que desee actualizar.

    aws iotsitewise describe-asset-model --asset-model-id asset-model-id

    La operación devuelve una respuesta que contiene los detalles del modelo. La respuesta tiene la siguiente estructura.

    {
  "assetModelId": "String",
  "assetModelArn": "String",
  "assetModelName": "String",
  "assetModelDescription": "String",
  "assetModelProperties": Array of AssetModelProperty,
  "assetModelHierarchies": Array of AssetModelHierarchyDefinition,
  "assetModelCompositeModels": Array of AssetModelCompositeModel,
  "assetModelCompositeModelSummaries": Array of AssetModelCompositeModelSummary,
  "assetModelCreationDate": "String",
  "assetModelLastUpdateDate": "String",
  "assetModelStatus": {
    "state": "String",
    "error": {
      "code": "String",
      "message": "String"
    },
  "assetModelType": "String"
  }
}

    Para obtener más información, consulte la operación del DescribeAssetmodelo.

  2. Cree un archivo llamado update-asset-model.json y copie la respuesta del comando anterior en el archivo.

  3. Elimine los siguientes pares de clave-valor del objeto JSON en update-asset-model.json:

    • assetModelId

    • assetModelArn

    • assetModelCompositeModelSummaries

    • assetModelCreationDate

    • assetModelLastUpdateDate

    • assetModelStatus

    • assetModelType

    La operación del UpdateAssetmodelo espera una carga útil con la siguiente estructura:

    {
  "assetModelName": "String",
  "assetModelDescription": "String",
  "assetModelProperties": Array of AssetModelProperty,
  "assetModelHierarchies": Array of AssetModelHierarchyDefinition,
  "assetModelCompositeModels": Array of AssetModelCompositeModel
}

  4. En update-asset-model.json, realice una de las siguientes acciones:

    • Cambie el nombre del modelo de activos (assetModelName).

    • Cambie, agregue o elimine la descripción del modelo de activos (assetModelDescription).

    • Cambie, agregue o elimine cualquiera de las propiedades del modelo de activos (assetModelProperties). No puede cambiar dataType de las propiedades existentes ni window de las métricas existentes. Para obtener más información, consulte Definición de las propiedades de datos.

    • Cambie, agregue o elimine cualquiera de las jerarquías del modelo de activos (assetModelHierarchies). No puede cambiar childAssetModelId de las jerarquías existentes. Para obtener más información, consulte Definición de jerarquías de modelos de activos.

    • Cambie, añada o elimine cualquiera de los modelos compuestos del modelo de activos del tipo AWS/ALARM (assetModelCompositeModels). Las alarmas monitorean otras propiedades para que pueda identificar cuándo requieren atención los equipos o procesos. Cada definición de alarma es un modelo compuesto que estandariza el conjunto de propiedades que utiliza la alarma. Para obtener más información, consulte Monitoreo de datos con alarmas y Definición de alarmas en los modelos de activos.

  5. Ejecute el siguiente comando para actualizar el modelo de activos con la definición almacenada en update-asset-model.json. Sustituya asset-model-id por el ID del modelo de activos:

    aws iotsitewise update-asset-model \
  --asset-model-id asset-model-id \
  --cli-input-json file://model-payload.json