Atualizando um modelo de ativo ou componente (AWS CLI)

Você pode usar o AWS Command Line Interface (AWS CLI) para atualizar um modelo de ativo ou modelo de componente.

Use a UpdateAssetModelAPI para atualizar o nome, a descrição e as propriedades de um modelo de ativo ou modelo de componente. Somente para modelos de ativos, você pode atualizar hierarquias. Especifique os seguintes parâmetros:

• assetModelId – O ID do ativo. Esse é o ID real no formato UUID, ou externalId:myExternalId se ele tiver um. Para obter mais informações, consulte Referenciando objetos com IDs externos no Guia de Usuário AWS IoT SiteWise .

Especifique o modelo atualizado na carga útil. Para saber mais sobre o formato esperado de um modelo de ativo ou modelo de componente, consulteCriar modelos de ativo.

Atenção

A UpdateAssetModelAPI substitui o modelo existente pelo modelo que você fornece na carga. Para evitar a exclusão das propriedades ou hierarquias do seu modelo, você deve incluir suas IDs e definições na carga útil do modelo atualizado. Para saber como consultar a estrutura existente do seu modelo, consulte a DescribeAssetModeloperação.

nota

O procedimento a seguir só pode atualizar modelos compostos do tipoAWS/ALARM. Se você quiser atualizar modelos CUSTOM compostos, use UpdateAssetModelCompositeModelem vez disso. Para ter mais informações, consulte Atualização de modelos compostos personalizados (componentes).

Para atualizar um modelo de ativo ou modelo de componente (AWS CLI)

1. Execute o comando a seguir para recuperar a definição do modelo existente. asset-model-idSubstitua pela ID ou pela ID externa do modelo de ativo ou modelo de componente a ser atualizado.

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

   A operação retorna uma resposta que contém os detalhes do modelo. A resposta tem a seguinte estrutura:

   {
     "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 obter mais informações, consulte a DescribeAssetModeloperação.

2. Crie um arquivo chamado update-asset-model.json e copie a resposta do comando anterior no arquivo.

3. Remova os seguintes pares de chave-valor do objeto JSON em update-asset-model.json:

   • assetModelId

   • assetModelArn

   • assetModelCompositeModelSummaries

   • assetModelCreationDate

   • assetModelLastUpdateDate

   • assetModelStatus

   • assetModelType

   A UpdateAssetModeloperação espera uma carga útil com a seguinte estrutura:

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

4. Em update-asset-model.json proceda de uma das seguintes maneiras:

   • Altere o nome do modelo de ativo (assetModelName).

   • Altere, adicione ou remova a descrição do modelo de ativo (assetModelDescription).

   • Altere, adicione ou remova qualquer uma das propriedades do modelo de ativo (assetModelProperties). Não é possível alterar o dataType de propriedades existentes ou a window das métricas existentes. Para ter mais informações, consulte Definir propriedades de dados.

   • Altere, adicione ou remova qualquer uma das hierarquias de modelos de ativo (assetModelHierarchies). Não é possível alterar o childAssetModelId das hierarquias existentes. Para ter mais informações, consulte Definindo hierarquias de modelos de ativos.

   • Altere, adicione ou remova qualquer um dos modelos compostos do modelo de ativo do tipo AWS/ALARM (assetModelCompositeModels). Os alarmes monitoram outras propriedades para que você possa identificar quando equipamentos ou processos requerem atenção. Cada definição de alarme é um modelo composto que padroniza o conjunto de propriedades que o alarme usa. Para obter mais informações, consulte Monitorar dados com alarmes e Definir alarmes em modelos de ativos.

5. Execute o seguinte comando para atualizar o modelo de ativo com a definição armazenada no update-asset-model.json. asset-model-idSubstitua pelo ID do modelo de ativo:

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