DescribeAssetModel - AWS IoT SiteWise

DescribeAssetModel

Retrieves information about an asset model.

Request Syntax

GET /asset-models/assetModelId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

assetModelId

The ID of the asset model.

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 { "assetModelArn": "string", "assetModelCreationDate": number, "assetModelDescription": "string", "assetModelHierarchies": [ { "childAssetModelId": "string", "id": "string", "name": "string" } ], "assetModelId": "string", "assetModelLastUpdateDate": number, "assetModelName": "string", "assetModelProperties": [ { "dataType": "string", "id": "string", "name": "string", "type": { "attribute": { "defaultValue": "string" }, "measurement": { }, "metric": { "expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ], "window": { "tumbling": { "interval": "string" } } }, "transform": { "expression": "string", "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string" } } ] } }, "unit": "string" } ], "assetModelStatus": { "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.

assetModelArn

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

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

Type: String

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

Pattern: .*

assetModelCreationDate

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

Type: Timestamp

assetModelDescription

The asset model's description.

Type: String

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

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

assetModelHierarchies

A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

Type: Array of AssetModelHierarchy objects

assetModelId

The ID of the asset model.

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}$

assetModelLastUpdateDate

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

Type: Timestamp

assetModelName

The name of the asset model.

Type: String

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

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

assetModelProperties

The list of asset properties for the asset model.

Type: Array of AssetModelProperty objects

assetModelStatus

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

Type: AssetModelStatus 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: