Class: Aws::IoTSiteWise::Types::DescribeAssetModelRequest

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_id ⇒ String

The ID of the asset model. This can be either the actual ID in UUID format, or else ‘externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

  • (String) 


4117
4118
4119
4120
4121
4122
4123
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4117

class DescribeAssetModelRequest < Struct.new(
  :asset_model_id,
  :exclude_properties,
  :asset_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_version ⇒ String

The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is ‘LATEST`. See [ Asset model versions] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html

Returns:

  • (String) 


4117
4118
4119
4120
4121
4122
4123
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4117

class DescribeAssetModelRequest < Struct.new(
  :asset_model_id,
  :exclude_properties,
  :asset_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_properties ⇒ Boolean

Whether or not to exclude asset model properties from the response.

Returns:

  • (Boolean) 


4117
4118
4119
4120
4121
4122
4123
 
# File 'lib/aws-sdk-iotsitewise/types.rb', line 4117

class DescribeAssetModelRequest < Struct.new(
  :asset_model_id,
  :exclude_properties,
  :asset_model_version)
  SENSITIVE = []
  include Aws::Structure
end