{ "opencollection": "1.0.0", "info": { "name": "AWS IoT SiteWise Access Policies Assets API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Assets", "type": "folder" }, "items": [ { "info": { "name": "Amazon IoT SiteWise Associate Assets", "type": "http" }, "http": { "method": "POST", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId/associate", "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": "assetId", "value": "", "type": "path", "description": "The ID of the parent asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide." }, { "info": { "name": "Amazon IoT SiteWise List Assets", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/assets", "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": "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.

Default: 50

" }, { "name": "assetModelId", "value": "", "type": "query", "description": "The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter." }, { "name": "filter", "value": "", "type": "query", "description": "

The filter for the requested list of assets. Choose one of the following options:

Default: ALL

" } ] }, "docs": "

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets t" }, { "info": { "name": "Amazon IoT SiteWise Create Asset", "type": "http" }, "http": { "method": "POST", "url": "http://iotsitewise.{region}.amazonaws.com/assets", "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 from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide." }, { "info": { "name": "Amazon IoT SiteWise Describe Asset", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId", "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": "assetId", "value": "", "type": "path", "description": "The ID of the asset." }, { "name": "excludeProperties", "value": "", "type": "query", "description": " Whether or not to exclude asset properties from the response. " } ] }, "docs": "Retrieves information about an asset." }, { "info": { "name": "Amazon IoT SiteWise Update Asset", "type": "http" }, "http": { "method": "PUT", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId", "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": "assetId", "value": "", "type": "path", "description": "The ID of the asset to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide." }, { "info": { "name": "Amazon IoT SiteWise Delete Asset", "type": "http" }, "http": { "method": "DELETE", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId", "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": "assetId", "value": "", "type": "path", "description": "The ID of the asset 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. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

" }, { "info": { "name": "Amazon IoT SiteWise Describe Asset Property", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId/properties/:propertyId", "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": "assetId", "value": "", "type": "path", "description": "The ID of the asset." }, { "name": "propertyId", "value": "", "type": "path", "description": "The ID of the asset property." } ] }, "docs": "

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

" }, { "info": { "name": "Amazon IoT SiteWise Disassociate Assets", "type": "http" }, "http": { "method": "POST", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId/disassociate", "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": "assetId", "value": "", "type": "path", "description": "The ID of the parent asset from which to disassociate the child asset." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model." }, { "info": { "name": "Amazon IoT SiteWise List Asset Properties", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId/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": "assetId", "value": "", "type": "path", "description": "The ID of the asset." }, { "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 properties. You can choose one of the following options:

Default: BASE

" } ] }, "docs": "Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again." }, { "info": { "name": "Amazon IoT SiteWise List Asset Relationships", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId/assetRelationships#traversalType", "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": "assetId", "value": "", "type": "path", "description": "The ID of the asset." }, { "name": "traversalType", "value": "", "type": "query", "description": "

The type of traversal to use to identify asset relationships. Choose the following option:

" }, { "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." } ] }, "docs": "Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root." }, { "info": { "name": "Amazon IoT SiteWise List Associated Assets", "type": "http" }, "http": { "method": "GET", "url": "http://iotsitewise.{region}.amazonaws.com/assets/:assetId/hierarchies", "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": "assetId", "value": "", "type": "path", "description": "The ID of the asset to query." }, { "name": "hierarchyId", "value": "", "type": "query", "description": "

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the IoT SiteWise User Guide.

" }, { "name": "traversalDirection", "value": "", "type": "query", "description": "

The direction to list associated assets. Choose one of the following options:

Default: CHILD

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

Default: 50

" } ] }, "docs": "

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

" } ] } ], "bundled": true }