Module Values.CreateAssetModelRequestSource

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide. You can create three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE. 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. INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

Sourcetype nonrec t = {
  1. assetModelName : Name.t;
    (*

    A unique name for the asset model.

    *)
  2. assetModelType : AssetModelType.t option;
    (*

    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.

    *)
  3. assetModelId : ID.t option;
    (*

    The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

    *)
  4. assetModelExternalId : ExternalId.t option;
    (*

    An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

    *)
  5. assetModelDescription : Description.t option;
    (*

    A description for the asset model.

    *)
  6. assetModelProperties : AssetModelPropertyDefinitions.t option;
    (*

    The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

    *)
  7. assetModelHierarchies : AssetModelHierarchyDefinitions.t option;
    (*

    The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

    *)
  8. assetModelCompositeModels : AssetModelCompositeModelDefinitions.t option;
    (*

    The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.

    *)
  9. clientToken : ClientToken.t option;
    (*

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    *)
  10. tags : TagMap.t option;
    (*

    A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

    *)
}
Sourceval context_ : string
Sourceval make : ?assetModelType:??? -> ?assetModelId:??? -> ?assetModelExternalId:??? -> ?assetModelDescription:??? -> ?assetModelProperties:??? -> ?assetModelHierarchies:??? -> ?assetModelCompositeModels:??? -> ?clientToken:??? -> ?tags:??? -> assetModelName:Name.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of ID.t | `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of VariableName.t | `Structure of (string * [> `List of [> `Structure of (string * [> `String of ID.t ]) list ] list | `String of Macro.t ]) list ]) list ] list | `String of DefaultValue.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of Interval.t ]) list ]) list ]) list ]) list ]) list ] list | `String of ID.t | `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of VariableName.t | `Structure of (string * [> `List of [> `Structure of (string * [> `String of ID.t ]) list ] list | `String of Macro.t ]) list ]) list ] list | `String of DefaultValue.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of Interval.t ]) list ]) list ]) list ]) list ]) list ] list | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of Name.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t