DescribeAssetProperty - AWS IoT SiteWise

DescribeAssetProperty

Retrieves information about an asset property.

Note

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

Request Syntax

GET /assets/assetId/properties/propertyId 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

propertyId

The ID of the asset property.

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 { "assetId": "string", "assetModelId": "string", "assetName": "string", "assetProperty": { "alias": "string", "dataType": "string", "id": "string", "name": "string", "notification": { "state": "string", "topic": "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" } }

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.

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

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

assetName

The name of the asset.

Type: String

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

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

assetProperty

The asset property's definition, alias, and notification state.

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