Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteAssetModelCompositeModel

Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.

Request Syntax


DELETE /asset-models/assetModelId/composite-models/assetModelCompositeModelId?clientToken=clientToken HTTP/1.1
If-Match: ifMatch
If-None-Match: ifNoneMatch
Match-For-Version-Type: matchForVersionType

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

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.

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

Pattern: \S{36,64}

ifMatch

The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete 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 delete 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 delete operation.

Valid Values: LATEST | ACTIVE

Request Body

The request does not have a request body.

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

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

PreconditionFailedException

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

HTTP Status Code: 412

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