UpdateAssetModel - AWS IoT SiteWise
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

UpdateAssetModel

Updates an asset 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 an 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 asset model property with a new one with the same name, do the following:

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

  2. Submit a second UpdateAssetModel 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 HTTP/1.1
If-Match: ifMatch
If-None-Match: ifNoneMatch
Match-For-Version-Type: matchForVersionType
Content-type: application/json

{
   "assetModelCompositeModels": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "properties": [ 
            { 
               "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"
            }
         ],
         "type": "string"
      }
   ],
   "assetModelDescription": "string",
   "assetModelExternalId": "string",
   "assetModelHierarchies": [ 
      { 
         "childAssetModelId": "string",
         "externalId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "assetModelName": "string",
   "assetModelProperties": [ 
      { 
         "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.

assetModelId

The ID of the asset model to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the AWS IoT SiteWise User Guide.

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

ifMatch

The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update 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 AWS IoT SiteWise User Guide.

Pattern: ^[\w-]{43}$

ifNoneMatch

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

Pattern: \*

matchForVersionType

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 update operation.

Valid Values: LATEST | ACTIVE

Request Body

The request accepts the following data in JSON format.

assetModelCompositeModels

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.

Note

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the AWS IoT SiteWise User Guide.

Type: Array of AssetModelCompositeModel objects

Required: No

assetModelDescription

A description for the asset model.

Type: String

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

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

Required: No

assetModelExternalId

An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your AWS account. For more information, see Using external IDs in the AWS 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

assetModelHierarchies

The updated 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 AWS IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.

Type: Array of AssetModelHierarchy objects

Required: No

assetModelName

A unique name for the asset model.

Type: String

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

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

Required: Yes

assetModelProperties

The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide.

You can specify up to 200 properties per asset 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

{
   "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.

assetModelStatus

The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.

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

PreconditionFailedException

The precondition in one or more of the request-header fields evaluated to FALSE.

HTTP Status Code: 412

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: