DescribeAssetModelInterfaceRelationship
Retrieves information about an interface relationship between an asset model and an interface asset model.
Request Syntax
GET /asset-models/assetModelId
/interface/interfaceAssetModelId
/asset-model-interface-relationship HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- assetModelId
-
The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
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
- interfaceAssetModelId
-
The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"assetModelId": "string",
"hierarchyMappings": [
{
"assetModelHierarchyId": "string",
"interfaceAssetModelHierarchyId": "string"
}
],
"interfaceAssetModelId": "string",
"propertyMappings": [
{
"assetModelPropertyId": "string",
"interfaceAssetModelPropertyId": "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.
- assetModelId
-
The ID of the asset model.
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}$
- hierarchyMappings
-
A list of hierarchy mappings between the interface asset model and the asset model where the interface is applied.
Type: Array of HierarchyMapping objects
- interfaceAssetModelId
-
The ID of the interface asset model.
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}$
- propertyMappings
-
A list of property mappings between the interface asset model and the asset model where the interface is applied.
Type: Array of PropertyMapping objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
Amazon 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 Amazon 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 Amazon IoT SiteWise User Guide.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: