Class: Aws::IoTSiteWise::Types::DescribeAssetModelResponse

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_arn ⇒ String

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

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

Returns:

  • (String) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_summaries ⇒ Array<Types::AssetModelCompositeModelSummary>

The list of the immediate child custom composite model summaries for the asset model.

Returns:



5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_models ⇒ Array<Types::AssetModelCompositeModel>

The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

Returns:



5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_creation_date ⇒ Time

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

Returns:

  • (Time) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_description ⇒ String

The asset model's description.

Returns:

  • (String) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_external_id ⇒ String

The external ID of the asset model, if any.

Returns:

  • (String) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_hierarchies ⇒ Array<Types::AssetModelHierarchy>

A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

Returns:



5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_id ⇒ String

The ID of the asset model, in UUID format.

Returns:

  • (String) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_last_update_date ⇒ Time

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

Returns:

  • (Time) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_name ⇒ String

The name of the asset model.

Returns:

  • (String) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_properties ⇒ Array<Types::AssetModelProperty>

The list of asset properties for the asset model.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

Returns:



5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_status ⇒ Types::AssetModelStatus

The current status of the asset model, which contains a state and any error message.

Returns:



5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  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) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_version ⇒ String

The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.

Returns:

  • (String) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#e_tag ⇒ String

The entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

Returns:

  • (String) 


5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end

#interface_details ⇒ Array<Types::InterfaceRelationship>

A list of interface details that describe the interfaces implemented by this asset model, including interface asset model IDs and property mappings.

Returns:



5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 5100

class DescribeAssetModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_arn,
  :asset_model_name,
  :asset_model_type,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :asset_model_composite_model_summaries,
  :asset_model_creation_date,
  :asset_model_last_update_date,
  :asset_model_status,
  :asset_model_version,
  :interface_details,
  :e_tag)
  SENSITIVE = []
  include Aws::Structure
end