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

CreateAssetModel

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the Amazon IoT SiteWise User Guide.

Request Syntax


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

{
   "assetModelCompositeModels": [ 
      { 
         "description": "string",
         "name": "string",
         "properties": [ 
            { 
               "dataType": "string",
               "dataTypeSpec": "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"
                           }
                        }
                     ],
                     "window": { 
                        "tumbling": { 
                           "interval": "string",
                           "offset": "string"
                        }
                     }
                  },
                  "transform": { 
                     "expression": "string",
                     "processingConfig": { 
                        "computeLocation": "string",
                        "forwardingConfig": { 
                           "state": "string"
                        }
                     },
                     "variables": [ 
                        { 
                           "name": "string",
                           "value": { 
                              "hierarchyId": "string",
                              "propertyId": "string"
                           }
                        }
                     ]
                  }
               },
               "unit": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetModelDescription": "string",
   "assetModelHierarchies": [ 
      { 
         "childAssetModelId": "string",
         "name": "string"
      }
   ],
   "assetModelName": "string",
   "assetModelProperties": [ 
      { 
         "dataType": "string",
         "dataTypeSpec": "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"
                     }
                  }
               ],
               "window": { 
                  "tumbling": { 
                     "interval": "string",
                     "offset": "string"
                  }
               }
            },
            "transform": { 
               "expression": "string",
               "processingConfig": { 
                  "computeLocation": "string",
                  "forwardingConfig": { 
                     "state": "string"
                  }
               },
               "variables": [ 
                  { 
                     "name": "string",
                     "value": { 
                        "hierarchyId": "string",
                        "propertyId": "string"
                     }
                  }
               ]
            }
         },
         "unit": "string"
      }
   ],
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

assetModelCompositeModels

The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.

Type: Array of AssetModelCompositeModelDefinition 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

assetModelHierarchies

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

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

Type: Array of AssetModelHierarchyDefinition objects

Required: No

assetModelName

A unique, friendly 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 property definitions of the asset model. For more information, see Asset properties in the Amazon IoT SiteWise User Guide.

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

Type: Array of AssetModelPropertyDefinition 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

tags

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your Amazon IoT SiteWise resources in the Amazon IoT SiteWise User Guide.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

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

assetModelArn

The ARN of the asset model, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

Type: String

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

Pattern: .*

assetModelId

The ID of the asset model. You can use this ID when you call other Amazon 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}$

assetModelStatus

The status of the asset model, which contains a state (CREATING 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

Amazon 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 Amazon 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 Amazon 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 Amazon IoT SiteWise User Guide.

HTTP Status Code: 429