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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeAssetCompositeModelResponse

Defined in:

gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action_definitions ⇒ Array<Types::ActionDefinition>

  The available actions for a composite model on this asset.

• #asset_composite_model_description ⇒ String

  A description for the composite model.

• #asset_composite_model_external_id ⇒ String

  An external ID to assign to the asset model.

• #asset_composite_model_id ⇒ String

  The ID of a composite model on this asset.

• #asset_composite_model_name ⇒ String

  The unique, friendly name for the composite model.

• #asset_composite_model_path ⇒ Array<Types::AssetCompositeModelPathSegment>

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

• #asset_composite_model_properties ⇒ Array<Types::AssetProperty>

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

• #asset_composite_model_summaries ⇒ Array<Types::AssetCompositeModelSummary>

  The list of composite model summaries.

• #asset_composite_model_type ⇒ String

  The composite model type.

• #asset_id ⇒ String

  The ID of the asset, in UUID format.

Instance Attribute Details

#action_definitions ⇒ Array<Types::ActionDefinition>

The available actions for a composite model on this asset.

Returns:

• (Array<Types::ActionDefinition>)

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

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_description ⇒ String

A description for the composite model.

Returns:

• (String)

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

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_id ⇒ String

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)

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

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_id ⇒ String

The ID of a composite model on this asset.

Returns:

• (String)

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

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_name ⇒ String

The unique, friendly name for the composite model.

Returns:

• (String)

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

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_path ⇒ Array<Types::AssetCompositeModelPathSegment>

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

Returns:

• (Array<Types::AssetCompositeModelPathSegment>)

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

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_properties ⇒ Array<Types::AssetProperty>

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

Returns:

• (Array<Types::AssetProperty>)

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

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_summaries ⇒ Array<Types::AssetCompositeModelSummary>

The list of composite model summaries.

Returns:

• (Array<Types::AssetCompositeModelSummary>)

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

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_type ⇒ String

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

Returns:

• (String)

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

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_id ⇒ String

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)

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

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