v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

Retrieves information about an asset.

get/assets/{assetId}

Path parameters

assetIdstring required

The ID of the asset.

Query parameters

excludePropertiesboolean

Whether or not to exclude asset properties from the response.

Response

Success

assetIdstring required

The ID of the asset.

assetArnstring 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>
assetNamestring required

The name of the asset.

assetModelIdstring required

The ID of the asset model that was used to create the asset.

assetCreationDatestring date-time required

The date the asset was created, in Unix epoch time.

assetLastUpdateDatestring date-time required

The date the asset was last updated, in Unix epoch time.

assetDescriptionstring

A description for the asset.