AssetHierarchy
Describes an asset hierarchy that contains a hierarchy's name and ID.
Contents
- name
-
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+Required: Yes
- externalId
-
The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. 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 hierarchy. This ID is a
hierarchyId.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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
