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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass UpdateAssetPropertyRequest data as a hash:

{
  asset_id: "ID", # required
  property_id: "ID", # required
  property_alias: "PropertyAlias",
  property_notification_state: "ENABLED", # accepts ENABLED, DISABLED
  client_token: "ClientToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idString

The ID of the asset to be updated.

Returns:

  • (String)


4945
4946
4947
4948
4949
4950
4951
4952
4953
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4945

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

#client_tokenString

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)


4945
4946
4947
4948
4949
4950
4951
4952
4953
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4945

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

#property_aliasString

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.

Returns:

  • (String)


4945
4946
4947
4948
4949
4950
4951
4952
4953
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4945

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

#property_idString

The ID of the asset property to be updated.

Returns:

  • (String)


4945
4946
4947
4948
4949
4950
4951
4952
4953
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4945

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

#property_notification_stateString

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.

Returns:

  • (String)


4945
4946
4947
4948
4949
4950
4951
4952
4953
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4945

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