Class: Aws::IoTSiteWise::Types::DescribeAssetCompositeModelResponse

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

#action_definitionsArray<Types::ActionDefinition>

The available actions for a composite model on this asset.

Returns:



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_descriptionString

A description for the composite model.

Returns:

  • (String)


3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_external_idString

An external ID to assign to the asset model.

If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

Returns:

  • (String)


3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_idString

The ID of a composite model on this asset.

Returns:

  • (String)


3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_nameString

The unique, friendly name for the composite model.

Returns:

  • (String)


3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_pathArray<Types::AssetCompositeModelPathSegment>

The path to the composite model listing the parent composite models.



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_propertiesArray<Types::AssetProperty>

The property definitions of the composite model that was used to create the asset.

Returns:



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_summariesArray<Types::AssetCompositeModelSummary>

The list of composite model summaries.



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_composite_model_typeString

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

Returns:

  • (String)


3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_idString

The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

Returns:

  • (String)


3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3967

class DescribeAssetCompositeModelResponse < Struct.new(
  :asset_id,
  :asset_composite_model_id,
  :asset_composite_model_external_id,
  :asset_composite_model_path,
  :asset_composite_model_name,
  :asset_composite_model_description,
  :asset_composite_model_type,
  :asset_composite_model_properties,
  :asset_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end