Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.
Request SyntaxGET /asset-models/assetModelId?assetModelVersion=assetModelVersion&excludeProperties=excludeProperties HTTP/1.1
The request uses the following URI parameters.
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the AWS IoT SiteWise User Guide.
Length Constraints: Minimum length of 13. Maximum length of 139.
Pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+
Required: Yes
The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the AWS IoT SiteWise User Guide.
Pattern: ^(LATEST|ACTIVE)$
Whether or not to exclude asset model properties from the response.
The request does not have a request body.
Response SyntaxHTTP/1.1 200
ETag: eTag
Content-type: application/json
{
"assetModelArn": "string",
"assetModelCompositeModels": [
{
"description": "string",
"externalId": "string",
"id": "string",
"name": "string",
"properties": [
{
"dataType": "string",
"dataTypeSpec": "string",
"externalId": "string",
"id": "string",
"name": "string",
"path": [
{
"id": "string",
"name": "string"
}
],
"type": {
"attribute": {
"defaultValue": "string"
},
"measurement": {
"processingConfig": {
"forwardingConfig": {
"state": "string"
}
}
},
"metric": {
"expression": "string",
"processingConfig": {
"computeLocation": "string"
},
"variables": [
{
"name": "string",
"value": {
"hierarchyId": "string",
"propertyId": "string",
"propertyPath": [
{
"id": "string",
"name": "string"
}
]
}
}
],
"window": {
"tumbling": {
"interval": "string",
"offset": "string"
}
}
},
"transform": {
"expression": "string",
"processingConfig": {
"computeLocation": "string",
"forwardingConfig": {
"state": "string"
}
},
"variables": [
{
"name": "string",
"value": {
"hierarchyId": "string",
"propertyId": "string",
"propertyPath": [
{
"id": "string",
"name": "string"
}
]
}
}
]
}
},
"unit": "string"
}
],
"type": "string"
}
],
"assetModelCompositeModelSummaries": [
{
"description": "string",
"externalId": "string",
"id": "string",
"name": "string",
"path": [
{
"id": "string",
"name": "string"
}
],
"type": "string"
}
],
"assetModelCreationDate": number,
"assetModelDescription": "string",
"assetModelExternalId": "string",
"assetModelHierarchies": [
{
"childAssetModelId": "string",
"externalId": "string",
"id": "string",
"name": "string"
}
],
"assetModelId": "string",
"assetModelLastUpdateDate": number,
"assetModelName": "string",
"assetModelProperties": [
{
"dataType": "string",
"dataTypeSpec": "string",
"externalId": "string",
"id": "string",
"name": "string",
"path": [
{
"id": "string",
"name": "string"
}
],
"type": {
"attribute": {
"defaultValue": "string"
},
"measurement": {
"processingConfig": {
"forwardingConfig": {
"state": "string"
}
}
},
"metric": {
"expression": "string",
"processingConfig": {
"computeLocation": "string"
},
"variables": [
{
"name": "string",
"value": {
"hierarchyId": "string",
"propertyId": "string",
"propertyPath": [
{
"id": "string",
"name": "string"
}
]
}
}
],
"window": {
"tumbling": {
"interval": "string",
"offset": "string"
}
}
},
"transform": {
"expression": "string",
"processingConfig": {
"computeLocation": "string",
"forwardingConfig": {
"state": "string"
}
},
"variables": [
{
"name": "string",
"value": {
"hierarchyId": "string",
"propertyId": "string",
"propertyPath": [
{
"id": "string",
"name": "string"
}
]
}
}
]
}
},
"unit": "string"
}
],
"assetModelStatus": {
"error": {
"code": "string",
"details": [
{
"code": "string",
"message": "string"
}
],
"message": "string"
},
"state": "string"
},
"assetModelType": "string",
"assetModelVersion": "string",
"interfaceDetails": [
{
"id": "string"
}
]
}If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
The following data is returned in JSON format by the service.
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: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$
The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
Type: Array of AssetModelCompositeModel objects
The list of the immediate child custom composite model summaries for the asset model.
Type: Array of AssetModelCompositeModelSummary objects
The date the asset model was created, in Unix epoch time.
Type: Timestamp
The asset model's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: [^\u0000-\u001F\u007F]+
The external ID of the asset model, if any.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 128.
Pattern: [a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+
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
The ID of the asset model, in UUID format.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
The date the asset model was last updated, in Unix epoch time.
Type: Timestamp
The name of the asset model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [^\u0000-\u001F\u007F]+
The list of asset properties for the asset model.
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.
Type: Array of AssetModelProperty objects
The current status of the asset model, which contains a state and any error message.
Type: AssetModelStatus object
The type of asset model.
ASSET_MODEL â (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
COMPONENT_MODEL â A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
Type: String
Valid Values: ASSET_MODEL | COMPONENT_MODEL | INTERFACE
The version of the asset model. See Asset model versions in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: ^(0|([1-9]{1}\d*))$
A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.
Type: Array of InterfaceRelationship objects
For information about the errors that are common to all actions, see Common Errors.
AWS IoT SiteWise can't process your request right now. Try again later.
HTTP Status Code: 500
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
The requested resource can't be found.
HTTP Status Code: 404
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4