You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListAssetsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

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.

Returns:

  • (String) —

    The ID of the asset model by which to filter the list of assets.

#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

Possible values:

  • ALL
  • TOP_LEVEL

Returns:

  • (String) —

    The filter for the requested list of assets.

#max_results ⇒ Integer

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

Default: 50

Returns:

  • (Integer) —

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

#next_token ⇒ String

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

Returns:

  • (String) —

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