Builder

class Builder

Properties

Link copied to clipboard

A description for the composite model.

Link copied to clipboard

An external ID to assign to the composite model.

Link copied to clipboard

The ID of the composite model. 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.

Link copied to clipboard

A unique name for the composite model.

Link copied to clipboard

The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

Link copied to clipboard

The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

Link copied to clipboard

The ID of the asset model this composite model is a part of.

Link copied to clipboard

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.

Link copied to clipboard

The ID of a component model which is reused to create this composite model.

Link copied to clipboard

The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

Link copied to clipboard

Accepts ***** to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

Link copied to clipboard

Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.

Link copied to clipboard

The ID of the parent composite model in this asset model relationship.