Class: Aws::IoTSiteWise::Types::CreateAssetRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::CreateAssetRequest

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 to assign to the asset, if desired.

• #asset_model_id ⇒ String

  The ID of the asset model from which to create the asset.

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

• #tags ⇒ Hash<String,String>

  A list of key-value pairs that contain metadata for the asset.

Instance Attribute Details

#asset_description ⇒ String

A description for the asset.

Returns:

• (String)

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

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

#asset_external_id ⇒ String

An external ID to assign to the asset. 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 2934

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

#asset_id ⇒ String

The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

Returns:

• (String)

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

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

#asset_model_id ⇒ String

The ID of the asset model from which to create the asset. 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 2934

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :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 2934

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :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 2934

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

#tags ⇒ Hash<String,String>

A list of key-value pairs that contain metadata for the asset. For more information, see [Tagging your IoT SiteWise resources] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html

Returns:

• (Hash<String,String>)

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

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