---
title: "GET /assets/{assetId}"
method: GET
path: "/assets/{assetId}"
---

# GET /assets/{assetId}

`GET /assets/{assetId}`

Retrieves information about an asset.

## Path parameters

- `assetId` string, required

## Query parameters

- `excludeProperties` boolean

## Response `200`

Success

- DescribeAssetResponse
  - `assetId` string, required — The ID of the asset.
  - `assetArn` string, required — <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code> </p>
  - `assetName` string, required — The name of the asset.
  - `assetModelId` string, required — The ID of the asset model that was used to create the asset.
  - `assetProperties` AssetProperty[], required — <p>The list of asset properties for the asset.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetCompositeModels</code> object.</p>
    - `id` string, required — The ID of the asset property.
    - `name` string, required — The name of the property.
    - `alias` string — The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>.
    - `notification` object — The asset property's notification topic and state. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.
      - `topic` string, required — The MQTT topic to which IoT SiteWise publishes property value update notifications.
      - `state` 'ENABLED' | 'DISABLED', required — The current notification state.
    - `dataType` 'STRING' | 'INTEGER' | 'DOUBLE' | 'BOOLEAN' | 'STRUCT', required — The data type of the asset property.
    - `dataTypeSpec` string — The data type of the structure for this property. This parameter exists on properties that have the <code>STRUCT</code> data type.
    - `unit` string — The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property.
  - `assetHierarchies` AssetHierarchy[], required — A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.
    - `id` string — The ID of the hierarchy. This ID is a <code>hierarchyId</code>.
    - `name` string, required — The hierarchy name provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> API operation.
  - `assetCompositeModels` AssetCompositeModel[] — The composite models for the asset.
    - `name` string, required — The name of the composite model.
    - `description` string — The description of the composite model.
    - `type` string, required — The type of the composite model. For alarm composite models, this type is <code>AWS/ALARM</code>.
    - `properties` unknown, required
    - `id` string — The ID of the asset composite model.
  - `assetCreationDate` string, date-time, required — The date the asset was created, in Unix epoch time.
  - `assetLastUpdateDate` string, date-time, required — The date the asset was last updated, in Unix epoch time.
  - `assetStatus` object, required — The current status of the asset, which contains a state and any error message.
    - `state` 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' | 'FAILED', required — The current status of the asset.
    - `error` object — Contains associated error information, if any.
      - `code` 'VALIDATION_ERROR' | 'INTERNAL_FAILURE', required — The error code.
      - `message` string, required — The error message.
      - `details` DetailedError[] — A list of detailed errors.
        - `code` 'INCOMPATIBLE_COMPUTE_LOCATION' | 'INCOMPATIBLE_FORWARDING_CONFIGURATION', required — The error code.
        - `message` string, required — The error message.
  - `assetDescription` string — A description for the asset.

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceNotFoundException
- `482` — InternalFailureException
- `483` — ThrottlingException

---

[API](https://skmtc.net/aws/apis/iotsitewise.md) · [All operations](https://skmtc.net/aws/apis/iotsitewise/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotsitewise/versions/d13e5d3e0a6f/schema)