DescribeAsset - AWS IoT SiteWise

DescribeAsset

Retrieves information about an asset.

Request Syntax

GET /assets/assetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

assetId

The ID of the asset.

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "assetArn": "string", "assetCreationDate": number, "assetHierarchies": [ { "id": "string", "name": "string" } ], "assetId": "string", "assetLastUpdateDate": number, "assetModelId": "string", "assetName": "string", "assetProperties": [ { "alias": "string", "dataType": "string", "id": "string", "name": "string", "notification": { "state": "string", "topic": "string" }, "unit": "string" } ], "assetStatus": { "error": { "code": "string", "message": "string" }, "state": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

assetArn

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: .*

assetCreationDate

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

Type: Timestamp

assetHierarchies

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

Type: Array of AssetHierarchy objects

assetId

The ID of the asset.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

assetLastUpdateDate

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

Type: Timestamp

assetModelId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

assetName

The name of the asset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

assetProperties

The list of asset properties for the asset.

Type: Array of AssetProperty objects

assetStatus

The current status of the asset, which contains a state and any error message.

Type: AssetStatus object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: