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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_descriptionString

A description for the asset.

Returns:

  • (String)


9328
9329
9330
9331
9332
9333
9334
9335
9336
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9328

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

#asset_external_idString

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)


9328
9329
9330
9331
9332
9333
9334
9335
9336
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9328

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

#asset_idString

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)


9328
9329
9330
9331
9332
9333
9334
9335
9336
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9328

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

#asset_nameString

A friendly name for the asset.

Returns:

  • (String)


9328
9329
9330
9331
9332
9333
9334
9335
9336
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9328

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


9328
9329
9330
9331
9332
9333
9334
9335
9336
# File 'lib/aws-sdk-iotsitewise/types.rb', line 9328

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