Class: Aws::IoTSiteWise::Types::UpdateAssetPropertyRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::UpdateAssetPropertyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 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.

• #property_unit ⇒ String

  The unit of measure (such as Newtons or RPM) of the asset property.

Instance Attribute Details

#asset_id ⇒ String

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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8642

class UpdateAssetPropertyRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :property_notification_state,
  :client_token,
  :property_unit)
  SENSITIVE = []
  include Aws::Structure
end

#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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8642

class UpdateAssetPropertyRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :property_notification_state,
  :client_token,
  :property_unit)
  SENSITIVE = []
  include Aws::Structure
end

#property_alias ⇒ String

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.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8642

class UpdateAssetPropertyRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :property_notification_state,
  :client_token,
  :property_unit)
  SENSITIVE = []
  include Aws::Structure
end

#property_id ⇒ String

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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8642

class UpdateAssetPropertyRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :property_notification_state,
  :client_token,
  :property_unit)
  SENSITIVE = []
  include Aws::Structure
end

#property_notification_state ⇒ String

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`.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8642

class UpdateAssetPropertyRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :property_notification_state,
  :client_token,
  :property_unit)
  SENSITIVE = []
  include Aws::Structure
end

#property_unit ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8642

class UpdateAssetPropertyRequest < Struct.new(
  :asset_id,
  :property_id,
  :property_alias,
  :property_notification_state,
  :client_token,
  :property_unit)
  SENSITIVE = []
  include Aws::Structure
end