Class: Aws::IoTSiteWise::Types::UpdateAssetRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::UpdateAssetRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_description ⇒ String

  A description for the asset.

• #asset_external_id ⇒ String

  An external ID to assign to the asset.

• #asset_id ⇒ String

  The ID of the asset to update.

• #asset_name ⇒ String

  A friendly name for the asset.

• #client_token ⇒ String

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

Instance Attribute Details

#asset_description ⇒ String

A description for the asset.

Returns:

• (String)

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

class UpdateAssetRequest < Struct.new(
  :asset_id,
  :asset_name,
  :client_token,
  :asset_description,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_external_id ⇒ String

An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see [Using external IDs] in the *IoT SiteWise User Guide*.

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

Returns:

• (String)

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

class UpdateAssetRequest < Struct.new(
  :asset_id,
  :asset_name,
  :client_token,
  :asset_description,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_id ⇒ String

The ID of the asset to update. 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 9286

class UpdateAssetRequest < Struct.new(
  :asset_id,
  :asset_name,
  :client_token,
  :asset_description,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_name ⇒ String

A friendly name for the asset.

Returns:

• (String)

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

class UpdateAssetRequest < Struct.new(
  :asset_id,
  :asset_name,
  :client_token,
  :asset_description,
  :asset_external_id)
  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 9286

class UpdateAssetRequest < Struct.new(
  :asset_id,
  :asset_name,
  :client_token,
  :asset_description,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end