Class: Aws::IoTSiteWise::Types::DescribeAssetModelCompositeModelResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeAssetModelCompositeModelResponse

Includes:

Structure

Defined in:

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 model.

• #asset_model_composite_model_description ⇒ String

  The description for the composite model.

• #asset_model_composite_model_external_id ⇒ String

  The external ID of a composite model on this asset model.

• #asset_model_composite_model_id ⇒ String

  The ID of a composite model on this asset model.

• #asset_model_composite_model_name ⇒ String

  The unique, friendly name for the composite model.

• #asset_model_composite_model_path ⇒ Array<Types::AssetModelCompositeModelPathSegment>

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

• #asset_model_composite_model_properties ⇒ Array<Types::AssetModelProperty>

  The property definitions of the composite model.

• #asset_model_composite_model_summaries ⇒ Array<Types::AssetModelCompositeModelSummary>

  The list of composite model summaries for the composite model.

• #asset_model_composite_model_type ⇒ String

  The composite model type.

• #asset_model_id ⇒ String

  The ID of the asset model, in UUID format.

• #composition_details ⇒ Types::CompositionDetails

  Metadata for the composition relationship established by using ‘composedAssetModelId` in [ `CreateAssetModelCompositeModel` ][1].

Instance Attribute Details

#action_definitions ⇒ Array<Types::ActionDefinition>

The available actions for a composite model on this asset model.

Returns:

• (Array<Types::ActionDefinition>)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_description ⇒ String

The description for the composite model.

Returns:

• (String)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_external_id ⇒ String

The external ID of a composite model on this asset model.

Returns:

• (String)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_id ⇒ String

The ID of a composite model on this asset model.

Returns:

• (String)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_name ⇒ String

The unique, friendly name for the composite model.

Returns:

• (String)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_path ⇒ Array<Types::AssetModelCompositeModelPathSegment>

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

Returns:

• (Array<Types::AssetModelCompositeModelPathSegment>)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_properties ⇒ Array<Types::AssetModelProperty>

The property definitions of the composite model.

Returns:

• (Array<Types::AssetModelProperty>)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_summaries ⇒ Array<Types::AssetModelCompositeModelSummary>

The list of composite model summaries for the composite model.

Returns:

• (Array<Types::AssetModelCompositeModelSummary>)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_type ⇒ String

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

Returns:

• (String)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_id ⇒ String

The ID of the asset model, in UUID format.

Returns:

• (String)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end

#composition_details ⇒ Types::CompositionDetails

Metadata for the composition relationship established by using ‘composedAssetModelId` in [ `CreateAssetModelCompositeModel` ][1]. For instance, an array detailing the path of the composition relationship for this composite model.

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html

Returns:

• (Types::CompositionDetails)

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

class DescribeAssetModelCompositeModelResponse < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_path,
  :asset_model_composite_model_name,
  :asset_model_composite_model_description,
  :asset_model_composite_model_type,
  :asset_model_composite_model_properties,
  :composition_details,
  :asset_model_composite_model_summaries,
  :action_definitions)
  SENSITIVE = []
  include Aws::Structure
end