Check the status of an asset or component model - Amazon IoT SiteWise
Check the status of an asset model or component model (console)Check the status of an asset model or component model (Amazon CLI)
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Check the status of an asset or component model

You can use the Amazon IoT SiteWise console or API to check the status of an asset model or component model.

Check the status of an asset model or component model (console)

Use the following procedure to check the status of an asset model or component model in the Amazon IoT SiteWise console.

Tip

Asset models and component models are both listed under Models in the navigation pane. The Details panel of the selected asset model or component model indicates which type it is.

To check the status of an asset model or component model (console)

  1. Navigate to the Amazon IoT SiteWise console.

  2. In the navigation pane, choose Models.

  3. Choose the model to check.

  4. Find Status in the Details panel.

    Amazon IoT SiteWise "Asset model" page screenshot with asset model status highlighted.

Check the status of an asset model or component model (Amazon CLI)

You can use the Amazon CLI to check the status of an asset model or component model.

To check the status of an asset model or component model, use the DescribeAssetModel operation with the assetModelId parameter.

Tip

The Amazon CLI defines component models as a type of asset model. Therefore, you use the same DescribeAssetModel operation for both types of model. The assetModelType field in the response indicates whether it's an ASSET_MODEL or a COMPONENT_MODEL.

To check the status of an asset model or component model (Amazon CLI)

  • Run the following command to describe the model. Replace asset-model-id with the ID or the external ID of the asset model or component model. The external ID is a user-defined ID. For more information, see Reference objects with external IDs in the Amazon IoT SiteWise User Guide.

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

    The operation returns a response that contains the model's details. The response contains an assetModelStatus object that has the following structure.

    {
    ...
    "assetModelStatus": {
      "state": "String",
      "error": {
         "code": "String",
         "message": "String"
      }
    }
  }

    The model's state is in assetModelStatus.state in the JSON object.