UpdateAssetModelCompositeModel - AWS IoT SiteWise

UpdateAssetModelCompositeModel

Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.

Important

If you remove a property from a composite asset model, AWS IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing composite asset model property with a new one with the same name, do the following:

  1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

  2. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and AWS IoT SiteWise will generate a new unique id.

Request Syntax

PUT /asset-models/assetModelId/composite-models/assetModelCompositeModelId HTTP/1.1 Content-type: application/json { "assetModelCompositeModelDescription": "string", "assetModelCompositeModelExternalId": "string", "assetModelCompositeModelName": "string", "assetModelCompositeModelProperties": [ { "dataType": "string", "dataTypeSpec": "string", "externalId": "string", "id": "string", "name": "string", "path": [ { "id": "string", "name": "string" } ], "type": { "attribute": { "defaultValue": "string" }, "measurement": { "processingConfig": { "forwardingConfig": { "state": "string" } } }, "metric": { "expression": "string", "processingConfig": { "computeLocation": "string" }, "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string", "propertyPath": [ { "id": "string", "name": "string" } ] } } ], "window": { "tumbling": { "interval": "string", "offset": "string" } } }, "transform": { "expression": "string", "processingConfig": { "computeLocation": "string", "forwardingConfig": { "state": "string" } }, "variables": [ { "name": "string", "value": { "hierarchyId": "string", "propertyId": "string", "propertyPath": [ { "id": "string", "name": "string" } ] } } ] } }, "unit": "string" } ], "clientToken": "string" }

URI Request Parameters

The request uses the following URI parameters.

assetModelCompositeModelId

The ID of a composite model on this asset model.

Length Constraints: Minimum length of 13. Maximum length of 139.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Required: Yes

assetModelId

The ID of the asset model, in UUID format.

Length Constraints: Minimum length of 13. Maximum length of 139.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

assetModelCompositeModelDescription

A description for the composite model.

Type: String

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

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

Required: No

assetModelCompositeModelExternalId

An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.

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

assetModelCompositeModelName

A unique, friendly name for the composite model.

Type: String

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

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

Required: Yes

assetModelCompositeModelProperties

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

You can specify up to 200 properties per composite model. For more information, see Quotas in the AWS IoT SiteWise User Guide.

Type: Array of AssetModelProperty objects

Required: No

clientToken

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.

Type: String

Length Constraints: Minimum length of 36. Maximum length of 64.

Pattern: \S{36,64}

Required: No

Response Syntax

HTTP/1.1 202 Content-type: application/json { "assetModelCompositeModelPath": [ { "id": "string", "name": "string" } ], "assetModelStatus": { "error": { "code": "string", "details": [ { "code": "string", "message": "string" } ], "message": "string" }, "state": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

assetModelCompositeModelPath

The path to the composite model listing the parent composite models.

Type: Array of AssetModelCompositeModelPathSegment objects

assetModelStatus

Contains current status information for an asset model. For more information, see Asset and model states in the AWS IoT SiteWise User Guide.

Type: AssetModelStatus object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictingOperationException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 409

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

LimitExceededException

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 410

ResourceAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: