Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AssetModelCompositeModel - AWS IoT SiteWise

AssetModelCompositeModel

Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.

Contents

name

The name of the composite model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

type

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

description

The description of the composite model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

Required: No

externalId

The external ID of the asset model composite model. For more information, see Using external IDs in the AWS IoT SiteWise User Guide.

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

id

The ID of the asset model composite model.

Type: String

Length Constraints: Minimum length of 13. Maximum length of 139.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Required: No

properties

The asset property definitions for this composite model.

Type: Array of AssetModelProperty objects

Required: No

See Also

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

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.