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

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

Overview

Note:

When making an API call, you may pass ListAssetsRequest data as a hash:

{
  next_token: "NextToken",
  max_results: 1,
  asset_model_id: "ID",
  filter: "ALL", # accepts ALL, TOP_LEVEL
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_idString

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Returns:

  • (String)


3480
3481
3482
3483
3484
3485
3486
3487
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3480

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

#filterString

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)


3480
3481
3482
3483
3484
3485
3486
3487
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3480

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

#max_resultsInteger

The maximum number of results to be returned per paginated request.

Default: 50

Returns:

  • (Integer)


3480
3481
3482
3483
3484
3485
3486
3487
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3480

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

#next_tokenString

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

Returns:

  • (String)


3480
3481
3482
3483
3484
3485
3486
3487
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3480

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