AssetModelSummary - Amazon IoT SiteWise
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).

AssetModelSummary

Contains a summary of an asset model.

Contents

arn

The ARN of the asset model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

Type: String

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

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Required: Yes

creationDate

The date the asset model was created, in Unix epoch time.

Type: Timestamp

Required: Yes

description

The asset model description.

Type: String

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

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

Required: Yes

id

The ID of the asset model (used with Amazon IoT SiteWise API operations).

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 model was last updated, in Unix epoch time.

Type: Timestamp

Required: Yes

name

The name of the asset model.

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 model.

Type: AssetModelStatus object

Required: Yes

assetModelType

The type of asset model.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Type: String

Valid Values: ASSET_MODEL | COMPONENT_MODEL

Required: No

externalId

The external ID of the asset model. For more information, see Using external IDs in the Amazon 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 Amazon SDKs, see the following: