describeAssetModelCompositeModel method
Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.
May throw InternalFailureException.
May throw InvalidRequestException.
May throw ResourceNotFoundException.
May throw ThrottlingException.
Parameter assetModelCompositeModelId :
The ID of a composite model on this 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 IoT SiteWise User Guide.
Parameter 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, if
it has one. For more information, see Referencing
objects with external IDs in the IoT SiteWise User Guide.
Parameter assetModelVersion :
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 IoT SiteWise User Guide.
Implementation
Future<DescribeAssetModelCompositeModelResponse>
describeAssetModelCompositeModel({
required String assetModelCompositeModelId,
required String assetModelId,
String? assetModelVersion,
}) async {
final $query = <String, List<String>>{
if (assetModelVersion != null) 'assetModelVersion': [assetModelVersion],
};
final response = await _protocol.send(
payload: null,
method: 'GET',
requestUri:
'/asset-models/${Uri.encodeComponent(assetModelId)}/composite-models/${Uri.encodeComponent(assetModelCompositeModelId)}',
queryParams: $query,
hostPrefix: 'api.',
exceptionFnMap: _exceptionFns,
);
return DescribeAssetModelCompositeModelResponse.fromJson(response);
}