Class: Aws::IoTSiteWise::Types::ListAssetModelPropertiesRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::ListAssetModelPropertiesRequest

Defined in:

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_model_id ⇒ String

  The ID of the asset model.

• #asset_model_version ⇒ String

  The version alias that specifies the latest or active version of the asset model.

• #filter ⇒ String

  Filters the requested list of asset model properties.

• #max_results ⇒ Integer

  The maximum number of results to return for each paginated request.

• #next_token ⇒ String

  The token to be used for the next set of paginated results.

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.

Returns:

• (String)

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

class ListAssetModelPropertiesRequest < Struct.new(
  :asset_model_id,
  :next_token,
  :max_results,
  :filter,
  :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.

Returns:

• (String)

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

class ListAssetModelPropertiesRequest < Struct.new(
  :asset_model_id,
  :next_token,
  :max_results,
  :filter,
  :asset_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ String

Filters the requested list of asset model properties. You can choose one of the following options:

• ALL – The list includes all asset model properties for a given asset model ID.

• BASE – The list includes only base asset model properties for a given asset model ID.

Default: BASE

Returns:

• (String)

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

class ListAssetModelPropertiesRequest < Struct.new(
  :asset_model_id,
  :next_token,
  :max_results,
  :filter,
  :asset_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

Returns:

• (Integer)

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

class ListAssetModelPropertiesRequest < Struct.new(
  :asset_model_id,
  :next_token,
  :max_results,
  :filter,
  :asset_model_version)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to be used for the next set of paginated results.

Returns:

• (String)

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

class ListAssetModelPropertiesRequest < Struct.new(
  :asset_model_id,
  :next_token,
  :max_results,
  :filter,
  :asset_model_version)
  SENSITIVE = []
  include Aws::Structure
end