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