Asset and model states - AWS IoT SiteWise

Asset and model states

When you create, update, or delete an asset or an asset model, the changes take time to propagate. AWS IoT SiteWise resolves these operations asynchronously and updates the status of each resource. Each asset and asset model has a status field that contains the state of the resource and any error message, if applicable. The state can be one of the following values:

  • ACTIVE – The asset or asset model is active. This is the only state in which you can query and interact with assets and asset models.

  • CREATING – The asset or asset model is being created.

  • UPDATING – The asset or asset model is being updated.

  • DELETING – The asset or asset model is being deleted.

  • PROPAGATING – (Asset models only) The asset model's changes are propagating to all of its assets.

  • FAILED – The asset or asset model failed to validate during a create or update operation, possibly due to a circular reference in an expression. You can delete assets and asset models that are in the FAILED state.

Some of the create, update, and delete operations in AWS IoT SiteWise place an asset or asset model in a state other than ACTIVE while the operation resolves. If you need to query or interact with an asset or asset model after you perform one of these operations, you must wait until the state changes to ACTIVE. Otherwise, your requests fail.

Checking the status of an asset

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

Checking the status of an asset (console)

Use the following procedure to check the status of an asset in the AWS IoT SiteWise console.

To check the status of an asset (console)

  1. Navigate to the AWS IoT SiteWise console.

  2. In the navigation pane, choose Assets.

  3. Choose the asset to check.

    Tip

    You can choose the arrow icon to expand an asset hierarchy to find your asset.

    
        AWS IoT SiteWise "Assets" page screenshot with an asset hierarchy
          highlighted.
  4. Find Status in the Asset details panel.

    
                AWS IoT SiteWise "Asset" page screenshot with asset status highlighted.

Checking the status of an asset (CLI)

You can use the AWS Command Line Interface (AWS CLI) to check the status of an asset.

To check the status of an asset, use the DescribeAsset operation with the assetId parameter.

To check the status of an asset (CLI)

  • Run the following command to describe the asset. Replace asset-id with the asset's ID.

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

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

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

    The asset's state is in assetStatus.state in the JSON object.

Checking the status of an asset model

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

Checking the status of an asset model (console)

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

To check the status of an asset model (console)

  1. Navigate to the AWS IoT SiteWise console.

  2. In the navigation pane, choose Models.

  3. Choose the asset model to check.

  4. Find Status in the Details panel.

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

Checking the status of an asset model (CLI)

You can use the AWS CLI to check the status of an asset model.

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

To check the status of an asset model (CLI)

  • Run the following command to describe the asset model. Replace asset-model-id with the asset model's ID.

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

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

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

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