@aws-sdk/client-iotsitewise 3.312.0 → 3.316.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/IoTSiteWise.js +77 -1022
- package/dist-cjs/protocols/Aws_restJson1.js +980 -2447
- package/dist-es/IoTSiteWise.js +77 -1022
- package/dist-es/protocols/Aws_restJson1.js +865 -2332
- package/dist-types/IoTSiteWise.d.ts +81 -375
- package/dist-types/ts3.4/IoTSiteWise.d.ts +4 -1
- package/package.json +6 -6
|
@@ -73,744 +73,450 @@ import { UpdateGatewayCommandInput, UpdateGatewayCommandOutput } from "./command
|
|
|
73
73
|
import { UpdatePortalCommandInput, UpdatePortalCommandOutput } from "./commands/UpdatePortalCommand";
|
|
74
74
|
import { UpdateProjectCommandInput, UpdateProjectCommandOutput } from "./commands/UpdateProjectCommand";
|
|
75
75
|
import { IoTSiteWiseClient } from "./IoTSiteWiseClient";
|
|
76
|
-
|
|
77
|
-
* @public
|
|
78
|
-
* <p>Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">Industrial Internet of Things (IIoT)</a> devices to the power of the Amazon Web Services Cloud. For more information, see the
|
|
79
|
-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/">IoT SiteWise User Guide</a>. For information about IoT SiteWise quotas, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
80
|
-
*/
|
|
81
|
-
export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
76
|
+
export interface IoTSiteWise {
|
|
82
77
|
/**
|
|
83
|
-
* @
|
|
84
|
-
* <p>Associates a child asset with the given parent asset through a hierarchy defined in the
|
|
85
|
-
* parent asset's model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html">Associating assets</a> in the
|
|
86
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
78
|
+
* @see {@link AssociateAssetsCommand}
|
|
87
79
|
*/
|
|
88
80
|
associateAssets(args: AssociateAssetsCommandInput, options?: __HttpHandlerOptions): Promise<AssociateAssetsCommandOutput>;
|
|
89
81
|
associateAssets(args: AssociateAssetsCommandInput, cb: (err: any, data?: AssociateAssetsCommandOutput) => void): void;
|
|
90
82
|
associateAssets(args: AssociateAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateAssetsCommandOutput) => void): void;
|
|
91
83
|
/**
|
|
92
|
-
* @
|
|
93
|
-
* <p>Associates a time series (data stream) with an asset property.</p>
|
|
84
|
+
* @see {@link AssociateTimeSeriesToAssetPropertyCommand}
|
|
94
85
|
*/
|
|
95
86
|
associateTimeSeriesToAssetProperty(args: AssociateTimeSeriesToAssetPropertyCommandInput, options?: __HttpHandlerOptions): Promise<AssociateTimeSeriesToAssetPropertyCommandOutput>;
|
|
96
87
|
associateTimeSeriesToAssetProperty(args: AssociateTimeSeriesToAssetPropertyCommandInput, cb: (err: any, data?: AssociateTimeSeriesToAssetPropertyCommandOutput) => void): void;
|
|
97
88
|
associateTimeSeriesToAssetProperty(args: AssociateTimeSeriesToAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateTimeSeriesToAssetPropertyCommandOutput) => void): void;
|
|
98
89
|
/**
|
|
99
|
-
* @
|
|
100
|
-
* <p>Associates a group (batch) of assets with an IoT SiteWise Monitor project.</p>
|
|
90
|
+
* @see {@link BatchAssociateProjectAssetsCommand}
|
|
101
91
|
*/
|
|
102
92
|
batchAssociateProjectAssets(args: BatchAssociateProjectAssetsCommandInput, options?: __HttpHandlerOptions): Promise<BatchAssociateProjectAssetsCommandOutput>;
|
|
103
93
|
batchAssociateProjectAssets(args: BatchAssociateProjectAssetsCommandInput, cb: (err: any, data?: BatchAssociateProjectAssetsCommandOutput) => void): void;
|
|
104
94
|
batchAssociateProjectAssets(args: BatchAssociateProjectAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchAssociateProjectAssetsCommandOutput) => void): void;
|
|
105
95
|
/**
|
|
106
|
-
* @
|
|
107
|
-
* <p>Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.</p>
|
|
96
|
+
* @see {@link BatchDisassociateProjectAssetsCommand}
|
|
108
97
|
*/
|
|
109
98
|
batchDisassociateProjectAssets(args: BatchDisassociateProjectAssetsCommandInput, options?: __HttpHandlerOptions): Promise<BatchDisassociateProjectAssetsCommandOutput>;
|
|
110
99
|
batchDisassociateProjectAssets(args: BatchDisassociateProjectAssetsCommandInput, cb: (err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void): void;
|
|
111
100
|
batchDisassociateProjectAssets(args: BatchDisassociateProjectAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void): void;
|
|
112
101
|
/**
|
|
113
|
-
* @
|
|
114
|
-
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
|
|
115
|
-
* properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying aggregates</a> in the
|
|
116
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
102
|
+
* @see {@link BatchGetAssetPropertyAggregatesCommand}
|
|
117
103
|
*/
|
|
118
104
|
batchGetAssetPropertyAggregates(args: BatchGetAssetPropertyAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetAssetPropertyAggregatesCommandOutput>;
|
|
119
105
|
batchGetAssetPropertyAggregates(args: BatchGetAssetPropertyAggregatesCommandInput, cb: (err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void): void;
|
|
120
106
|
batchGetAssetPropertyAggregates(args: BatchGetAssetPropertyAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void): void;
|
|
121
107
|
/**
|
|
122
|
-
* @
|
|
123
|
-
* <p>Gets the current value for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values">Querying
|
|
124
|
-
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
108
|
+
* @see {@link BatchGetAssetPropertyValueCommand}
|
|
125
109
|
*/
|
|
126
110
|
batchGetAssetPropertyValue(args: BatchGetAssetPropertyValueCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetAssetPropertyValueCommandOutput>;
|
|
127
111
|
batchGetAssetPropertyValue(args: BatchGetAssetPropertyValueCommandInput, cb: (err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void): void;
|
|
128
112
|
batchGetAssetPropertyValue(args: BatchGetAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void): void;
|
|
129
113
|
/**
|
|
130
|
-
* @
|
|
131
|
-
* <p>Gets the historical values for one or more asset properties. For more information, see
|
|
132
|
-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying historical values</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
114
|
+
* @see {@link BatchGetAssetPropertyValueHistoryCommand}
|
|
133
115
|
*/
|
|
134
116
|
batchGetAssetPropertyValueHistory(args: BatchGetAssetPropertyValueHistoryCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetAssetPropertyValueHistoryCommandOutput>;
|
|
135
117
|
batchGetAssetPropertyValueHistory(args: BatchGetAssetPropertyValueHistoryCommandInput, cb: (err: any, data?: BatchGetAssetPropertyValueHistoryCommandOutput) => void): void;
|
|
136
118
|
batchGetAssetPropertyValueHistory(args: BatchGetAssetPropertyValueHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyValueHistoryCommandOutput) => void): void;
|
|
137
119
|
/**
|
|
138
|
-
* @
|
|
139
|
-
* <p>Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value
|
|
140
|
-
* (TQV) data point. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html">Ingesting data using the API</a> in the
|
|
141
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
142
|
-
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
143
|
-
* <ul>
|
|
144
|
-
* <li>
|
|
145
|
-
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
146
|
-
* </li>
|
|
147
|
-
* <li>
|
|
148
|
-
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
149
|
-
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
150
|
-
* </li>
|
|
151
|
-
* </ul>
|
|
152
|
-
* <important>
|
|
153
|
-
* <p>With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more
|
|
154
|
-
* than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps
|
|
155
|
-
* outside of the inclusive range of [-7 days, +10 minutes] and returns a
|
|
156
|
-
* <code>TimestampOutOfRangeException</code> error.</p>
|
|
157
|
-
* <p>For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer
|
|
158
|
-
* TQV has a different quality. For example, if you store a TQV <code>\{T1, GOOD, V1\}</code>,
|
|
159
|
-
* then storing <code>\{T1, GOOD, V2\}</code> replaces the existing TQV.</p>
|
|
160
|
-
* </important>
|
|
161
|
-
* <p>IoT SiteWise authorizes access to each <code>BatchPutAssetPropertyValue</code> entry individually.
|
|
162
|
-
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action">BatchPutAssetPropertyValue authorization</a> in the
|
|
163
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
120
|
+
* @see {@link BatchPutAssetPropertyValueCommand}
|
|
164
121
|
*/
|
|
165
122
|
batchPutAssetPropertyValue(args: BatchPutAssetPropertyValueCommandInput, options?: __HttpHandlerOptions): Promise<BatchPutAssetPropertyValueCommandOutput>;
|
|
166
123
|
batchPutAssetPropertyValue(args: BatchPutAssetPropertyValueCommandInput, cb: (err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void): void;
|
|
167
124
|
batchPutAssetPropertyValue(args: BatchPutAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void): void;
|
|
168
125
|
/**
|
|
169
|
-
* @
|
|
170
|
-
* <p>Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or
|
|
171
|
-
* IAM user) access to the specified IoT SiteWise Monitor portal or project resource.</p>
|
|
126
|
+
* @see {@link CreateAccessPolicyCommand}
|
|
172
127
|
*/
|
|
173
128
|
createAccessPolicy(args: CreateAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessPolicyCommandOutput>;
|
|
174
129
|
createAccessPolicy(args: CreateAccessPolicyCommandInput, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void): void;
|
|
175
130
|
createAccessPolicy(args: CreateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessPolicyCommandOutput) => void): void;
|
|
176
131
|
/**
|
|
177
|
-
* @
|
|
178
|
-
* <p>Creates an asset from an existing asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html">Creating assets</a> in the
|
|
179
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
132
|
+
* @see {@link CreateAssetCommand}
|
|
180
133
|
*/
|
|
181
134
|
createAsset(args: CreateAssetCommandInput, options?: __HttpHandlerOptions): Promise<CreateAssetCommandOutput>;
|
|
182
135
|
createAsset(args: CreateAssetCommandInput, cb: (err: any, data?: CreateAssetCommandOutput) => void): void;
|
|
183
136
|
createAsset(args: CreateAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssetCommandOutput) => void): void;
|
|
184
137
|
/**
|
|
185
|
-
* @
|
|
186
|
-
* <p>Creates an asset model from specified property and hierarchy definitions. You create
|
|
187
|
-
* assets from asset models. With asset models, you can easily create assets of the same type
|
|
188
|
-
* that have standardized definitions. Each asset created from a model inherits the asset model's
|
|
189
|
-
* property and hierarchy definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html">Defining asset models</a> in the
|
|
190
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
138
|
+
* @see {@link CreateAssetModelCommand}
|
|
191
139
|
*/
|
|
192
140
|
createAssetModel(args: CreateAssetModelCommandInput, options?: __HttpHandlerOptions): Promise<CreateAssetModelCommandOutput>;
|
|
193
141
|
createAssetModel(args: CreateAssetModelCommandInput, cb: (err: any, data?: CreateAssetModelCommandOutput) => void): void;
|
|
194
142
|
createAssetModel(args: CreateAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssetModelCommandOutput) => void): void;
|
|
195
143
|
/**
|
|
196
|
-
* @
|
|
197
|
-
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a
|
|
198
|
-
* bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
199
|
-
* <important>
|
|
200
|
-
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For
|
|
201
|
-
* more information about how to configure storage settings, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
|
|
202
|
-
* </important>
|
|
144
|
+
* @see {@link CreateBulkImportJobCommand}
|
|
203
145
|
*/
|
|
204
146
|
createBulkImportJob(args: CreateBulkImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBulkImportJobCommandOutput>;
|
|
205
147
|
createBulkImportJob(args: CreateBulkImportJobCommandInput, cb: (err: any, data?: CreateBulkImportJobCommandOutput) => void): void;
|
|
206
148
|
createBulkImportJob(args: CreateBulkImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBulkImportJobCommandOutput) => void): void;
|
|
207
149
|
/**
|
|
208
|
-
* @
|
|
209
|
-
* <p>Creates a dashboard in an IoT SiteWise Monitor project.</p>
|
|
150
|
+
* @see {@link CreateDashboardCommand}
|
|
210
151
|
*/
|
|
211
152
|
createDashboard(args: CreateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<CreateDashboardCommandOutput>;
|
|
212
153
|
createDashboard(args: CreateDashboardCommandInput, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
|
|
213
154
|
createDashboard(args: CreateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDashboardCommandOutput) => void): void;
|
|
214
155
|
/**
|
|
215
|
-
* @
|
|
216
|
-
* <p>Creates a gateway, which is a virtual or edge device that delivers industrial data streams
|
|
217
|
-
* from local servers to IoT SiteWise. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html">Ingesting data using a gateway</a> in the
|
|
218
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
156
|
+
* @see {@link CreateGatewayCommand}
|
|
219
157
|
*/
|
|
220
158
|
createGateway(args: CreateGatewayCommandInput, options?: __HttpHandlerOptions): Promise<CreateGatewayCommandOutput>;
|
|
221
159
|
createGateway(args: CreateGatewayCommandInput, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
|
|
222
160
|
createGateway(args: CreateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
|
|
223
161
|
/**
|
|
224
|
-
* @
|
|
225
|
-
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM
|
|
226
|
-
* to authenticate portal users and manage user permissions.</p>
|
|
227
|
-
* <note>
|
|
228
|
-
* <p>Before you can sign in to a new portal, you must add at least one identity to that
|
|
229
|
-
* portal. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins">Adding or removing portal
|
|
230
|
-
* administrators</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
231
|
-
* </note>
|
|
162
|
+
* @see {@link CreatePortalCommand}
|
|
232
163
|
*/
|
|
233
164
|
createPortal(args: CreatePortalCommandInput, options?: __HttpHandlerOptions): Promise<CreatePortalCommandOutput>;
|
|
234
165
|
createPortal(args: CreatePortalCommandInput, cb: (err: any, data?: CreatePortalCommandOutput) => void): void;
|
|
235
166
|
createPortal(args: CreatePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePortalCommandOutput) => void): void;
|
|
236
167
|
/**
|
|
237
|
-
* @
|
|
238
|
-
* <p>Creates a project in the specified portal.</p>
|
|
239
|
-
* <note>
|
|
240
|
-
* <p>Make sure that the project name and description don't contain confidential
|
|
241
|
-
* information.</p>
|
|
242
|
-
* </note>
|
|
168
|
+
* @see {@link CreateProjectCommand}
|
|
243
169
|
*/
|
|
244
170
|
createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise<CreateProjectCommandOutput>;
|
|
245
171
|
createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
246
172
|
createProject(args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
247
173
|
/**
|
|
248
|
-
* @
|
|
249
|
-
* <p>Deletes an access policy that grants the specified identity access to the specified
|
|
250
|
-
* IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor
|
|
251
|
-
* resource.</p>
|
|
174
|
+
* @see {@link DeleteAccessPolicyCommand}
|
|
252
175
|
*/
|
|
253
176
|
deleteAccessPolicy(args: DeleteAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessPolicyCommandOutput>;
|
|
254
177
|
deleteAccessPolicy(args: DeleteAccessPolicyCommandInput, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void): void;
|
|
255
178
|
deleteAccessPolicy(args: DeleteAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessPolicyCommandOutput) => void): void;
|
|
256
179
|
/**
|
|
257
|
-
* @
|
|
258
|
-
* <p>Deletes an asset. This action can't be undone. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html">Deleting assets and
|
|
259
|
-
* models</a> in the <i>IoT SiteWise User Guide</i>. </p>
|
|
260
|
-
* <note>
|
|
261
|
-
* <p>You can't delete an asset that's associated to another asset. For more information, see
|
|
262
|
-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html">DisassociateAssets</a>.</p>
|
|
263
|
-
* </note>
|
|
180
|
+
* @see {@link DeleteAssetCommand}
|
|
264
181
|
*/
|
|
265
182
|
deleteAsset(args: DeleteAssetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAssetCommandOutput>;
|
|
266
183
|
deleteAsset(args: DeleteAssetCommandInput, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void;
|
|
267
184
|
deleteAsset(args: DeleteAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssetCommandOutput) => void): void;
|
|
268
185
|
/**
|
|
269
|
-
* @
|
|
270
|
-
* <p>Deletes an asset model. This action can't be undone. You must delete all assets created
|
|
271
|
-
* from an asset model before you can delete the model. Also, you can't delete an asset model if
|
|
272
|
-
* a parent asset model exists that contains a property formula expression that depends on the
|
|
273
|
-
* asset model that you want to delete. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html">Deleting assets and models</a> in the
|
|
274
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
186
|
+
* @see {@link DeleteAssetModelCommand}
|
|
275
187
|
*/
|
|
276
188
|
deleteAssetModel(args: DeleteAssetModelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAssetModelCommandOutput>;
|
|
277
189
|
deleteAssetModel(args: DeleteAssetModelCommandInput, cb: (err: any, data?: DeleteAssetModelCommandOutput) => void): void;
|
|
278
190
|
deleteAssetModel(args: DeleteAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssetModelCommandOutput) => void): void;
|
|
279
191
|
/**
|
|
280
|
-
* @
|
|
281
|
-
* <p>Deletes a dashboard from IoT SiteWise Monitor.</p>
|
|
192
|
+
* @see {@link DeleteDashboardCommand}
|
|
282
193
|
*/
|
|
283
194
|
deleteDashboard(args: DeleteDashboardCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDashboardCommandOutput>;
|
|
284
195
|
deleteDashboard(args: DeleteDashboardCommandInput, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void;
|
|
285
196
|
deleteDashboard(args: DeleteDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDashboardCommandOutput) => void): void;
|
|
286
197
|
/**
|
|
287
|
-
* @
|
|
288
|
-
* <p>Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain
|
|
289
|
-
* in your gateway's file system.</p>
|
|
198
|
+
* @see {@link DeleteGatewayCommand}
|
|
290
199
|
*/
|
|
291
200
|
deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGatewayCommandOutput>;
|
|
292
201
|
deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
|
|
293
202
|
deleteGateway(args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
|
|
294
203
|
/**
|
|
295
|
-
* @
|
|
296
|
-
* <p>Deletes a portal from IoT SiteWise Monitor.</p>
|
|
204
|
+
* @see {@link DeletePortalCommand}
|
|
297
205
|
*/
|
|
298
206
|
deletePortal(args: DeletePortalCommandInput, options?: __HttpHandlerOptions): Promise<DeletePortalCommandOutput>;
|
|
299
207
|
deletePortal(args: DeletePortalCommandInput, cb: (err: any, data?: DeletePortalCommandOutput) => void): void;
|
|
300
208
|
deletePortal(args: DeletePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePortalCommandOutput) => void): void;
|
|
301
209
|
/**
|
|
302
|
-
* @
|
|
303
|
-
* <p>Deletes a project from IoT SiteWise Monitor.</p>
|
|
210
|
+
* @see {@link DeleteProjectCommand}
|
|
304
211
|
*/
|
|
305
212
|
deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProjectCommandOutput>;
|
|
306
213
|
deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
307
214
|
deleteProject(args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
308
215
|
/**
|
|
309
|
-
* @
|
|
310
|
-
* <p>Deletes a time series (data stream). If you delete a time series that's associated with an
|
|
311
|
-
* asset property, the asset property still exists, but the time series will no longer be
|
|
312
|
-
* associated with this asset property.</p>
|
|
313
|
-
* <p>To identify a time series, do one of the following:</p>
|
|
314
|
-
* <ul>
|
|
315
|
-
* <li>
|
|
316
|
-
* <p>If the time series isn't associated with an asset property,
|
|
317
|
-
* specify the <code>alias</code> of the time series.</p>
|
|
318
|
-
* </li>
|
|
319
|
-
* <li>
|
|
320
|
-
* <p>If the time series is associated with an asset property,
|
|
321
|
-
* specify one of the following: </p>
|
|
322
|
-
* <ul>
|
|
323
|
-
* <li>
|
|
324
|
-
* <p>The <code>alias</code> of the time series.</p>
|
|
325
|
-
* </li>
|
|
326
|
-
* <li>
|
|
327
|
-
* <p>The <code>assetId</code> and <code>propertyId</code> that identifies the asset property.</p>
|
|
328
|
-
* </li>
|
|
329
|
-
* </ul>
|
|
330
|
-
* </li>
|
|
331
|
-
* </ul>
|
|
216
|
+
* @see {@link DeleteTimeSeriesCommand}
|
|
332
217
|
*/
|
|
333
218
|
deleteTimeSeries(args: DeleteTimeSeriesCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTimeSeriesCommandOutput>;
|
|
334
219
|
deleteTimeSeries(args: DeleteTimeSeriesCommandInput, cb: (err: any, data?: DeleteTimeSeriesCommandOutput) => void): void;
|
|
335
220
|
deleteTimeSeries(args: DeleteTimeSeriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTimeSeriesCommandOutput) => void): void;
|
|
336
221
|
/**
|
|
337
|
-
* @
|
|
338
|
-
* <p>Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or
|
|
339
|
-
* project.</p>
|
|
222
|
+
* @see {@link DescribeAccessPolicyCommand}
|
|
340
223
|
*/
|
|
341
224
|
describeAccessPolicy(args: DescribeAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccessPolicyCommandOutput>;
|
|
342
225
|
describeAccessPolicy(args: DescribeAccessPolicyCommandInput, cb: (err: any, data?: DescribeAccessPolicyCommandOutput) => void): void;
|
|
343
226
|
describeAccessPolicy(args: DescribeAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessPolicyCommandOutput) => void): void;
|
|
344
227
|
/**
|
|
345
|
-
* @
|
|
346
|
-
* <p>Retrieves information about an asset.</p>
|
|
228
|
+
* @see {@link DescribeAssetCommand}
|
|
347
229
|
*/
|
|
348
230
|
describeAsset(args: DescribeAssetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAssetCommandOutput>;
|
|
349
231
|
describeAsset(args: DescribeAssetCommandInput, cb: (err: any, data?: DescribeAssetCommandOutput) => void): void;
|
|
350
232
|
describeAsset(args: DescribeAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetCommandOutput) => void): void;
|
|
351
233
|
/**
|
|
352
|
-
* @
|
|
353
|
-
* <p>Retrieves information about an asset model.</p>
|
|
234
|
+
* @see {@link DescribeAssetModelCommand}
|
|
354
235
|
*/
|
|
355
236
|
describeAssetModel(args: DescribeAssetModelCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAssetModelCommandOutput>;
|
|
356
237
|
describeAssetModel(args: DescribeAssetModelCommandInput, cb: (err: any, data?: DescribeAssetModelCommandOutput) => void): void;
|
|
357
238
|
describeAssetModel(args: DescribeAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetModelCommandOutput) => void): void;
|
|
358
239
|
/**
|
|
359
|
-
* @
|
|
360
|
-
* <p>Retrieves information about an asset property.</p>
|
|
361
|
-
* <note>
|
|
362
|
-
* <p>When you call this operation for an attribute property, this response includes the
|
|
363
|
-
* default attribute value that you define in the asset model. If you update the default value
|
|
364
|
-
* in the model, this operation's response includes the new default value.</p>
|
|
365
|
-
* </note>
|
|
366
|
-
* <p>This operation doesn't return the value of the asset property. To get the value of an
|
|
367
|
-
* asset property, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html">GetAssetPropertyValue</a>.</p>
|
|
240
|
+
* @see {@link DescribeAssetPropertyCommand}
|
|
368
241
|
*/
|
|
369
242
|
describeAssetProperty(args: DescribeAssetPropertyCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAssetPropertyCommandOutput>;
|
|
370
243
|
describeAssetProperty(args: DescribeAssetPropertyCommandInput, cb: (err: any, data?: DescribeAssetPropertyCommandOutput) => void): void;
|
|
371
244
|
describeAssetProperty(args: DescribeAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetPropertyCommandOutput) => void): void;
|
|
372
245
|
/**
|
|
373
|
-
* @
|
|
374
|
-
* <p>Retrieves information about a bulk import job request. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html">Describe
|
|
375
|
-
* a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
246
|
+
* @see {@link DescribeBulkImportJobCommand}
|
|
376
247
|
*/
|
|
377
248
|
describeBulkImportJob(args: DescribeBulkImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBulkImportJobCommandOutput>;
|
|
378
249
|
describeBulkImportJob(args: DescribeBulkImportJobCommandInput, cb: (err: any, data?: DescribeBulkImportJobCommandOutput) => void): void;
|
|
379
250
|
describeBulkImportJob(args: DescribeBulkImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBulkImportJobCommandOutput) => void): void;
|
|
380
251
|
/**
|
|
381
|
-
* @
|
|
382
|
-
* <p>Retrieves information about a dashboard.</p>
|
|
252
|
+
* @see {@link DescribeDashboardCommand}
|
|
383
253
|
*/
|
|
384
254
|
describeDashboard(args: DescribeDashboardCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDashboardCommandOutput>;
|
|
385
255
|
describeDashboard(args: DescribeDashboardCommandInput, cb: (err: any, data?: DescribeDashboardCommandOutput) => void): void;
|
|
386
256
|
describeDashboard(args: DescribeDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDashboardCommandOutput) => void): void;
|
|
387
257
|
/**
|
|
388
|
-
* @
|
|
389
|
-
* <p>Retrieves information about the default encryption configuration for the Amazon Web Services account in
|
|
390
|
-
* the default or specified Region. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html">Key management</a> in the
|
|
391
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
258
|
+
* @see {@link DescribeDefaultEncryptionConfigurationCommand}
|
|
392
259
|
*/
|
|
393
260
|
describeDefaultEncryptionConfiguration(args: DescribeDefaultEncryptionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDefaultEncryptionConfigurationCommandOutput>;
|
|
394
261
|
describeDefaultEncryptionConfiguration(args: DescribeDefaultEncryptionConfigurationCommandInput, cb: (err: any, data?: DescribeDefaultEncryptionConfigurationCommandOutput) => void): void;
|
|
395
262
|
describeDefaultEncryptionConfiguration(args: DescribeDefaultEncryptionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDefaultEncryptionConfigurationCommandOutput) => void): void;
|
|
396
263
|
/**
|
|
397
|
-
* @
|
|
398
|
-
* <p>Retrieves information about a gateway.</p>
|
|
264
|
+
* @see {@link DescribeGatewayCommand}
|
|
399
265
|
*/
|
|
400
266
|
describeGateway(args: DescribeGatewayCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGatewayCommandOutput>;
|
|
401
267
|
describeGateway(args: DescribeGatewayCommandInput, cb: (err: any, data?: DescribeGatewayCommandOutput) => void): void;
|
|
402
268
|
describeGateway(args: DescribeGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayCommandOutput) => void): void;
|
|
403
269
|
/**
|
|
404
|
-
* @
|
|
405
|
-
* <p>Retrieves information about a gateway capability configuration.
|
|
406
|
-
* Each gateway capability defines data sources for a gateway. A capability configuration
|
|
407
|
-
* can contain multiple data source configurations. If you define OPC-UA sources for a gateway in
|
|
408
|
-
* the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To
|
|
409
|
-
* list all capability configurations for a gateway, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html">DescribeGateway</a>.</p>
|
|
270
|
+
* @see {@link DescribeGatewayCapabilityConfigurationCommand}
|
|
410
271
|
*/
|
|
411
272
|
describeGatewayCapabilityConfiguration(args: DescribeGatewayCapabilityConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGatewayCapabilityConfigurationCommandOutput>;
|
|
412
273
|
describeGatewayCapabilityConfiguration(args: DescribeGatewayCapabilityConfigurationCommandInput, cb: (err: any, data?: DescribeGatewayCapabilityConfigurationCommandOutput) => void): void;
|
|
413
274
|
describeGatewayCapabilityConfiguration(args: DescribeGatewayCapabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGatewayCapabilityConfigurationCommandOutput) => void): void;
|
|
414
275
|
/**
|
|
415
|
-
* @
|
|
416
|
-
* <p>Retrieves the current IoT SiteWise logging options.</p>
|
|
276
|
+
* @see {@link DescribeLoggingOptionsCommand}
|
|
417
277
|
*/
|
|
418
278
|
describeLoggingOptions(args: DescribeLoggingOptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLoggingOptionsCommandOutput>;
|
|
419
279
|
describeLoggingOptions(args: DescribeLoggingOptionsCommandInput, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void): void;
|
|
420
280
|
describeLoggingOptions(args: DescribeLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLoggingOptionsCommandOutput) => void): void;
|
|
421
281
|
/**
|
|
422
|
-
* @
|
|
423
|
-
* <p>Retrieves information about a portal.</p>
|
|
282
|
+
* @see {@link DescribePortalCommand}
|
|
424
283
|
*/
|
|
425
284
|
describePortal(args: DescribePortalCommandInput, options?: __HttpHandlerOptions): Promise<DescribePortalCommandOutput>;
|
|
426
285
|
describePortal(args: DescribePortalCommandInput, cb: (err: any, data?: DescribePortalCommandOutput) => void): void;
|
|
427
286
|
describePortal(args: DescribePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePortalCommandOutput) => void): void;
|
|
428
287
|
/**
|
|
429
|
-
* @
|
|
430
|
-
* <p>Retrieves information about a project.</p>
|
|
288
|
+
* @see {@link DescribeProjectCommand}
|
|
431
289
|
*/
|
|
432
290
|
describeProject(args: DescribeProjectCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProjectCommandOutput>;
|
|
433
291
|
describeProject(args: DescribeProjectCommandInput, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void;
|
|
434
292
|
describeProject(args: DescribeProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectCommandOutput) => void): void;
|
|
435
293
|
/**
|
|
436
|
-
* @
|
|
437
|
-
* <p>Retrieves information about the storage configuration for IoT SiteWise.</p>
|
|
294
|
+
* @see {@link DescribeStorageConfigurationCommand}
|
|
438
295
|
*/
|
|
439
296
|
describeStorageConfiguration(args: DescribeStorageConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStorageConfigurationCommandOutput>;
|
|
440
297
|
describeStorageConfiguration(args: DescribeStorageConfigurationCommandInput, cb: (err: any, data?: DescribeStorageConfigurationCommandOutput) => void): void;
|
|
441
298
|
describeStorageConfiguration(args: DescribeStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStorageConfigurationCommandOutput) => void): void;
|
|
442
299
|
/**
|
|
443
|
-
* @
|
|
444
|
-
* <p>Retrieves information about a time series (data stream).</p>
|
|
445
|
-
* <p>To identify a time series, do one of the following:</p>
|
|
446
|
-
* <ul>
|
|
447
|
-
* <li>
|
|
448
|
-
* <p>If the time series isn't associated with an asset property,
|
|
449
|
-
* specify the <code>alias</code> of the time series.</p>
|
|
450
|
-
* </li>
|
|
451
|
-
* <li>
|
|
452
|
-
* <p>If the time series is associated with an asset property,
|
|
453
|
-
* specify one of the following: </p>
|
|
454
|
-
* <ul>
|
|
455
|
-
* <li>
|
|
456
|
-
* <p>The <code>alias</code> of the time series.</p>
|
|
457
|
-
* </li>
|
|
458
|
-
* <li>
|
|
459
|
-
* <p>The <code>assetId</code> and <code>propertyId</code> that identifies the asset property.</p>
|
|
460
|
-
* </li>
|
|
461
|
-
* </ul>
|
|
462
|
-
* </li>
|
|
463
|
-
* </ul>
|
|
300
|
+
* @see {@link DescribeTimeSeriesCommand}
|
|
464
301
|
*/
|
|
465
302
|
describeTimeSeries(args: DescribeTimeSeriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTimeSeriesCommandOutput>;
|
|
466
303
|
describeTimeSeries(args: DescribeTimeSeriesCommandInput, cb: (err: any, data?: DescribeTimeSeriesCommandOutput) => void): void;
|
|
467
304
|
describeTimeSeries(args: DescribeTimeSeriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTimeSeriesCommandOutput) => void): void;
|
|
468
305
|
/**
|
|
469
|
-
* @
|
|
470
|
-
* <p>Disassociates a child asset from the given parent asset through a hierarchy defined in the
|
|
471
|
-
* parent asset's model.</p>
|
|
306
|
+
* @see {@link DisassociateAssetsCommand}
|
|
472
307
|
*/
|
|
473
308
|
disassociateAssets(args: DisassociateAssetsCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateAssetsCommandOutput>;
|
|
474
309
|
disassociateAssets(args: DisassociateAssetsCommandInput, cb: (err: any, data?: DisassociateAssetsCommandOutput) => void): void;
|
|
475
310
|
disassociateAssets(args: DisassociateAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAssetsCommandOutput) => void): void;
|
|
476
311
|
/**
|
|
477
|
-
* @
|
|
478
|
-
* <p>Disassociates a time series (data stream) from an asset property.</p>
|
|
312
|
+
* @see {@link DisassociateTimeSeriesFromAssetPropertyCommand}
|
|
479
313
|
*/
|
|
480
314
|
disassociateTimeSeriesFromAssetProperty(args: DisassociateTimeSeriesFromAssetPropertyCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateTimeSeriesFromAssetPropertyCommandOutput>;
|
|
481
315
|
disassociateTimeSeriesFromAssetProperty(args: DisassociateTimeSeriesFromAssetPropertyCommandInput, cb: (err: any, data?: DisassociateTimeSeriesFromAssetPropertyCommandOutput) => void): void;
|
|
482
316
|
disassociateTimeSeriesFromAssetProperty(args: DisassociateTimeSeriesFromAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateTimeSeriesFromAssetPropertyCommandOutput) => void): void;
|
|
483
317
|
/**
|
|
484
|
-
* @
|
|
485
|
-
* <p>Gets aggregated values for an asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying
|
|
486
|
-
* aggregates</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
487
|
-
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
488
|
-
* <ul>
|
|
489
|
-
* <li>
|
|
490
|
-
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
491
|
-
* </li>
|
|
492
|
-
* <li>
|
|
493
|
-
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
494
|
-
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
495
|
-
* </li>
|
|
496
|
-
* </ul>
|
|
318
|
+
* @see {@link GetAssetPropertyAggregatesCommand}
|
|
497
319
|
*/
|
|
498
320
|
getAssetPropertyAggregates(args: GetAssetPropertyAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<GetAssetPropertyAggregatesCommandOutput>;
|
|
499
321
|
getAssetPropertyAggregates(args: GetAssetPropertyAggregatesCommandInput, cb: (err: any, data?: GetAssetPropertyAggregatesCommandOutput) => void): void;
|
|
500
322
|
getAssetPropertyAggregates(args: GetAssetPropertyAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssetPropertyAggregatesCommandOutput) => void): void;
|
|
501
323
|
/**
|
|
502
|
-
* @
|
|
503
|
-
* <p>Gets an asset property's current value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values">Querying
|
|
504
|
-
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
505
|
-
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
506
|
-
* <ul>
|
|
507
|
-
* <li>
|
|
508
|
-
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
509
|
-
* </li>
|
|
510
|
-
* <li>
|
|
511
|
-
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
512
|
-
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
513
|
-
* </li>
|
|
514
|
-
* </ul>
|
|
324
|
+
* @see {@link GetAssetPropertyValueCommand}
|
|
515
325
|
*/
|
|
516
326
|
getAssetPropertyValue(args: GetAssetPropertyValueCommandInput, options?: __HttpHandlerOptions): Promise<GetAssetPropertyValueCommandOutput>;
|
|
517
327
|
getAssetPropertyValue(args: GetAssetPropertyValueCommandInput, cb: (err: any, data?: GetAssetPropertyValueCommandOutput) => void): void;
|
|
518
328
|
getAssetPropertyValue(args: GetAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssetPropertyValueCommandOutput) => void): void;
|
|
519
329
|
/**
|
|
520
|
-
* @
|
|
521
|
-
* <p>Gets the history of an asset property's values. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying
|
|
522
|
-
* historical values</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
523
|
-
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
524
|
-
* <ul>
|
|
525
|
-
* <li>
|
|
526
|
-
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
527
|
-
* </li>
|
|
528
|
-
* <li>
|
|
529
|
-
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
530
|
-
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
531
|
-
* </li>
|
|
532
|
-
* </ul>
|
|
330
|
+
* @see {@link GetAssetPropertyValueHistoryCommand}
|
|
533
331
|
*/
|
|
534
332
|
getAssetPropertyValueHistory(args: GetAssetPropertyValueHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetAssetPropertyValueHistoryCommandOutput>;
|
|
535
333
|
getAssetPropertyValueHistory(args: GetAssetPropertyValueHistoryCommandInput, cb: (err: any, data?: GetAssetPropertyValueHistoryCommandOutput) => void): void;
|
|
536
334
|
getAssetPropertyValueHistory(args: GetAssetPropertyValueHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssetPropertyValueHistoryCommandOutput) => void): void;
|
|
537
335
|
/**
|
|
538
|
-
* @
|
|
539
|
-
* <p>Get interpolated values for an asset property for a specified time interval, during a
|
|
540
|
-
* period of time. If your time series is missing data points during the specified time interval,
|
|
541
|
-
* you can use interpolation to estimate the missing data.</p>
|
|
542
|
-
* <p>For example, you can use this operation to return the interpolated temperature values for
|
|
543
|
-
* a wind turbine every 24 hours over a duration of 7 days.</p>
|
|
544
|
-
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
545
|
-
* <ul>
|
|
546
|
-
* <li>
|
|
547
|
-
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
548
|
-
* </li>
|
|
549
|
-
* <li>
|
|
550
|
-
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
551
|
-
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
552
|
-
* </li>
|
|
553
|
-
* </ul>
|
|
336
|
+
* @see {@link GetInterpolatedAssetPropertyValuesCommand}
|
|
554
337
|
*/
|
|
555
338
|
getInterpolatedAssetPropertyValues(args: GetInterpolatedAssetPropertyValuesCommandInput, options?: __HttpHandlerOptions): Promise<GetInterpolatedAssetPropertyValuesCommandOutput>;
|
|
556
339
|
getInterpolatedAssetPropertyValues(args: GetInterpolatedAssetPropertyValuesCommandInput, cb: (err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void): void;
|
|
557
340
|
getInterpolatedAssetPropertyValues(args: GetInterpolatedAssetPropertyValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void): void;
|
|
558
341
|
/**
|
|
559
|
-
* @
|
|
560
|
-
* <p>Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center
|
|
561
|
-
* group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).</p>
|
|
342
|
+
* @see {@link ListAccessPoliciesCommand}
|
|
562
343
|
*/
|
|
563
344
|
listAccessPolicies(args: ListAccessPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessPoliciesCommandOutput>;
|
|
564
345
|
listAccessPolicies(args: ListAccessPoliciesCommandInput, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void): void;
|
|
565
346
|
listAccessPolicies(args: ListAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void): void;
|
|
566
347
|
/**
|
|
567
|
-
* @
|
|
568
|
-
* <p>Retrieves a paginated list of properties associated with an asset model.
|
|
569
|
-
* If you update properties associated with the model before you finish listing all the properties,
|
|
570
|
-
* you need to start all over again.</p>
|
|
348
|
+
* @see {@link ListAssetModelPropertiesCommand}
|
|
571
349
|
*/
|
|
572
350
|
listAssetModelProperties(args: ListAssetModelPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetModelPropertiesCommandOutput>;
|
|
573
351
|
listAssetModelProperties(args: ListAssetModelPropertiesCommandInput, cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void): void;
|
|
574
352
|
listAssetModelProperties(args: ListAssetModelPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void): void;
|
|
575
353
|
/**
|
|
576
|
-
* @
|
|
577
|
-
* <p>Retrieves a paginated list of summaries of all asset models.</p>
|
|
354
|
+
* @see {@link ListAssetModelsCommand}
|
|
578
355
|
*/
|
|
579
356
|
listAssetModels(args: ListAssetModelsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetModelsCommandOutput>;
|
|
580
357
|
listAssetModels(args: ListAssetModelsCommandInput, cb: (err: any, data?: ListAssetModelsCommandOutput) => void): void;
|
|
581
358
|
listAssetModels(args: ListAssetModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetModelsCommandOutput) => void): void;
|
|
582
359
|
/**
|
|
583
|
-
* @
|
|
584
|
-
* <p>Retrieves a paginated list of properties associated with an asset.
|
|
585
|
-
* If you update properties associated with the model before you finish listing all the properties,
|
|
586
|
-
* you need to start all over again.</p>
|
|
360
|
+
* @see {@link ListAssetPropertiesCommand}
|
|
587
361
|
*/
|
|
588
362
|
listAssetProperties(args: ListAssetPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetPropertiesCommandOutput>;
|
|
589
363
|
listAssetProperties(args: ListAssetPropertiesCommandInput, cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void): void;
|
|
590
364
|
listAssetProperties(args: ListAssetPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void): void;
|
|
591
365
|
/**
|
|
592
|
-
* @
|
|
593
|
-
* <p>Retrieves a paginated list of asset relationships for an asset. You can use this operation
|
|
594
|
-
* to identify an asset's root asset and all associated assets between that asset and its
|
|
595
|
-
* root.</p>
|
|
366
|
+
* @see {@link ListAssetRelationshipsCommand}
|
|
596
367
|
*/
|
|
597
368
|
listAssetRelationships(args: ListAssetRelationshipsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetRelationshipsCommandOutput>;
|
|
598
369
|
listAssetRelationships(args: ListAssetRelationshipsCommandInput, cb: (err: any, data?: ListAssetRelationshipsCommandOutput) => void): void;
|
|
599
370
|
listAssetRelationships(args: ListAssetRelationshipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetRelationshipsCommandOutput) => void): void;
|
|
600
371
|
/**
|
|
601
|
-
* @
|
|
602
|
-
* <p>Retrieves a paginated list of asset summaries.</p>
|
|
603
|
-
* <p>You can use this operation to do the following:</p>
|
|
604
|
-
* <ul>
|
|
605
|
-
* <li>
|
|
606
|
-
* <p>List assets based on a specific asset model.</p>
|
|
607
|
-
* </li>
|
|
608
|
-
* <li>
|
|
609
|
-
* <p>List top-level assets.</p>
|
|
610
|
-
* </li>
|
|
611
|
-
* </ul>
|
|
612
|
-
* <p>You can't use this operation to list all assets. To retrieve summaries for all of your
|
|
613
|
-
* assets, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html">ListAssetModels</a> to get all of your asset model IDs. Then, use ListAssets to get all
|
|
614
|
-
* assets for each asset model.</p>
|
|
372
|
+
* @see {@link ListAssetsCommand}
|
|
615
373
|
*/
|
|
616
374
|
listAssets(args: ListAssetsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetsCommandOutput>;
|
|
617
375
|
listAssets(args: ListAssetsCommandInput, cb: (err: any, data?: ListAssetsCommandOutput) => void): void;
|
|
618
376
|
listAssets(args: ListAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetsCommandOutput) => void): void;
|
|
619
377
|
/**
|
|
620
|
-
* @
|
|
621
|
-
* <p>Retrieves a paginated list of associated assets.</p>
|
|
622
|
-
* <p>You can use this operation to do the following:</p>
|
|
623
|
-
* <ul>
|
|
624
|
-
* <li>
|
|
625
|
-
* <p>List child assets associated to a parent asset by a hierarchy that you specify.</p>
|
|
626
|
-
* </li>
|
|
627
|
-
* <li>
|
|
628
|
-
* <p>List an asset's parent asset.</p>
|
|
629
|
-
* </li>
|
|
630
|
-
* </ul>
|
|
378
|
+
* @see {@link ListAssociatedAssetsCommand}
|
|
631
379
|
*/
|
|
632
380
|
listAssociatedAssets(args: ListAssociatedAssetsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssociatedAssetsCommandOutput>;
|
|
633
381
|
listAssociatedAssets(args: ListAssociatedAssetsCommandInput, cb: (err: any, data?: ListAssociatedAssetsCommandOutput) => void): void;
|
|
634
382
|
listAssociatedAssets(args: ListAssociatedAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedAssetsCommandOutput) => void): void;
|
|
635
383
|
/**
|
|
636
|
-
* @
|
|
637
|
-
* <p>Retrieves a paginated list of bulk import job requests. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html">List bulk
|
|
638
|
-
* import jobs (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
384
|
+
* @see {@link ListBulkImportJobsCommand}
|
|
639
385
|
*/
|
|
640
386
|
listBulkImportJobs(args: ListBulkImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBulkImportJobsCommandOutput>;
|
|
641
387
|
listBulkImportJobs(args: ListBulkImportJobsCommandInput, cb: (err: any, data?: ListBulkImportJobsCommandOutput) => void): void;
|
|
642
388
|
listBulkImportJobs(args: ListBulkImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBulkImportJobsCommandOutput) => void): void;
|
|
643
389
|
/**
|
|
644
|
-
* @
|
|
645
|
-
* <p>Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.</p>
|
|
390
|
+
* @see {@link ListDashboardsCommand}
|
|
646
391
|
*/
|
|
647
392
|
listDashboards(args: ListDashboardsCommandInput, options?: __HttpHandlerOptions): Promise<ListDashboardsCommandOutput>;
|
|
648
393
|
listDashboards(args: ListDashboardsCommandInput, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
649
394
|
listDashboards(args: ListDashboardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDashboardsCommandOutput) => void): void;
|
|
650
395
|
/**
|
|
651
|
-
* @
|
|
652
|
-
* <p>Retrieves a paginated list of gateways.</p>
|
|
396
|
+
* @see {@link ListGatewaysCommand}
|
|
653
397
|
*/
|
|
654
398
|
listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise<ListGatewaysCommandOutput>;
|
|
655
399
|
listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
|
|
656
400
|
listGateways(args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
|
|
657
401
|
/**
|
|
658
|
-
* @
|
|
659
|
-
* <p>Retrieves a paginated list of IoT SiteWise Monitor portals.</p>
|
|
402
|
+
* @see {@link ListPortalsCommand}
|
|
660
403
|
*/
|
|
661
404
|
listPortals(args: ListPortalsCommandInput, options?: __HttpHandlerOptions): Promise<ListPortalsCommandOutput>;
|
|
662
405
|
listPortals(args: ListPortalsCommandInput, cb: (err: any, data?: ListPortalsCommandOutput) => void): void;
|
|
663
406
|
listPortals(args: ListPortalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPortalsCommandOutput) => void): void;
|
|
664
407
|
/**
|
|
665
|
-
* @
|
|
666
|
-
* <p>Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.</p>
|
|
408
|
+
* @see {@link ListProjectAssetsCommand}
|
|
667
409
|
*/
|
|
668
410
|
listProjectAssets(args: ListProjectAssetsCommandInput, options?: __HttpHandlerOptions): Promise<ListProjectAssetsCommandOutput>;
|
|
669
411
|
listProjectAssets(args: ListProjectAssetsCommandInput, cb: (err: any, data?: ListProjectAssetsCommandOutput) => void): void;
|
|
670
412
|
listProjectAssets(args: ListProjectAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectAssetsCommandOutput) => void): void;
|
|
671
413
|
/**
|
|
672
|
-
* @
|
|
673
|
-
* <p>Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.</p>
|
|
414
|
+
* @see {@link ListProjectsCommand}
|
|
674
415
|
*/
|
|
675
416
|
listProjects(args: ListProjectsCommandInput, options?: __HttpHandlerOptions): Promise<ListProjectsCommandOutput>;
|
|
676
417
|
listProjects(args: ListProjectsCommandInput, cb: (err: any, data?: ListProjectsCommandOutput) => void): void;
|
|
677
418
|
listProjects(args: ListProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectsCommandOutput) => void): void;
|
|
678
419
|
/**
|
|
679
|
-
* @
|
|
680
|
-
* <p>Retrieves the list of tags for an IoT SiteWise resource.</p>
|
|
420
|
+
* @see {@link ListTagsForResourceCommand}
|
|
681
421
|
*/
|
|
682
422
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
683
423
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
684
424
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
685
425
|
/**
|
|
686
|
-
* @
|
|
687
|
-
* <p>Retrieves a paginated list of time series (data streams).</p>
|
|
426
|
+
* @see {@link ListTimeSeriesCommand}
|
|
688
427
|
*/
|
|
689
428
|
listTimeSeries(args: ListTimeSeriesCommandInput, options?: __HttpHandlerOptions): Promise<ListTimeSeriesCommandOutput>;
|
|
690
429
|
listTimeSeries(args: ListTimeSeriesCommandInput, cb: (err: any, data?: ListTimeSeriesCommandOutput) => void): void;
|
|
691
430
|
listTimeSeries(args: ListTimeSeriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTimeSeriesCommandOutput) => void): void;
|
|
692
431
|
/**
|
|
693
|
-
* @
|
|
694
|
-
* <p>Sets the default encryption configuration for the Amazon Web Services account. For more information, see
|
|
695
|
-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html">Key management</a> in
|
|
696
|
-
* the <i>IoT SiteWise User Guide</i>.</p>
|
|
432
|
+
* @see {@link PutDefaultEncryptionConfigurationCommand}
|
|
697
433
|
*/
|
|
698
434
|
putDefaultEncryptionConfiguration(args: PutDefaultEncryptionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutDefaultEncryptionConfigurationCommandOutput>;
|
|
699
435
|
putDefaultEncryptionConfiguration(args: PutDefaultEncryptionConfigurationCommandInput, cb: (err: any, data?: PutDefaultEncryptionConfigurationCommandOutput) => void): void;
|
|
700
436
|
putDefaultEncryptionConfiguration(args: PutDefaultEncryptionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDefaultEncryptionConfigurationCommandOutput) => void): void;
|
|
701
437
|
/**
|
|
702
|
-
* @
|
|
703
|
-
* <p>Sets logging options for IoT SiteWise.</p>
|
|
438
|
+
* @see {@link PutLoggingOptionsCommand}
|
|
704
439
|
*/
|
|
705
440
|
putLoggingOptions(args: PutLoggingOptionsCommandInput, options?: __HttpHandlerOptions): Promise<PutLoggingOptionsCommandOutput>;
|
|
706
441
|
putLoggingOptions(args: PutLoggingOptionsCommandInput, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void): void;
|
|
707
442
|
putLoggingOptions(args: PutLoggingOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingOptionsCommandOutput) => void): void;
|
|
708
443
|
/**
|
|
709
|
-
* @
|
|
710
|
-
* <p>Configures storage settings for IoT SiteWise.</p>
|
|
444
|
+
* @see {@link PutStorageConfigurationCommand}
|
|
711
445
|
*/
|
|
712
446
|
putStorageConfiguration(args: PutStorageConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutStorageConfigurationCommandOutput>;
|
|
713
447
|
putStorageConfiguration(args: PutStorageConfigurationCommandInput, cb: (err: any, data?: PutStorageConfigurationCommandOutput) => void): void;
|
|
714
448
|
putStorageConfiguration(args: PutStorageConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStorageConfigurationCommandOutput) => void): void;
|
|
715
449
|
/**
|
|
716
|
-
* @
|
|
717
|
-
* <p>Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation
|
|
718
|
-
* updates the tag's value.</p>
|
|
450
|
+
* @see {@link TagResourceCommand}
|
|
719
451
|
*/
|
|
720
452
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
721
453
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
722
454
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
723
455
|
/**
|
|
724
|
-
* @
|
|
725
|
-
* <p>Removes a tag from an IoT SiteWise resource.</p>
|
|
456
|
+
* @see {@link UntagResourceCommand}
|
|
726
457
|
*/
|
|
727
458
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
728
459
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
729
460
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
730
461
|
/**
|
|
731
|
-
* @
|
|
732
|
-
* <p>Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor
|
|
733
|
-
* portal or project resource.</p>
|
|
462
|
+
* @see {@link UpdateAccessPolicyCommand}
|
|
734
463
|
*/
|
|
735
464
|
updateAccessPolicy(args: UpdateAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccessPolicyCommandOutput>;
|
|
736
465
|
updateAccessPolicy(args: UpdateAccessPolicyCommandInput, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void): void;
|
|
737
466
|
updateAccessPolicy(args: UpdateAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessPolicyCommandOutput) => void): void;
|
|
738
467
|
/**
|
|
739
|
-
* @
|
|
740
|
-
* <p>Updates an asset's name. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the
|
|
741
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
468
|
+
* @see {@link UpdateAssetCommand}
|
|
742
469
|
*/
|
|
743
470
|
updateAsset(args: UpdateAssetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAssetCommandOutput>;
|
|
744
471
|
updateAsset(args: UpdateAssetCommandInput, cb: (err: any, data?: UpdateAssetCommandOutput) => void): void;
|
|
745
472
|
updateAsset(args: UpdateAssetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssetCommandOutput) => void): void;
|
|
746
473
|
/**
|
|
747
|
-
* @
|
|
748
|
-
* <p>Updates an asset model and all of the assets that were created from the model. Each asset
|
|
749
|
-
* created from the model inherits the updated asset model's property and hierarchy definitions.
|
|
750
|
-
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the
|
|
751
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
752
|
-
* <important>
|
|
753
|
-
* <p>This operation overwrites the existing model with the provided model. To avoid deleting
|
|
754
|
-
* your asset model's properties or hierarchies, you must include their IDs and definitions in
|
|
755
|
-
* the updated asset model payload. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a>.</p>
|
|
756
|
-
* <p>If you remove a property from an asset model, IoT SiteWise deletes all previous data for that
|
|
757
|
-
* property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every
|
|
758
|
-
* asset associated with that hierarchy. You can't change the type or data type of an existing
|
|
759
|
-
* property.</p>
|
|
760
|
-
* </important>
|
|
474
|
+
* @see {@link UpdateAssetModelCommand}
|
|
761
475
|
*/
|
|
762
476
|
updateAssetModel(args: UpdateAssetModelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAssetModelCommandOutput>;
|
|
763
477
|
updateAssetModel(args: UpdateAssetModelCommandInput, cb: (err: any, data?: UpdateAssetModelCommandOutput) => void): void;
|
|
764
478
|
updateAssetModel(args: UpdateAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssetModelCommandOutput) => void): void;
|
|
765
479
|
/**
|
|
766
|
-
* @
|
|
767
|
-
* <p>Updates an asset property's alias and notification state.</p>
|
|
768
|
-
* <important>
|
|
769
|
-
* <p>This operation overwrites the property's existing alias and notification state. To keep
|
|
770
|
-
* your existing property's alias or notification state, you must include the existing values
|
|
771
|
-
* in the UpdateAssetProperty request. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html">DescribeAssetProperty</a>.</p>
|
|
772
|
-
* </important>
|
|
480
|
+
* @see {@link UpdateAssetPropertyCommand}
|
|
773
481
|
*/
|
|
774
482
|
updateAssetProperty(args: UpdateAssetPropertyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAssetPropertyCommandOutput>;
|
|
775
483
|
updateAssetProperty(args: UpdateAssetPropertyCommandInput, cb: (err: any, data?: UpdateAssetPropertyCommandOutput) => void): void;
|
|
776
484
|
updateAssetProperty(args: UpdateAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssetPropertyCommandOutput) => void): void;
|
|
777
485
|
/**
|
|
778
|
-
* @
|
|
779
|
-
* <p>Updates an IoT SiteWise Monitor dashboard.</p>
|
|
486
|
+
* @see {@link UpdateDashboardCommand}
|
|
780
487
|
*/
|
|
781
488
|
updateDashboard(args: UpdateDashboardCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDashboardCommandOutput>;
|
|
782
489
|
updateDashboard(args: UpdateDashboardCommandInput, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void;
|
|
783
490
|
updateDashboard(args: UpdateDashboardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDashboardCommandOutput) => void): void;
|
|
784
491
|
/**
|
|
785
|
-
* @
|
|
786
|
-
* <p>Updates a gateway's name.</p>
|
|
492
|
+
* @see {@link UpdateGatewayCommand}
|
|
787
493
|
*/
|
|
788
494
|
updateGateway(args: UpdateGatewayCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGatewayCommandOutput>;
|
|
789
495
|
updateGateway(args: UpdateGatewayCommandInput, cb: (err: any, data?: UpdateGatewayCommandOutput) => void): void;
|
|
790
496
|
updateGateway(args: UpdateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayCommandOutput) => void): void;
|
|
791
497
|
/**
|
|
792
|
-
* @
|
|
793
|
-
* <p>Updates a gateway capability configuration or defines a new capability configuration.
|
|
794
|
-
* Each gateway capability defines data sources for a gateway. A capability configuration
|
|
795
|
-
* can contain multiple data source configurations. If you define OPC-UA sources for a gateway in
|
|
796
|
-
* the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To
|
|
797
|
-
* list all capability configurations for a gateway, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html">DescribeGateway</a>.</p>
|
|
498
|
+
* @see {@link UpdateGatewayCapabilityConfigurationCommand}
|
|
798
499
|
*/
|
|
799
500
|
updateGatewayCapabilityConfiguration(args: UpdateGatewayCapabilityConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGatewayCapabilityConfigurationCommandOutput>;
|
|
800
501
|
updateGatewayCapabilityConfiguration(args: UpdateGatewayCapabilityConfigurationCommandInput, cb: (err: any, data?: UpdateGatewayCapabilityConfigurationCommandOutput) => void): void;
|
|
801
502
|
updateGatewayCapabilityConfiguration(args: UpdateGatewayCapabilityConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayCapabilityConfigurationCommandOutput) => void): void;
|
|
802
503
|
/**
|
|
803
|
-
* @
|
|
804
|
-
* <p>Updates an IoT SiteWise Monitor portal.</p>
|
|
504
|
+
* @see {@link UpdatePortalCommand}
|
|
805
505
|
*/
|
|
806
506
|
updatePortal(args: UpdatePortalCommandInput, options?: __HttpHandlerOptions): Promise<UpdatePortalCommandOutput>;
|
|
807
507
|
updatePortal(args: UpdatePortalCommandInput, cb: (err: any, data?: UpdatePortalCommandOutput) => void): void;
|
|
808
508
|
updatePortal(args: UpdatePortalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePortalCommandOutput) => void): void;
|
|
809
509
|
/**
|
|
810
|
-
* @
|
|
811
|
-
* <p>Updates an IoT SiteWise Monitor project.</p>
|
|
510
|
+
* @see {@link UpdateProjectCommand}
|
|
812
511
|
*/
|
|
813
512
|
updateProject(args: UpdateProjectCommandInput, options?: __HttpHandlerOptions): Promise<UpdateProjectCommandOutput>;
|
|
814
513
|
updateProject(args: UpdateProjectCommandInput, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void;
|
|
815
514
|
updateProject(args: UpdateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateProjectCommandOutput) => void): void;
|
|
816
515
|
}
|
|
516
|
+
/**
|
|
517
|
+
* @public
|
|
518
|
+
* <p>Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects <a href="https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications">Industrial Internet of Things (IIoT)</a> devices to the power of the Amazon Web Services Cloud. For more information, see the
|
|
519
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/">IoT SiteWise User Guide</a>. For information about IoT SiteWise quotas, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
520
|
+
*/
|
|
521
|
+
export declare class IoTSiteWise extends IoTSiteWiseClient implements IoTSiteWise {
|
|
522
|
+
}
|