The maximum number of results to return for each paginated request.
Default: 50
" } ] }, "docs": "Retrieves a paginated list of summaries of all asset models." }, { "info": { "name": "Amazon IoT SiteWise Create Asset Model", "type": "http" }, "http": { "method": "POST", "url": "http://iotsitewise.{region}.amazonaws.com/asset-models", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 IoT SiteWise User Guide." }, { "info": { "name": "Amazon IoT SiteWise Describe Asset Model", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/asset-models/:assetModelId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "assetModelId", "value": "", "type": "path", "description": "The ID of the asset model." }, { "name": "excludeProperties", "value": "", "type": "query", "description": " Whether or not to exclude asset model properties from the response. " } ] }, "docs": "Retrieves information about an asset model." }, { "info": { "name": "Amazon IoT SiteWise Update Asset Model", "type": "http" }, "http": { "method": "PUT", "url": "http://iotsitewise.{region}.amazonaws.com/asset-models/:assetModelId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "assetModelId", "value": "", "type": "path", "description": "The ID of the asset model to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset m" }, { "info": { "name": "Amazon IoT SiteWise Delete Asset Model", "type": "http" }, "http": { "method": "DELETE", "url": "http://iotsitewise.{region}.amazonaws.com/asset-models/:assetModelId", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "assetModelId", "value": "", "type": "path", "description": "The ID of the asset model to delete." }, { "name": "clientToken", "value": "", "type": "query", "description": "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." } ] }, "docs": "Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset 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 IoT SiteWise User Guide<" }, { "info": { "name": "Amazon IoT SiteWise List Asset Model Properties", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/asset-models/:assetModelId/properties", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "assetModelId", "value": "", "type": "path", "description": "The ID of the asset model." }, { "name": "nextToken", "value": "", "type": "query", "description": "The token to be used for the next set of paginated results." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of results to return for each paginated request. If not specified, the default value is 50." }, { "name": "filter", "value": "", "type": "query", "description": "
Filters the requested list of asset model properties. You can choose one of the following options:
ALL – The list includes all asset model properties for a given asset model ID.
BASE – The list includes only base asset model properties for a given asset model ID.
Default: BASE