describeAssetCompositeModel method

Future<DescribeAssetCompositeModelResponse> describeAssetCompositeModel({
  1. required String assetCompositeModelId,
  2. required String assetId,
})

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

May throw InternalFailureException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter assetCompositeModelId : The ID of a composite model on this asset. 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 assetId : The ID of the asset. 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.

Implementation

Future<DescribeAssetCompositeModelResponse> describeAssetCompositeModel({
  required String assetCompositeModelId,
  required String assetId,
}) async {
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/assets/${Uri.encodeComponent(assetId)}/composite-models/${Uri.encodeComponent(assetCompositeModelId)}',
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeAssetCompositeModelResponse.fromJson(response);
}