AssetCompositeModelSummary
Contains a summary of the composite model for a specific asset.
Contents
- description
-
A description of the composite model that this summary describes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+
Required: Yes
- id
-
The ID of the composite model that this summary describes.
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
- name
-
The name of the composite model that this summary describes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+
Required: Yes
- path
-
The path that includes all the components of the asset model for the asset.
Type: Array of AssetCompositeModelPathSegment objects
Required: Yes
- type
-
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
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+
Required: Yes
-
- externalId
-
An external ID to assign to the asset model.
If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using
UpdateAssetModelCompositeModel
and specifying the derived ID of the model or property from the created model it's a part of.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: