AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateAssetProperty operation. Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoTSiteWise.AmazonIoTSiteWiseRequest
      Amazon.IoTSiteWise.Model.UpdateAssetPropertyRequest

Namespace: Amazon.IoTSiteWise.Model
Assembly: AWSSDK.IoTSiteWise.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateAssetPropertyRequest : AmazonIoTSiteWiseRequest
         IAmazonWebServiceRequest

The UpdateAssetPropertyRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AssetId System.String

Gets and sets the property AssetId.

The ID of the asset to be updated. 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.

Public Property ClientToken System.String

Gets and sets the property ClientToken.

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Public Property PropertyAlias System.String

Gets and sets the property PropertyAlias.

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

If you omit this parameter, the alias is removed from the property.

Public Property PropertyId System.String

Gets and sets the property PropertyId.

The ID of the asset property to be updated. 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.

Public Property PropertyNotificationState Amazon.IoTSiteWise.PropertyNotificationState

Gets and sets the property PropertyNotificationState.

The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

If you omit this parameter, the notification state is set to DISABLED.

Public Property PropertyUnit System.String

Gets and sets the property PropertyUnit.

The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5