Class: Aws::IoTSiteWise::Types::ListAssetPropertiesRequest

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

The ID of the asset. 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) 


8019
8020
8021
8022
8023
8024
8025
8026
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 8019

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

#filter ⇒ String

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

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

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

Default: BASE

Returns:

  • (String) 


8019
8020
8021
8022
8023
8024
8025
8026
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 8019

class ListAssetPropertiesRequest < Struct.new(
  :asset_id,
  :next_token,
  :max_results,
  :filter)
  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) 


8019
8020
8021
8022
8023
8024
8025
8026
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 8019

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

#next_token ⇒ String

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

Returns:

  • (String) 


8019
8020
8021
8022
8023
8024
8025
8026
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 8019

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