FilterByAsset - Amazon IoT TwinMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

FilterByAsset

Filter by asset. You can include multiple filters when you export your Amazon IoT SiteWise content. See Export metadata examples in the Amazon IoT SiteWise User Guide.

Contents

assetExternalId

The external-Id property of an asset.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 128.

Pattern: .*[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+.*

Required: No

assetId

Filter by asset Id.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

includeAssetModel

Set to true to include the asset model that the specified asset uses.

Type: Boolean

Required: No

includeOffspring

Set to true to include all associated asset models in the hierarchy of the specified asset model.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: