Class: Aws::IoTSiteWise::Types::AssetModelSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::AssetModelSummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a summary of an asset model.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The [ARN] of the asset model, which has the following format.

• #asset_model_type ⇒ String

  The type of asset model.

• #creation_date ⇒ Time

  The date the asset model was created, in Unix epoch time.

• #description ⇒ String

  The asset model description.

• #external_id ⇒ String

  The external ID of the asset model.

• #id ⇒ String

  The ID of the asset model (used with IoT SiteWise API operations).

• #last_update_date ⇒ Time

  The date the asset model was last updated, in Unix epoch time.

• #name ⇒ String

  The name of the asset model.

• #status ⇒ Types::AssetModelStatus

  The current status of the asset model.

• #version ⇒ String

  The version number of the asset model.

Instance Attribute Details

#arn ⇒ String

The [ARN] of the asset model, which has the following format.

‘arn:$Partition:iotsitewise:$Region:$Account:asset-model/$AssetModelId`

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_type ⇒ String

The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.

Returns:

• (String)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The date the asset model was created, in Unix epoch time.

Returns:

• (Time)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The asset model description.

Returns:

• (String)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

The external ID of the asset model. 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 1005

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the asset model (used with IoT SiteWise API operations).

Returns:

• (String)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_date ⇒ Time

The date the asset model was last updated, in Unix epoch time.

Returns:

• (Time)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the asset model.

Returns:

• (String)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::AssetModelStatus

The current status of the asset model.

Returns:

• (Types::AssetModelStatus)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version number of the asset model.

Returns:

• (String)

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

class AssetModelSummary < Struct.new(
  :id,
  :external_id,
  :arn,
  :name,
  :asset_model_type,
  :description,
  :creation_date,
  :last_update_date,
  :status,
  :version)
  SENSITIVE = []
  include Aws::Structure
end