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_arnString

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

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

Returns:

  • (String)


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_composite_model_summariesArray<Types::AssetModelCompositeModelSummary>

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



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_composite_modelsArray<Types::AssetModelCompositeModel>

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



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_creation_dateTime

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

Returns:

  • (Time)


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_descriptionString

The asset model's description.

Returns:

  • (String)


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_external_idString

The external ID of the asset model, if any.

Returns:

  • (String)


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_hierarchiesArray<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:



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_idString

The ID of the asset model, in UUID format.

Returns:

  • (String)


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_last_update_dateTime

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

Returns:

  • (Time)


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_nameString

The name of the asset model.

Returns:

  • (String)


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_propertiesArray<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:



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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

#asset_model_statusTypes::AssetModelStatus

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



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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


4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4094

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