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

CreateAssetModelCompositeModel

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the AWS IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

Request Syntax

POST /asset-models/assetModelId/composite-models HTTP/1.1
Content-type: application/json

{
   "assetModelCompositeModelDescription": "string",
   "assetModelCompositeModelExternalId": "string",
   "assetModelCompositeModelId": "string",
   "assetModelCompositeModelName": "string",
   "assetModelCompositeModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "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"
      }
   ],
   "assetModelCompositeModelType": "string",
   "clientToken": "string",
   "composedAssetModelId": "string",
   "parentAssetModelCompositeModelId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

assetModelId

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

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 composite model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

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

assetModelCompositeModelId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

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 AssetModelPropertyDefinition objects

Required: No

assetModelCompositeModelType

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

Type: String

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

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

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.

Type: String

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

Pattern: \S{36,64}

Required: No

composedAssetModelId

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

Type: String

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: No

parentAssetModelCompositeModelId

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

Type: String

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: No

Response Syntax

HTTP/1.1 202
Content-type: application/json

{
   "assetModelCompositeModelId": "string",
   "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.

assetModelCompositeModelId

The ID of the composed asset model. You can use this ID when you call other AWS IoT SiteWise APIs.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

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: