You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoTSiteWise::Types::UpdateAssetPropertyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::UpdateAssetPropertyRequest
- Defined in:
- (unknown)
Overview
When passing UpdateAssetPropertyRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
asset_id: "ID", # required
property_id: "ID", # required
property_alias: "PropertyAlias",
property_notification_state: "ENABLED", # accepts ENABLED, DISABLED
client_token: "ClientToken",
}
Instance Attribute Summary collapse
-
#asset_id ⇒ String
The ID of the asset to be updated.
-
#client_token ⇒ String
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
-
#property_alias ⇒ String
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). -
#property_id ⇒ String
The ID of the asset property to be updated.
-
#property_notification_state ⇒ String
The MQTT notification state (enabled or disabled) for this asset property.
Instance Attribute Details
#asset_id ⇒ String
The ID of the asset to be updated.
#client_token ⇒ String
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.
#property_alias ⇒ String
The property 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 AWS IoT
SiteWise User Guide.
If you omit this parameter, the alias is removed from the property.
#property_id ⇒ String
The ID of the asset property to be updated.
#property_notification_state ⇒ String
The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to DISABLED
.