AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListAssets operation. Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoTSiteWise.AmazonIoTSiteWiseRequest
      Amazon.IoTSiteWise.Model.ListAssetsRequest

Namespace: Amazon.IoTSiteWise.Model
Assembly: AWSSDK.IoTSiteWise.dll
Version: 3.x.y.z

Syntax

C# 
public class ListAssetsRequest : AmazonIoTSiteWiseRequest
         IAmazonWebServiceRequest

The ListAssetsRequest type exposes the following members

Constructors

NameDescription
Public Method ListAssetsRequest()

Properties

NameTypeDescription
Public Property AssetModelId System.String

Gets and sets the property AssetModelId.

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.

Public Property Filter Amazon.IoTSiteWise.ListAssetsFilter

Gets and sets the property Filter.

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

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

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

Default: 50

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5