AssetSummary
Contains a summary of an asset.
Contents
- arn
-
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$Required: Yes
- assetModelId
-
The ID of the asset model used to create this asset.
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: Yes
- creationDate
-
The date the asset was created, in Unix epoch time.
Type: Timestamp
Required: Yes
- hierarchies
-
A list of asset hierarchies that each contain a
hierarchyId. A hierarchy specifies allowed parent/child asset relationships.Type: Array of AssetHierarchy objects
Required: Yes
- id
-
The ID of the asset, in UUID format.
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: Yes
- lastUpdateDate
-
The date the asset was last updated, in Unix epoch time.
Type: Timestamp
Required: Yes
- name
-
The name of the asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+Required: Yes
- status
-
The current status of the asset.
Type: AssetStatus object
Required: Yes
- description
-
A description for the asset.
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. 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
