Class: Aws::IoTSiteWise::Types::ListAssetsRequest

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

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. 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) 


6484
6485
6486
6487
6488
6489
6490
6491
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6484

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

#filter ⇒ String

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

Returns:

  • (String) 


6484
6485
6486
6487
6488
6489
6490
6491
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6484

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

#max_results ⇒ Integer

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

Default: 50

Returns:

  • (Integer) 


6484
6485
6486
6487
6488
6489
6490
6491
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6484

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

#next_token ⇒ String

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

Returns:

  • (String) 


6484
6485
6486
6487
6488
6489
6490
6491
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 6484

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