describeAssetProperty method

Future<DescribeAssetPropertyResponse> describeAssetProperty({
  1. required String assetId,
  2. required String propertyId,
})

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

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

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.

Parameter propertyId : The ID of the asset property. 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<DescribeAssetPropertyResponse> describeAssetProperty({
  required String assetId,
  required String propertyId,
}) async {
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/assets/${Uri.encodeComponent(assetId)}/properties/${Uri.encodeComponent(propertyId)}',
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeAssetPropertyResponse.fromJson(response);
}