---
title: "GET /assets"
method: GET
path: "/assets"
---

# GET /assets

`GET /assets`

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

*   List assets based on a specific asset model.
    
*   List top-level assets.
    

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use [ListAssetModels](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

## Query parameters

- `nextToken` string
- `maxResults` integer
- `assetModelId` string
- `filter` 'ALL' | 'TOP_LEVEL'

## Response `200`

Success

- ListAssetsResponse
  - `assetSummaries` AssetSummary[], required — A list that summarizes each asset.
    - `id` string, required — The ID of the asset.
    - `arn` 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>
    - `name` string, required — The name of the asset.
    - `assetModelId` string, required — The ID of the asset model used to create this asset.
    - `creationDate` string, date-time, required — The date the asset was created, in Unix epoch time.
    - `lastUpdateDate` string, date-time, required — The date the asset was last updated, in Unix epoch time.
    - `status` object, required — The current status of the asset.
      - `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.
    - `hierarchies` 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.
    - `description` string — A description for the asset.
  - `nextToken` string — The token for the next set of results, or null if there are no additional results.

## Other responses

- `480` — InvalidRequestException
- `481` — InternalFailureException
- `482` — ResourceNotFoundException
- `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)