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

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

Overview

Contains a summary of an asset model.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}

Returns:

  • (String)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#asset_model_typeString

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)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#creation_dateTime

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

Returns:

  • (Time)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#descriptionString

The asset model description.

Returns:

  • (String)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#external_idString

The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

  • (String)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#idString

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

Returns:

  • (String)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#last_update_dateTime

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

Returns:

  • (Time)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#nameString

The name of the asset model.

Returns:

  • (String)


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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

#statusTypes::AssetModelStatus

The current status of the asset model.



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1009

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