@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
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
|
|
3
3
|
/**
|
|
4
|
+
* @public
|
|
4
5
|
* <p>Contains information for a group identity in an access policy.</p>
|
|
5
6
|
*/
|
|
6
7
|
export interface GroupIdentity {
|
|
@@ -10,6 +11,7 @@ export interface GroupIdentity {
|
|
|
10
11
|
id: string | undefined;
|
|
11
12
|
}
|
|
12
13
|
/**
|
|
14
|
+
* @public
|
|
13
15
|
* <p>Contains information about an Identity and Access Management role. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
|
|
14
16
|
* <i>IAM User Guide</i>.</p>
|
|
15
17
|
*/
|
|
@@ -21,6 +23,7 @@ export interface IAMRoleIdentity {
|
|
|
21
23
|
arn: string | undefined;
|
|
22
24
|
}
|
|
23
25
|
/**
|
|
26
|
+
* @public
|
|
24
27
|
* <p>Contains information about an Identity and Access Management user.</p>
|
|
25
28
|
*/
|
|
26
29
|
export interface IAMUserIdentity {
|
|
@@ -36,6 +39,7 @@ export interface IAMUserIdentity {
|
|
|
36
39
|
arn: string | undefined;
|
|
37
40
|
}
|
|
38
41
|
/**
|
|
42
|
+
* @public
|
|
39
43
|
* <p>Contains information for a user identity in an access policy.</p>
|
|
40
44
|
*/
|
|
41
45
|
export interface UserIdentity {
|
|
@@ -45,6 +49,7 @@ export interface UserIdentity {
|
|
|
45
49
|
id: string | undefined;
|
|
46
50
|
}
|
|
47
51
|
/**
|
|
52
|
+
* @public
|
|
48
53
|
* <p>Contains an identity that can access an IoT SiteWise Monitor resource.</p>
|
|
49
54
|
* <note>
|
|
50
55
|
* <p>Currently, you can't use Amazon Web Services APIs to retrieve IAM Identity Center identity IDs. You can find the
|
|
@@ -69,11 +74,15 @@ export interface Identity {
|
|
|
69
74
|
*/
|
|
70
75
|
iamRole?: IAMRoleIdentity;
|
|
71
76
|
}
|
|
77
|
+
/**
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
72
80
|
export declare enum Permission {
|
|
73
81
|
ADMINISTRATOR = "ADMINISTRATOR",
|
|
74
82
|
VIEWER = "VIEWER"
|
|
75
83
|
}
|
|
76
84
|
/**
|
|
85
|
+
* @public
|
|
77
86
|
* <p>Identifies an IoT SiteWise Monitor portal.</p>
|
|
78
87
|
*/
|
|
79
88
|
export interface PortalResource {
|
|
@@ -83,6 +92,7 @@ export interface PortalResource {
|
|
|
83
92
|
id: string | undefined;
|
|
84
93
|
}
|
|
85
94
|
/**
|
|
95
|
+
* @public
|
|
86
96
|
* <p>Identifies a specific IoT SiteWise Monitor project.</p>
|
|
87
97
|
*/
|
|
88
98
|
export interface ProjectResource {
|
|
@@ -92,6 +102,7 @@ export interface ProjectResource {
|
|
|
92
102
|
id: string | undefined;
|
|
93
103
|
}
|
|
94
104
|
/**
|
|
105
|
+
* @public
|
|
95
106
|
* <p>Contains an IoT SiteWise Monitor resource ID for a portal or project.</p>
|
|
96
107
|
*/
|
|
97
108
|
export interface Resource {
|
|
@@ -105,6 +116,7 @@ export interface Resource {
|
|
|
105
116
|
project?: ProjectResource;
|
|
106
117
|
}
|
|
107
118
|
/**
|
|
119
|
+
* @public
|
|
108
120
|
* <p>Contains an access policy that defines an identity's access to an IoT SiteWise Monitor
|
|
109
121
|
* resource.</p>
|
|
110
122
|
*/
|
|
@@ -135,12 +147,16 @@ export interface AccessPolicySummary {
|
|
|
135
147
|
*/
|
|
136
148
|
lastUpdateDate?: Date;
|
|
137
149
|
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
138
153
|
export declare enum Quality {
|
|
139
154
|
BAD = "BAD",
|
|
140
155
|
GOOD = "GOOD",
|
|
141
156
|
UNCERTAIN = "UNCERTAIN"
|
|
142
157
|
}
|
|
143
158
|
/**
|
|
159
|
+
* @public
|
|
144
160
|
* <p>Contains the (pre-calculated) aggregate values for an asset property.</p>
|
|
145
161
|
*/
|
|
146
162
|
export interface Aggregates {
|
|
@@ -170,6 +186,7 @@ export interface Aggregates {
|
|
|
170
186
|
standardDeviation?: number;
|
|
171
187
|
}
|
|
172
188
|
/**
|
|
189
|
+
* @public
|
|
173
190
|
* <p>Contains aggregated asset property values (for example, average, minimum, and
|
|
174
191
|
* maximum).</p>
|
|
175
192
|
*/
|
|
@@ -187,6 +204,9 @@ export interface AggregatedValue {
|
|
|
187
204
|
*/
|
|
188
205
|
value: Aggregates | undefined;
|
|
189
206
|
}
|
|
207
|
+
/**
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
190
210
|
export declare enum AggregateType {
|
|
191
211
|
AVERAGE = "AVERAGE",
|
|
192
212
|
COUNT = "COUNT",
|
|
@@ -196,6 +216,7 @@ export declare enum AggregateType {
|
|
|
196
216
|
SUM = "SUM"
|
|
197
217
|
}
|
|
198
218
|
/**
|
|
219
|
+
* @public
|
|
199
220
|
* <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
|
|
200
221
|
* You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
|
|
201
222
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html">Monitoring with alarms</a> in the <i>IoT SiteWise Application Guide</i>.</p>
|
|
@@ -213,6 +234,9 @@ export interface Alarms {
|
|
|
213
234
|
*/
|
|
214
235
|
notificationLambdaArn?: string;
|
|
215
236
|
}
|
|
237
|
+
/**
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
216
240
|
export declare enum PropertyDataType {
|
|
217
241
|
BOOLEAN = "BOOLEAN",
|
|
218
242
|
DOUBLE = "DOUBLE",
|
|
@@ -220,11 +244,15 @@ export declare enum PropertyDataType {
|
|
|
220
244
|
STRING = "STRING",
|
|
221
245
|
STRUCT = "STRUCT"
|
|
222
246
|
}
|
|
247
|
+
/**
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
223
250
|
export declare enum PropertyNotificationState {
|
|
224
251
|
DISABLED = "DISABLED",
|
|
225
252
|
ENABLED = "ENABLED"
|
|
226
253
|
}
|
|
227
254
|
/**
|
|
255
|
+
* @public
|
|
228
256
|
* <p>Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value
|
|
229
257
|
* updates to a unique MQTT topic. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html">Interacting with other services</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
230
258
|
*/
|
|
@@ -239,6 +267,7 @@ export interface PropertyNotification {
|
|
|
239
267
|
state: PropertyNotificationState | string | undefined;
|
|
240
268
|
}
|
|
241
269
|
/**
|
|
270
|
+
* @public
|
|
242
271
|
* <p>Contains asset property information.</p>
|
|
243
272
|
*/
|
|
244
273
|
export interface AssetProperty {
|
|
@@ -276,6 +305,7 @@ export interface AssetProperty {
|
|
|
276
305
|
unit?: string;
|
|
277
306
|
}
|
|
278
307
|
/**
|
|
308
|
+
* @public
|
|
279
309
|
* <p>Contains information about a composite model in an asset. This object contains the asset's
|
|
280
310
|
* properties that you define in the composite model.</p>
|
|
281
311
|
*/
|
|
@@ -304,10 +334,14 @@ export interface AssetCompositeModel {
|
|
|
304
334
|
*/
|
|
305
335
|
id?: string;
|
|
306
336
|
}
|
|
337
|
+
/**
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
307
340
|
export declare enum AssetErrorCode {
|
|
308
341
|
INTERNAL_FAILURE = "INTERNAL_FAILURE"
|
|
309
342
|
}
|
|
310
343
|
/**
|
|
344
|
+
* @public
|
|
311
345
|
* <p>Contains error details for the requested associate project asset action.</p>
|
|
312
346
|
*/
|
|
313
347
|
export interface AssetErrorDetails {
|
|
@@ -325,6 +359,7 @@ export interface AssetErrorDetails {
|
|
|
325
359
|
message: string | undefined;
|
|
326
360
|
}
|
|
327
361
|
/**
|
|
362
|
+
* @public
|
|
328
363
|
* <p>Describes an asset hierarchy that contains a hierarchy's name and ID.</p>
|
|
329
364
|
*/
|
|
330
365
|
export interface AssetHierarchy {
|
|
@@ -339,6 +374,7 @@ export interface AssetHierarchy {
|
|
|
339
374
|
name: string | undefined;
|
|
340
375
|
}
|
|
341
376
|
/**
|
|
377
|
+
* @public
|
|
342
378
|
* <p>Contains information about a parent asset and a child asset that are related through an
|
|
343
379
|
* asset hierarchy.</p>
|
|
344
380
|
*/
|
|
@@ -353,6 +389,7 @@ export interface AssetHierarchyInfo {
|
|
|
353
389
|
childAssetId?: string;
|
|
354
390
|
}
|
|
355
391
|
/**
|
|
392
|
+
* @public
|
|
356
393
|
* <p>Contains an asset attribute property. For more information, see
|
|
357
394
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes">Attributes</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
358
395
|
*/
|
|
@@ -365,11 +402,15 @@ export interface Attribute {
|
|
|
365
402
|
*/
|
|
366
403
|
defaultValue?: string;
|
|
367
404
|
}
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
368
408
|
export declare enum ForwardingConfigState {
|
|
369
409
|
DISABLED = "DISABLED",
|
|
370
410
|
ENABLED = "ENABLED"
|
|
371
411
|
}
|
|
372
412
|
/**
|
|
413
|
+
* @public
|
|
373
414
|
* <p>The forwarding configuration for a given property.</p>
|
|
374
415
|
*/
|
|
375
416
|
export interface ForwardingConfig {
|
|
@@ -379,6 +420,7 @@ export interface ForwardingConfig {
|
|
|
379
420
|
state: ForwardingConfigState | string | undefined;
|
|
380
421
|
}
|
|
381
422
|
/**
|
|
423
|
+
* @public
|
|
382
424
|
* <p>The processing configuration for the given measurement property.
|
|
383
425
|
* You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud.
|
|
384
426
|
* By default, measurements are forwarded to the cloud.</p>
|
|
@@ -390,6 +432,7 @@ export interface MeasurementProcessingConfig {
|
|
|
390
432
|
forwardingConfig: ForwardingConfig | undefined;
|
|
391
433
|
}
|
|
392
434
|
/**
|
|
435
|
+
* @public
|
|
393
436
|
* <p>Contains an asset measurement property. For more information, see
|
|
394
437
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements">Measurements</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
395
438
|
*/
|
|
@@ -401,11 +444,15 @@ export interface Measurement {
|
|
|
401
444
|
*/
|
|
402
445
|
processingConfig?: MeasurementProcessingConfig;
|
|
403
446
|
}
|
|
447
|
+
/**
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
404
450
|
export declare enum ComputeLocation {
|
|
405
451
|
CLOUD = "CLOUD",
|
|
406
452
|
EDGE = "EDGE"
|
|
407
453
|
}
|
|
408
454
|
/**
|
|
455
|
+
* @public
|
|
409
456
|
* <p>The processing configuration for the given metric property.
|
|
410
457
|
* You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud.
|
|
411
458
|
* By default, metrics are forwarded to the cloud.</p>
|
|
@@ -417,6 +464,7 @@ export interface MetricProcessingConfig {
|
|
|
417
464
|
computeLocation: ComputeLocation | string | undefined;
|
|
418
465
|
}
|
|
419
466
|
/**
|
|
467
|
+
* @public
|
|
420
468
|
* <p>Identifies a property value used in an expression.</p>
|
|
421
469
|
*/
|
|
422
470
|
export interface VariableValue {
|
|
@@ -436,6 +484,7 @@ export interface VariableValue {
|
|
|
436
484
|
hierarchyId?: string;
|
|
437
485
|
}
|
|
438
486
|
/**
|
|
487
|
+
* @public
|
|
439
488
|
* <p>Contains expression variable information.</p>
|
|
440
489
|
*/
|
|
441
490
|
export interface ExpressionVariable {
|
|
@@ -449,6 +498,7 @@ export interface ExpressionVariable {
|
|
|
449
498
|
value: VariableValue | undefined;
|
|
450
499
|
}
|
|
451
500
|
/**
|
|
501
|
+
* @public
|
|
452
502
|
* <p>Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and
|
|
453
503
|
* contiguous time window. You can use this window in metrics to aggregate data from properties
|
|
454
504
|
* and other assets.</p>
|
|
@@ -536,6 +586,7 @@ export interface TumblingWindow {
|
|
|
536
586
|
offset?: string;
|
|
537
587
|
}
|
|
538
588
|
/**
|
|
589
|
+
* @public
|
|
539
590
|
* <p>Contains a time interval window used for data aggregate computations (for example,
|
|
540
591
|
* average, sum, count, and so on).</p>
|
|
541
592
|
*/
|
|
@@ -546,6 +597,7 @@ export interface MetricWindow {
|
|
|
546
597
|
tumbling?: TumblingWindow;
|
|
547
598
|
}
|
|
548
599
|
/**
|
|
600
|
+
* @public
|
|
549
601
|
* <p>Contains an asset metric property. With metrics, you can calculate aggregate functions,
|
|
550
602
|
* such as an average, maximum, or minimum, as specified through an expression. A metric maps
|
|
551
603
|
* several values to a single value (such as a sum).</p>
|
|
@@ -581,6 +633,7 @@ export interface Metric {
|
|
|
581
633
|
processingConfig?: MetricProcessingConfig;
|
|
582
634
|
}
|
|
583
635
|
/**
|
|
636
|
+
* @public
|
|
584
637
|
* <p>The processing configuration for the given transform property.
|
|
585
638
|
* You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud.
|
|
586
639
|
* You can also configure transforms to be computed at the edge or in the cloud.</p>
|
|
@@ -596,6 +649,7 @@ export interface TransformProcessingConfig {
|
|
|
596
649
|
forwardingConfig?: ForwardingConfig;
|
|
597
650
|
}
|
|
598
651
|
/**
|
|
652
|
+
* @public
|
|
599
653
|
* <p>Contains an asset transform property. A transform is a one-to-one mapping of a property's
|
|
600
654
|
* data points from one form to another. For example, you can use a transform to convert a
|
|
601
655
|
* Celsius data stream to Fahrenheit by applying the transformation expression to each data point
|
|
@@ -623,6 +677,7 @@ export interface Transform {
|
|
|
623
677
|
processingConfig?: TransformProcessingConfig;
|
|
624
678
|
}
|
|
625
679
|
/**
|
|
680
|
+
* @public
|
|
626
681
|
* <p>Contains a property type, which can be one of <code>attribute</code>,
|
|
627
682
|
* <code>measurement</code>, <code>metric</code>, or <code>transform</code>.</p>
|
|
628
683
|
*/
|
|
@@ -651,6 +706,7 @@ export interface PropertyType {
|
|
|
651
706
|
metric?: Metric;
|
|
652
707
|
}
|
|
653
708
|
/**
|
|
709
|
+
* @public
|
|
654
710
|
* <p>Contains information about an asset model property.</p>
|
|
655
711
|
*/
|
|
656
712
|
export interface AssetModelProperty {
|
|
@@ -682,6 +738,7 @@ export interface AssetModelProperty {
|
|
|
682
738
|
type: PropertyType | undefined;
|
|
683
739
|
}
|
|
684
740
|
/**
|
|
741
|
+
* @public
|
|
685
742
|
* <p>Contains information about a composite model in an asset model. This object contains the
|
|
686
743
|
* asset property definitions that you define in the composite model.</p>
|
|
687
744
|
*/
|
|
@@ -711,6 +768,7 @@ export interface AssetModelCompositeModel {
|
|
|
711
768
|
id?: string;
|
|
712
769
|
}
|
|
713
770
|
/**
|
|
771
|
+
* @public
|
|
714
772
|
* <p>Contains an asset model property definition. This property definition is applied to all
|
|
715
773
|
* assets created from the asset model.</p>
|
|
716
774
|
*/
|
|
@@ -745,6 +803,7 @@ export interface AssetModelPropertyDefinition {
|
|
|
745
803
|
type: PropertyType | undefined;
|
|
746
804
|
}
|
|
747
805
|
/**
|
|
806
|
+
* @public
|
|
748
807
|
* <p>Contains a composite model definition in an asset model. This composite model definition
|
|
749
808
|
* is applied to all assets created from the asset model.</p>
|
|
750
809
|
*/
|
|
@@ -768,6 +827,7 @@ export interface AssetModelCompositeModelDefinition {
|
|
|
768
827
|
properties?: AssetModelPropertyDefinition[];
|
|
769
828
|
}
|
|
770
829
|
/**
|
|
830
|
+
* @public
|
|
771
831
|
* <p>Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model
|
|
772
832
|
* ID that specifies the type of asset that can be in this hierarchy.</p>
|
|
773
833
|
*/
|
|
@@ -788,6 +848,7 @@ export interface AssetModelHierarchy {
|
|
|
788
848
|
childAssetModelId: string | undefined;
|
|
789
849
|
}
|
|
790
850
|
/**
|
|
851
|
+
* @public
|
|
791
852
|
* <p>Contains an asset model hierarchy used in asset model creation. An asset model hierarchy
|
|
792
853
|
* determines the kind (or type) of asset that can belong to a hierarchy.</p>
|
|
793
854
|
*/
|
|
@@ -803,6 +864,7 @@ export interface AssetModelHierarchyDefinition {
|
|
|
803
864
|
childAssetModelId: string | undefined;
|
|
804
865
|
}
|
|
805
866
|
/**
|
|
867
|
+
* @public
|
|
806
868
|
* <p>Contains a summary of a property associated with a model.</p>
|
|
807
869
|
*/
|
|
808
870
|
export interface AssetModelPropertySummary {
|
|
@@ -839,6 +901,9 @@ export interface AssetModelPropertySummary {
|
|
|
839
901
|
*/
|
|
840
902
|
assetModelCompositeModelId?: string;
|
|
841
903
|
}
|
|
904
|
+
/**
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
842
907
|
export declare enum AssetModelState {
|
|
843
908
|
ACTIVE = "ACTIVE",
|
|
844
909
|
CREATING = "CREATING",
|
|
@@ -847,15 +912,22 @@ export declare enum AssetModelState {
|
|
|
847
912
|
PROPAGATING = "PROPAGATING",
|
|
848
913
|
UPDATING = "UPDATING"
|
|
849
914
|
}
|
|
915
|
+
/**
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
850
918
|
export declare enum ErrorCode {
|
|
851
919
|
INTERNAL_FAILURE = "INTERNAL_FAILURE",
|
|
852
920
|
VALIDATION_ERROR = "VALIDATION_ERROR"
|
|
853
921
|
}
|
|
922
|
+
/**
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
854
925
|
export declare enum DetailedErrorCode {
|
|
855
926
|
INCOMPATIBLE_COMPUTE_LOCATION = "INCOMPATIBLE_COMPUTE_LOCATION",
|
|
856
927
|
INCOMPATIBLE_FORWARDING_CONFIGURATION = "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
|
857
928
|
}
|
|
858
929
|
/**
|
|
930
|
+
* @public
|
|
859
931
|
* <p>Contains detailed error information. </p>
|
|
860
932
|
*/
|
|
861
933
|
export interface DetailedError {
|
|
@@ -869,6 +941,7 @@ export interface DetailedError {
|
|
|
869
941
|
message: string | undefined;
|
|
870
942
|
}
|
|
871
943
|
/**
|
|
944
|
+
* @public
|
|
872
945
|
* <p>Contains the details of an IoT SiteWise error.</p>
|
|
873
946
|
*/
|
|
874
947
|
export interface ErrorDetails {
|
|
@@ -886,6 +959,7 @@ export interface ErrorDetails {
|
|
|
886
959
|
details?: DetailedError[];
|
|
887
960
|
}
|
|
888
961
|
/**
|
|
962
|
+
* @public
|
|
889
963
|
* <p>Contains current status information for an asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model
|
|
890
964
|
* states</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
891
965
|
*/
|
|
@@ -900,6 +974,7 @@ export interface AssetModelStatus {
|
|
|
900
974
|
error?: ErrorDetails;
|
|
901
975
|
}
|
|
902
976
|
/**
|
|
977
|
+
* @public
|
|
903
978
|
* <p>Contains a summary of an asset model.</p>
|
|
904
979
|
*/
|
|
905
980
|
export interface AssetModelSummary {
|
|
@@ -910,7 +985,7 @@ export interface AssetModelSummary {
|
|
|
910
985
|
/**
|
|
911
986
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p>
|
|
912
987
|
* <p>
|
|
913
|
-
* <code>arn
|
|
988
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
|
|
914
989
|
* </p>
|
|
915
990
|
*/
|
|
916
991
|
arn: string | undefined;
|
|
@@ -936,6 +1011,7 @@ export interface AssetModelSummary {
|
|
|
936
1011
|
status: AssetModelStatus | undefined;
|
|
937
1012
|
}
|
|
938
1013
|
/**
|
|
1014
|
+
* @public
|
|
939
1015
|
* <p>Contains a summary of a property associated with an asset.</p>
|
|
940
1016
|
*/
|
|
941
1017
|
export interface AssetPropertySummary {
|
|
@@ -969,6 +1045,7 @@ export interface AssetPropertySummary {
|
|
|
969
1045
|
assetCompositeModelId?: string;
|
|
970
1046
|
}
|
|
971
1047
|
/**
|
|
1048
|
+
* @public
|
|
972
1049
|
* <p>Contains a timestamp with optional nanosecond granularity.</p>
|
|
973
1050
|
*/
|
|
974
1051
|
export interface TimeInNanos {
|
|
@@ -983,6 +1060,7 @@ export interface TimeInNanos {
|
|
|
983
1060
|
offsetInNanos?: number;
|
|
984
1061
|
}
|
|
985
1062
|
/**
|
|
1063
|
+
* @public
|
|
986
1064
|
* <p>Contains an asset property value (of a single type only).</p>
|
|
987
1065
|
*/
|
|
988
1066
|
export interface Variant {
|
|
@@ -1004,6 +1082,7 @@ export interface Variant {
|
|
|
1004
1082
|
booleanValue?: boolean;
|
|
1005
1083
|
}
|
|
1006
1084
|
/**
|
|
1085
|
+
* @public
|
|
1007
1086
|
* <p>Contains asset property value information.</p>
|
|
1008
1087
|
*/
|
|
1009
1088
|
export interface AssetPropertyValue {
|
|
@@ -1020,10 +1099,14 @@ export interface AssetPropertyValue {
|
|
|
1020
1099
|
*/
|
|
1021
1100
|
quality?: Quality | string;
|
|
1022
1101
|
}
|
|
1102
|
+
/**
|
|
1103
|
+
* @public
|
|
1104
|
+
*/
|
|
1023
1105
|
export declare enum AssetRelationshipType {
|
|
1024
1106
|
HIERARCHY = "HIERARCHY"
|
|
1025
1107
|
}
|
|
1026
1108
|
/**
|
|
1109
|
+
* @public
|
|
1027
1110
|
* <p>Contains information about assets that are related to one another.</p>
|
|
1028
1111
|
*/
|
|
1029
1112
|
export interface AssetRelationshipSummary {
|
|
@@ -1047,6 +1130,9 @@ export interface AssetRelationshipSummary {
|
|
|
1047
1130
|
*/
|
|
1048
1131
|
relationshipType: AssetRelationshipType | string | undefined;
|
|
1049
1132
|
}
|
|
1133
|
+
/**
|
|
1134
|
+
* @public
|
|
1135
|
+
*/
|
|
1050
1136
|
export declare enum AssetState {
|
|
1051
1137
|
ACTIVE = "ACTIVE",
|
|
1052
1138
|
CREATING = "CREATING",
|
|
@@ -1055,6 +1141,7 @@ export declare enum AssetState {
|
|
|
1055
1141
|
UPDATING = "UPDATING"
|
|
1056
1142
|
}
|
|
1057
1143
|
/**
|
|
1144
|
+
* @public
|
|
1058
1145
|
* <p>Contains information about the current status of an asset. For more information, see
|
|
1059
1146
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model
|
|
1060
1147
|
* states</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -1070,6 +1157,7 @@ export interface AssetStatus {
|
|
|
1070
1157
|
error?: ErrorDetails;
|
|
1071
1158
|
}
|
|
1072
1159
|
/**
|
|
1160
|
+
* @public
|
|
1073
1161
|
* <p>Contains a summary of an asset.</p>
|
|
1074
1162
|
*/
|
|
1075
1163
|
export interface AssetSummary {
|
|
@@ -1080,7 +1168,7 @@ export interface AssetSummary {
|
|
|
1080
1168
|
/**
|
|
1081
1169
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
|
|
1082
1170
|
* <p>
|
|
1083
|
-
* <code>arn
|
|
1171
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
|
|
1084
1172
|
* </p>
|
|
1085
1173
|
*/
|
|
1086
1174
|
arn: string | undefined;
|
|
@@ -1113,6 +1201,9 @@ export interface AssetSummary {
|
|
|
1113
1201
|
*/
|
|
1114
1202
|
description?: string;
|
|
1115
1203
|
}
|
|
1204
|
+
/**
|
|
1205
|
+
* @public
|
|
1206
|
+
*/
|
|
1116
1207
|
export interface AssociateAssetsRequest {
|
|
1117
1208
|
/**
|
|
1118
1209
|
* <p>The ID of the parent asset.</p>
|
|
@@ -1134,6 +1225,7 @@ export interface AssociateAssetsRequest {
|
|
|
1134
1225
|
clientToken?: string;
|
|
1135
1226
|
}
|
|
1136
1227
|
/**
|
|
1228
|
+
* @public
|
|
1137
1229
|
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
1138
1230
|
* than one operation on the same resource at the same time.</p>
|
|
1139
1231
|
*/
|
|
@@ -1154,6 +1246,7 @@ export declare class ConflictingOperationException extends __BaseException {
|
|
|
1154
1246
|
constructor(opts: __ExceptionOptionType<ConflictingOperationException, __BaseException>);
|
|
1155
1247
|
}
|
|
1156
1248
|
/**
|
|
1249
|
+
* @public
|
|
1157
1250
|
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
1158
1251
|
*/
|
|
1159
1252
|
export declare class InternalFailureException extends __BaseException {
|
|
@@ -1165,6 +1258,7 @@ export declare class InternalFailureException extends __BaseException {
|
|
|
1165
1258
|
constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
|
|
1166
1259
|
}
|
|
1167
1260
|
/**
|
|
1261
|
+
* @public
|
|
1168
1262
|
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
1169
1263
|
* unsupported characters. Check your request and try again.</p>
|
|
1170
1264
|
*/
|
|
@@ -1177,6 +1271,7 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
1177
1271
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
1178
1272
|
}
|
|
1179
1273
|
/**
|
|
1274
|
+
* @public
|
|
1180
1275
|
* <p>You've reached the limit for a resource. For example, this can occur if you're trying to
|
|
1181
1276
|
* associate more than the allowed number of child assets or attempting to create more than the
|
|
1182
1277
|
* allowed number of properties for an asset model.</p>
|
|
@@ -1191,6 +1286,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1191
1286
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1192
1287
|
}
|
|
1193
1288
|
/**
|
|
1289
|
+
* @public
|
|
1194
1290
|
* <p>The resource already exists.</p>
|
|
1195
1291
|
*/
|
|
1196
1292
|
export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
@@ -1210,6 +1306,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1210
1306
|
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
|
|
1211
1307
|
}
|
|
1212
1308
|
/**
|
|
1309
|
+
* @public
|
|
1213
1310
|
* <p>The requested resource can't be found.</p>
|
|
1214
1311
|
*/
|
|
1215
1312
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -1221,6 +1318,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1221
1318
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1222
1319
|
}
|
|
1223
1320
|
/**
|
|
1321
|
+
* @public
|
|
1224
1322
|
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
1225
1323
|
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
1226
1324
|
* on.</p>
|
|
@@ -1235,6 +1333,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1235
1333
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1236
1334
|
}
|
|
1237
1335
|
/**
|
|
1336
|
+
* @public
|
|
1238
1337
|
* <p>Contains a summary of an associated asset.</p>
|
|
1239
1338
|
*/
|
|
1240
1339
|
export interface AssociatedAssetsSummary {
|
|
@@ -1245,7 +1344,7 @@ export interface AssociatedAssetsSummary {
|
|
|
1245
1344
|
/**
|
|
1246
1345
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
|
|
1247
1346
|
* <p>
|
|
1248
|
-
* <code>arn
|
|
1347
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
|
|
1249
1348
|
* </p>
|
|
1250
1349
|
*/
|
|
1251
1350
|
arn: string | undefined;
|
|
@@ -1278,6 +1377,9 @@ export interface AssociatedAssetsSummary {
|
|
|
1278
1377
|
*/
|
|
1279
1378
|
description?: string;
|
|
1280
1379
|
}
|
|
1380
|
+
/**
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1281
1383
|
export interface AssociateTimeSeriesToAssetPropertyRequest {
|
|
1282
1384
|
/**
|
|
1283
1385
|
* <p>The alias that identifies the time series.</p>
|
|
@@ -1296,10 +1398,16 @@ export interface AssociateTimeSeriesToAssetPropertyRequest {
|
|
|
1296
1398
|
*/
|
|
1297
1399
|
clientToken?: string;
|
|
1298
1400
|
}
|
|
1401
|
+
/**
|
|
1402
|
+
* @public
|
|
1403
|
+
*/
|
|
1299
1404
|
export declare enum AuthMode {
|
|
1300
1405
|
IAM = "IAM",
|
|
1301
1406
|
SSO = "SSO"
|
|
1302
1407
|
}
|
|
1408
|
+
/**
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1303
1411
|
export interface BatchAssociateProjectAssetsRequest {
|
|
1304
1412
|
/**
|
|
1305
1413
|
* <p>The ID of the project to which to associate the assets.</p>
|
|
@@ -1314,12 +1422,18 @@ export interface BatchAssociateProjectAssetsRequest {
|
|
|
1314
1422
|
*/
|
|
1315
1423
|
clientToken?: string;
|
|
1316
1424
|
}
|
|
1425
|
+
/**
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1317
1428
|
export interface BatchAssociateProjectAssetsResponse {
|
|
1318
1429
|
/**
|
|
1319
1430
|
* <p>A list of associated error information, if any.</p>
|
|
1320
1431
|
*/
|
|
1321
1432
|
errors?: AssetErrorDetails[];
|
|
1322
1433
|
}
|
|
1434
|
+
/**
|
|
1435
|
+
* @public
|
|
1436
|
+
*/
|
|
1323
1437
|
export interface BatchDisassociateProjectAssetsRequest {
|
|
1324
1438
|
/**
|
|
1325
1439
|
* <p>The ID of the project from which to disassociate the assets.</p>
|
|
@@ -1334,17 +1448,24 @@ export interface BatchDisassociateProjectAssetsRequest {
|
|
|
1334
1448
|
*/
|
|
1335
1449
|
clientToken?: string;
|
|
1336
1450
|
}
|
|
1451
|
+
/**
|
|
1452
|
+
* @public
|
|
1453
|
+
*/
|
|
1337
1454
|
export interface BatchDisassociateProjectAssetsResponse {
|
|
1338
1455
|
/**
|
|
1339
1456
|
* <p>A list of associated error information, if any.</p>
|
|
1340
1457
|
*/
|
|
1341
1458
|
errors?: AssetErrorDetails[];
|
|
1342
1459
|
}
|
|
1460
|
+
/**
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1343
1463
|
export declare enum TimeOrdering {
|
|
1344
1464
|
ASCENDING = "ASCENDING",
|
|
1345
1465
|
DESCENDING = "DESCENDING"
|
|
1346
1466
|
}
|
|
1347
1467
|
/**
|
|
1468
|
+
* @public
|
|
1348
1469
|
* <p>Contains information for an asset property aggregate entry that is associated with the
|
|
1349
1470
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1350
1471
|
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
@@ -1405,6 +1526,9 @@ export interface BatchGetAssetPropertyAggregatesEntry {
|
|
|
1405
1526
|
*/
|
|
1406
1527
|
timeOrdering?: TimeOrdering | string;
|
|
1407
1528
|
}
|
|
1529
|
+
/**
|
|
1530
|
+
* @public
|
|
1531
|
+
*/
|
|
1408
1532
|
export interface BatchGetAssetPropertyAggregatesRequest {
|
|
1409
1533
|
/**
|
|
1410
1534
|
* <p>The list of asset property aggregate entries for the batch get request. You can specify up
|
|
@@ -1430,12 +1554,16 @@ export interface BatchGetAssetPropertyAggregatesRequest {
|
|
|
1430
1554
|
*/
|
|
1431
1555
|
maxResults?: number;
|
|
1432
1556
|
}
|
|
1557
|
+
/**
|
|
1558
|
+
* @public
|
|
1559
|
+
*/
|
|
1433
1560
|
export declare enum BatchGetAssetPropertyAggregatesErrorCode {
|
|
1434
1561
|
AccessDeniedException = "AccessDeniedException",
|
|
1435
1562
|
InvalidRequestException = "InvalidRequestException",
|
|
1436
1563
|
ResourceNotFoundException = "ResourceNotFoundException"
|
|
1437
1564
|
}
|
|
1438
1565
|
/**
|
|
1566
|
+
* @public
|
|
1439
1567
|
* <p>Contains error information for an asset property aggregate entry that is associated with
|
|
1440
1568
|
* the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1441
1569
|
*/
|
|
@@ -1453,11 +1581,15 @@ export interface BatchGetAssetPropertyAggregatesErrorEntry {
|
|
|
1453
1581
|
*/
|
|
1454
1582
|
entryId: string | undefined;
|
|
1455
1583
|
}
|
|
1584
|
+
/**
|
|
1585
|
+
* @public
|
|
1586
|
+
*/
|
|
1456
1587
|
export declare enum BatchEntryCompletionStatus {
|
|
1457
1588
|
ERROR = "ERROR",
|
|
1458
1589
|
SUCCESS = "SUCCESS"
|
|
1459
1590
|
}
|
|
1460
1591
|
/**
|
|
1592
|
+
* @public
|
|
1461
1593
|
* <p>Contains the error code and the timestamp for an asset property aggregate entry that is
|
|
1462
1594
|
* associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1463
1595
|
*/
|
|
@@ -1472,6 +1604,7 @@ export interface BatchGetAssetPropertyAggregatesErrorInfo {
|
|
|
1472
1604
|
errorTimestamp: Date | undefined;
|
|
1473
1605
|
}
|
|
1474
1606
|
/**
|
|
1607
|
+
* @public
|
|
1475
1608
|
* <p>Contains information for an entry that has been processed by the previous <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> request.</p>
|
|
1476
1609
|
*/
|
|
1477
1610
|
export interface BatchGetAssetPropertyAggregatesSkippedEntry {
|
|
@@ -1489,6 +1622,7 @@ export interface BatchGetAssetPropertyAggregatesSkippedEntry {
|
|
|
1489
1622
|
errorInfo?: BatchGetAssetPropertyAggregatesErrorInfo;
|
|
1490
1623
|
}
|
|
1491
1624
|
/**
|
|
1625
|
+
* @public
|
|
1492
1626
|
* <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1493
1627
|
*/
|
|
1494
1628
|
export interface BatchGetAssetPropertyAggregatesSuccessEntry {
|
|
@@ -1502,6 +1636,9 @@ export interface BatchGetAssetPropertyAggregatesSuccessEntry {
|
|
|
1502
1636
|
*/
|
|
1503
1637
|
aggregatedValues: AggregatedValue[] | undefined;
|
|
1504
1638
|
}
|
|
1639
|
+
/**
|
|
1640
|
+
* @public
|
|
1641
|
+
*/
|
|
1505
1642
|
export interface BatchGetAssetPropertyAggregatesResponse {
|
|
1506
1643
|
/**
|
|
1507
1644
|
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
@@ -1525,6 +1662,7 @@ export interface BatchGetAssetPropertyAggregatesResponse {
|
|
|
1525
1662
|
nextToken?: string;
|
|
1526
1663
|
}
|
|
1527
1664
|
/**
|
|
1665
|
+
* @public
|
|
1528
1666
|
* <p>The requested service is unavailable.</p>
|
|
1529
1667
|
*/
|
|
1530
1668
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
@@ -1536,6 +1674,7 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
1536
1674
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1537
1675
|
}
|
|
1538
1676
|
/**
|
|
1677
|
+
* @public
|
|
1539
1678
|
* <p>Contains information for an asset property value entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
|
|
1540
1679
|
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
1541
1680
|
* <ul>
|
|
@@ -1569,6 +1708,9 @@ export interface BatchGetAssetPropertyValueEntry {
|
|
|
1569
1708
|
*/
|
|
1570
1709
|
propertyAlias?: string;
|
|
1571
1710
|
}
|
|
1711
|
+
/**
|
|
1712
|
+
* @public
|
|
1713
|
+
*/
|
|
1572
1714
|
export interface BatchGetAssetPropertyValueRequest {
|
|
1573
1715
|
/**
|
|
1574
1716
|
* <p>The list of asset property value entries for the batch get request. You can specify up to
|
|
@@ -1580,12 +1722,16 @@ export interface BatchGetAssetPropertyValueRequest {
|
|
|
1580
1722
|
*/
|
|
1581
1723
|
nextToken?: string;
|
|
1582
1724
|
}
|
|
1725
|
+
/**
|
|
1726
|
+
* @public
|
|
1727
|
+
*/
|
|
1583
1728
|
export declare enum BatchGetAssetPropertyValueErrorCode {
|
|
1584
1729
|
AccessDeniedException = "AccessDeniedException",
|
|
1585
1730
|
InvalidRequestException = "InvalidRequestException",
|
|
1586
1731
|
ResourceNotFoundException = "ResourceNotFoundException"
|
|
1587
1732
|
}
|
|
1588
1733
|
/**
|
|
1734
|
+
* @public
|
|
1589
1735
|
* <p>Contains error information for an asset property value entry that is associated with the
|
|
1590
1736
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
|
|
1591
1737
|
*/
|
|
@@ -1604,6 +1750,7 @@ export interface BatchGetAssetPropertyValueErrorEntry {
|
|
|
1604
1750
|
entryId: string | undefined;
|
|
1605
1751
|
}
|
|
1606
1752
|
/**
|
|
1753
|
+
* @public
|
|
1607
1754
|
* <p>The error information, such as the error code and the timestamp.</p>
|
|
1608
1755
|
*/
|
|
1609
1756
|
export interface BatchGetAssetPropertyValueErrorInfo {
|
|
@@ -1617,6 +1764,7 @@ export interface BatchGetAssetPropertyValueErrorInfo {
|
|
|
1617
1764
|
errorTimestamp: Date | undefined;
|
|
1618
1765
|
}
|
|
1619
1766
|
/**
|
|
1767
|
+
* @public
|
|
1620
1768
|
* <p>Contains information for an entry that has been processed by the previous <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
|
|
1621
1769
|
*/
|
|
1622
1770
|
export interface BatchGetAssetPropertyValueSkippedEntry {
|
|
@@ -1634,6 +1782,7 @@ export interface BatchGetAssetPropertyValueSkippedEntry {
|
|
|
1634
1782
|
errorInfo?: BatchGetAssetPropertyValueErrorInfo;
|
|
1635
1783
|
}
|
|
1636
1784
|
/**
|
|
1785
|
+
* @public
|
|
1637
1786
|
* <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
|
|
1638
1787
|
*/
|
|
1639
1788
|
export interface BatchGetAssetPropertyValueSuccessEntry {
|
|
@@ -1646,6 +1795,9 @@ export interface BatchGetAssetPropertyValueSuccessEntry {
|
|
|
1646
1795
|
*/
|
|
1647
1796
|
assetPropertyValue?: AssetPropertyValue;
|
|
1648
1797
|
}
|
|
1798
|
+
/**
|
|
1799
|
+
* @public
|
|
1800
|
+
*/
|
|
1649
1801
|
export interface BatchGetAssetPropertyValueResponse {
|
|
1650
1802
|
/**
|
|
1651
1803
|
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
@@ -1669,6 +1821,7 @@ export interface BatchGetAssetPropertyValueResponse {
|
|
|
1669
1821
|
nextToken?: string;
|
|
1670
1822
|
}
|
|
1671
1823
|
/**
|
|
1824
|
+
* @public
|
|
1672
1825
|
* <p>Contains information for an asset property historical value entry that is associated with
|
|
1673
1826
|
* the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
|
|
1674
1827
|
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
@@ -1721,6 +1874,9 @@ export interface BatchGetAssetPropertyValueHistoryEntry {
|
|
|
1721
1874
|
*/
|
|
1722
1875
|
timeOrdering?: TimeOrdering | string;
|
|
1723
1876
|
}
|
|
1877
|
+
/**
|
|
1878
|
+
* @public
|
|
1879
|
+
*/
|
|
1724
1880
|
export interface BatchGetAssetPropertyValueHistoryRequest {
|
|
1725
1881
|
/**
|
|
1726
1882
|
* <p>The list of asset property historical value entries for the batch get request. You can
|
|
@@ -1746,12 +1902,16 @@ export interface BatchGetAssetPropertyValueHistoryRequest {
|
|
|
1746
1902
|
*/
|
|
1747
1903
|
maxResults?: number;
|
|
1748
1904
|
}
|
|
1905
|
+
/**
|
|
1906
|
+
* @public
|
|
1907
|
+
*/
|
|
1749
1908
|
export declare enum BatchGetAssetPropertyValueHistoryErrorCode {
|
|
1750
1909
|
AccessDeniedException = "AccessDeniedException",
|
|
1751
1910
|
InvalidRequestException = "InvalidRequestException",
|
|
1752
1911
|
ResourceNotFoundException = "ResourceNotFoundException"
|
|
1753
1912
|
}
|
|
1754
1913
|
/**
|
|
1914
|
+
* @public
|
|
1755
1915
|
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
1756
1916
|
* contains the <code>entryId</code> of the entry that failed.</p>
|
|
1757
1917
|
*/
|
|
@@ -1770,6 +1930,7 @@ export interface BatchGetAssetPropertyValueHistoryErrorEntry {
|
|
|
1770
1930
|
entryId: string | undefined;
|
|
1771
1931
|
}
|
|
1772
1932
|
/**
|
|
1933
|
+
* @public
|
|
1773
1934
|
* <p>The error information, such as the error code and the timestamp.</p>
|
|
1774
1935
|
*/
|
|
1775
1936
|
export interface BatchGetAssetPropertyValueHistoryErrorInfo {
|
|
@@ -1783,6 +1944,7 @@ export interface BatchGetAssetPropertyValueHistoryErrorInfo {
|
|
|
1783
1944
|
errorTimestamp: Date | undefined;
|
|
1784
1945
|
}
|
|
1785
1946
|
/**
|
|
1947
|
+
* @public
|
|
1786
1948
|
* <p>Contains information for an entry that has been processed by the previous <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> request.</p>
|
|
1787
1949
|
*/
|
|
1788
1950
|
export interface BatchGetAssetPropertyValueHistorySkippedEntry {
|
|
@@ -1800,6 +1962,7 @@ export interface BatchGetAssetPropertyValueHistorySkippedEntry {
|
|
|
1800
1962
|
errorInfo?: BatchGetAssetPropertyValueHistoryErrorInfo;
|
|
1801
1963
|
}
|
|
1802
1964
|
/**
|
|
1965
|
+
* @public
|
|
1803
1966
|
* <p>Contains success information for an entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
|
|
1804
1967
|
*/
|
|
1805
1968
|
export interface BatchGetAssetPropertyValueHistorySuccessEntry {
|
|
@@ -1812,6 +1975,9 @@ export interface BatchGetAssetPropertyValueHistorySuccessEntry {
|
|
|
1812
1975
|
*/
|
|
1813
1976
|
assetPropertyValueHistory: AssetPropertyValue[] | undefined;
|
|
1814
1977
|
}
|
|
1978
|
+
/**
|
|
1979
|
+
* @public
|
|
1980
|
+
*/
|
|
1815
1981
|
export interface BatchGetAssetPropertyValueHistoryResponse {
|
|
1816
1982
|
/**
|
|
1817
1983
|
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
@@ -1835,6 +2001,7 @@ export interface BatchGetAssetPropertyValueHistoryResponse {
|
|
|
1835
2001
|
nextToken?: string;
|
|
1836
2002
|
}
|
|
1837
2003
|
/**
|
|
2004
|
+
* @public
|
|
1838
2005
|
* <p>Contains a list of value updates for an asset property in the list of asset entries
|
|
1839
2006
|
* consumed by the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html">BatchPutAssetPropertyValue</a> API
|
|
1840
2007
|
* operation.</p>
|
|
@@ -1866,6 +2033,9 @@ export interface PutAssetPropertyValueEntry {
|
|
|
1866
2033
|
*/
|
|
1867
2034
|
propertyValues: AssetPropertyValue[] | undefined;
|
|
1868
2035
|
}
|
|
2036
|
+
/**
|
|
2037
|
+
* @public
|
|
2038
|
+
*/
|
|
1869
2039
|
export interface BatchPutAssetPropertyValueRequest {
|
|
1870
2040
|
/**
|
|
1871
2041
|
* <p>The list of asset property value entries for the batch put request. You can specify up to
|
|
@@ -1873,6 +2043,9 @@ export interface BatchPutAssetPropertyValueRequest {
|
|
|
1873
2043
|
*/
|
|
1874
2044
|
entries: PutAssetPropertyValueEntry[] | undefined;
|
|
1875
2045
|
}
|
|
2046
|
+
/**
|
|
2047
|
+
* @public
|
|
2048
|
+
*/
|
|
1876
2049
|
export declare enum BatchPutAssetPropertyValueErrorCode {
|
|
1877
2050
|
AccessDeniedException = "AccessDeniedException",
|
|
1878
2051
|
ConflictingOperationException = "ConflictingOperationException",
|
|
@@ -1885,6 +2058,7 @@ export declare enum BatchPutAssetPropertyValueErrorCode {
|
|
|
1885
2058
|
TimestampOutOfRangeException = "TimestampOutOfRangeException"
|
|
1886
2059
|
}
|
|
1887
2060
|
/**
|
|
2061
|
+
* @public
|
|
1888
2062
|
* <p>Contains error information from updating a batch of asset property values.</p>
|
|
1889
2063
|
*/
|
|
1890
2064
|
export interface BatchPutAssetPropertyError {
|
|
@@ -1902,6 +2076,7 @@ export interface BatchPutAssetPropertyError {
|
|
|
1902
2076
|
timestamps: TimeInNanos[] | undefined;
|
|
1903
2077
|
}
|
|
1904
2078
|
/**
|
|
2079
|
+
* @public
|
|
1905
2080
|
* <p>Contains error information for asset property value entries that are associated with the
|
|
1906
2081
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html">BatchPutAssetPropertyValue</a> API.</p>
|
|
1907
2082
|
*/
|
|
@@ -1915,6 +2090,9 @@ export interface BatchPutAssetPropertyErrorEntry {
|
|
|
1915
2090
|
*/
|
|
1916
2091
|
errors: BatchPutAssetPropertyError[] | undefined;
|
|
1917
2092
|
}
|
|
2093
|
+
/**
|
|
2094
|
+
* @public
|
|
2095
|
+
*/
|
|
1918
2096
|
export interface BatchPutAssetPropertyValueResponse {
|
|
1919
2097
|
/**
|
|
1920
2098
|
* <p>A list of the errors (if any) associated with the batch put request. Each error entry
|
|
@@ -1922,6 +2100,9 @@ export interface BatchPutAssetPropertyValueResponse {
|
|
|
1922
2100
|
*/
|
|
1923
2101
|
errorEntries: BatchPutAssetPropertyErrorEntry[] | undefined;
|
|
1924
2102
|
}
|
|
2103
|
+
/**
|
|
2104
|
+
* @public
|
|
2105
|
+
*/
|
|
1925
2106
|
export interface CreateAccessPolicyRequest {
|
|
1926
2107
|
/**
|
|
1927
2108
|
* <p>The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.</p>
|
|
@@ -1946,6 +2127,9 @@ export interface CreateAccessPolicyRequest {
|
|
|
1946
2127
|
*/
|
|
1947
2128
|
tags?: Record<string, string>;
|
|
1948
2129
|
}
|
|
2130
|
+
/**
|
|
2131
|
+
* @public
|
|
2132
|
+
*/
|
|
1949
2133
|
export interface CreateAccessPolicyResponse {
|
|
1950
2134
|
/**
|
|
1951
2135
|
* <p>The ID of the access policy.</p>
|
|
@@ -1954,11 +2138,14 @@ export interface CreateAccessPolicyResponse {
|
|
|
1954
2138
|
/**
|
|
1955
2139
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the access policy, which has the following format.</p>
|
|
1956
2140
|
* <p>
|
|
1957
|
-
* <code>arn
|
|
2141
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:access-policy/$\{AccessPolicyId\}</code>
|
|
1958
2142
|
* </p>
|
|
1959
2143
|
*/
|
|
1960
2144
|
accessPolicyArn: string | undefined;
|
|
1961
2145
|
}
|
|
2146
|
+
/**
|
|
2147
|
+
* @public
|
|
2148
|
+
*/
|
|
1962
2149
|
export interface CreateAssetRequest {
|
|
1963
2150
|
/**
|
|
1964
2151
|
* <p>A friendly name for the asset.</p>
|
|
@@ -1983,6 +2170,9 @@ export interface CreateAssetRequest {
|
|
|
1983
2170
|
*/
|
|
1984
2171
|
assetDescription?: string;
|
|
1985
2172
|
}
|
|
2173
|
+
/**
|
|
2174
|
+
* @public
|
|
2175
|
+
*/
|
|
1986
2176
|
export interface CreateAssetResponse {
|
|
1987
2177
|
/**
|
|
1988
2178
|
* <p>The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other
|
|
@@ -1992,7 +2182,7 @@ export interface CreateAssetResponse {
|
|
|
1992
2182
|
/**
|
|
1993
2183
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
|
|
1994
2184
|
* <p>
|
|
1995
|
-
* <code>arn
|
|
2185
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
|
|
1996
2186
|
* </p>
|
|
1997
2187
|
*/
|
|
1998
2188
|
assetArn: string | undefined;
|
|
@@ -2002,6 +2192,9 @@ export interface CreateAssetResponse {
|
|
|
2002
2192
|
*/
|
|
2003
2193
|
assetStatus: AssetStatus | undefined;
|
|
2004
2194
|
}
|
|
2195
|
+
/**
|
|
2196
|
+
* @public
|
|
2197
|
+
*/
|
|
2005
2198
|
export interface CreateAssetModelRequest {
|
|
2006
2199
|
/**
|
|
2007
2200
|
* <p>A unique, friendly name for the asset model.</p>
|
|
@@ -2044,6 +2237,9 @@ export interface CreateAssetModelRequest {
|
|
|
2044
2237
|
*/
|
|
2045
2238
|
tags?: Record<string, string>;
|
|
2046
2239
|
}
|
|
2240
|
+
/**
|
|
2241
|
+
* @public
|
|
2242
|
+
*/
|
|
2047
2243
|
export interface CreateAssetModelResponse {
|
|
2048
2244
|
/**
|
|
2049
2245
|
* <p>The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs.</p>
|
|
@@ -2052,7 +2248,7 @@ export interface CreateAssetModelResponse {
|
|
|
2052
2248
|
/**
|
|
2053
2249
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p>
|
|
2054
2250
|
* <p>
|
|
2055
|
-
* <code>arn
|
|
2251
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
|
|
2056
2252
|
* </p>
|
|
2057
2253
|
*/
|
|
2058
2254
|
assetModelArn: string | undefined;
|
|
@@ -2063,6 +2259,7 @@ export interface CreateAssetModelResponse {
|
|
|
2063
2259
|
assetModelStatus: AssetModelStatus | undefined;
|
|
2064
2260
|
}
|
|
2065
2261
|
/**
|
|
2262
|
+
* @public
|
|
2066
2263
|
* <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
|
|
2067
2264
|
*/
|
|
2068
2265
|
export interface ErrorReportLocation {
|
|
@@ -2080,6 +2277,7 @@ export interface ErrorReportLocation {
|
|
|
2080
2277
|
prefix: string | undefined;
|
|
2081
2278
|
}
|
|
2082
2279
|
/**
|
|
2280
|
+
* @public
|
|
2083
2281
|
* <p>The file in Amazon S3 where your data is saved. </p>
|
|
2084
2282
|
*/
|
|
2085
2283
|
export interface File {
|
|
@@ -2098,6 +2296,9 @@ export interface File {
|
|
|
2098
2296
|
*/
|
|
2099
2297
|
versionId?: string;
|
|
2100
2298
|
}
|
|
2299
|
+
/**
|
|
2300
|
+
* @public
|
|
2301
|
+
*/
|
|
2101
2302
|
export declare enum ColumnName {
|
|
2102
2303
|
ALIAS = "ALIAS",
|
|
2103
2304
|
ASSET_ID = "ASSET_ID",
|
|
@@ -2109,6 +2310,7 @@ export declare enum ColumnName {
|
|
|
2109
2310
|
VALUE = "VALUE"
|
|
2110
2311
|
}
|
|
2111
2312
|
/**
|
|
2313
|
+
* @public
|
|
2112
2314
|
* <p>A .csv file.</p>
|
|
2113
2315
|
*/
|
|
2114
2316
|
export interface Csv {
|
|
@@ -2118,6 +2320,7 @@ export interface Csv {
|
|
|
2118
2320
|
columnNames?: (ColumnName | string)[];
|
|
2119
2321
|
}
|
|
2120
2322
|
/**
|
|
2323
|
+
* @public
|
|
2121
2324
|
* <p>The file format of the data.</p>
|
|
2122
2325
|
*/
|
|
2123
2326
|
export interface FileFormat {
|
|
@@ -2127,6 +2330,7 @@ export interface FileFormat {
|
|
|
2127
2330
|
csv?: Csv;
|
|
2128
2331
|
}
|
|
2129
2332
|
/**
|
|
2333
|
+
* @public
|
|
2130
2334
|
* <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
|
|
2131
2335
|
*/
|
|
2132
2336
|
export interface JobConfiguration {
|
|
@@ -2135,6 +2339,9 @@ export interface JobConfiguration {
|
|
|
2135
2339
|
*/
|
|
2136
2340
|
fileFormat: FileFormat | undefined;
|
|
2137
2341
|
}
|
|
2342
|
+
/**
|
|
2343
|
+
* @public
|
|
2344
|
+
*/
|
|
2138
2345
|
export interface CreateBulkImportJobRequest {
|
|
2139
2346
|
/**
|
|
2140
2347
|
* <p>The unique name that helps identify the job request.</p>
|
|
@@ -2157,6 +2364,9 @@ export interface CreateBulkImportJobRequest {
|
|
|
2157
2364
|
*/
|
|
2158
2365
|
jobConfiguration: JobConfiguration | undefined;
|
|
2159
2366
|
}
|
|
2367
|
+
/**
|
|
2368
|
+
* @public
|
|
2369
|
+
*/
|
|
2160
2370
|
export declare enum JobStatus {
|
|
2161
2371
|
CANCELLED = "CANCELLED",
|
|
2162
2372
|
COMPLETED = "COMPLETED",
|
|
@@ -2165,6 +2375,9 @@ export declare enum JobStatus {
|
|
|
2165
2375
|
PENDING = "PENDING",
|
|
2166
2376
|
RUNNING = "RUNNING"
|
|
2167
2377
|
}
|
|
2378
|
+
/**
|
|
2379
|
+
* @public
|
|
2380
|
+
*/
|
|
2168
2381
|
export interface CreateBulkImportJobResponse {
|
|
2169
2382
|
/**
|
|
2170
2383
|
* <p>The ID of the job.</p>
|
|
@@ -2207,6 +2420,9 @@ export interface CreateBulkImportJobResponse {
|
|
|
2207
2420
|
*/
|
|
2208
2421
|
jobStatus: JobStatus | string | undefined;
|
|
2209
2422
|
}
|
|
2423
|
+
/**
|
|
2424
|
+
* @public
|
|
2425
|
+
*/
|
|
2210
2426
|
export interface CreateDashboardRequest {
|
|
2211
2427
|
/**
|
|
2212
2428
|
* <p>The ID of the project in which to create the dashboard.</p>
|
|
@@ -2236,6 +2452,9 @@ export interface CreateDashboardRequest {
|
|
|
2236
2452
|
*/
|
|
2237
2453
|
tags?: Record<string, string>;
|
|
2238
2454
|
}
|
|
2455
|
+
/**
|
|
2456
|
+
* @public
|
|
2457
|
+
*/
|
|
2239
2458
|
export interface CreateDashboardResponse {
|
|
2240
2459
|
/**
|
|
2241
2460
|
* <p>The ID of the dashboard.</p>
|
|
@@ -2244,12 +2463,13 @@ export interface CreateDashboardResponse {
|
|
|
2244
2463
|
/**
|
|
2245
2464
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
|
|
2246
2465
|
* <p>
|
|
2247
|
-
* <code>arn
|
|
2466
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dashboard/$\{DashboardId\}</code>
|
|
2248
2467
|
* </p>
|
|
2249
2468
|
*/
|
|
2250
2469
|
dashboardArn: string | undefined;
|
|
2251
2470
|
}
|
|
2252
2471
|
/**
|
|
2472
|
+
* @public
|
|
2253
2473
|
* <p>Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass,
|
|
2254
2474
|
* you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass
|
|
2255
2475
|
* group must also have permissions to upload data 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
|
|
@@ -2264,6 +2484,7 @@ export interface Greengrass {
|
|
|
2264
2484
|
groupArn: string | undefined;
|
|
2265
2485
|
}
|
|
2266
2486
|
/**
|
|
2487
|
+
* @public
|
|
2267
2488
|
* <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass
|
|
2268
2489
|
* V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass
|
|
2269
2490
|
* device role</a> must use the <code>AWSIoTSiteWiseEdgeAccess</code> policy. For more
|
|
@@ -2277,6 +2498,7 @@ export interface GreengrassV2 {
|
|
|
2277
2498
|
coreDeviceThingName: string | undefined;
|
|
2278
2499
|
}
|
|
2279
2500
|
/**
|
|
2501
|
+
* @public
|
|
2280
2502
|
* <p>Contains a gateway's platform information.</p>
|
|
2281
2503
|
*/
|
|
2282
2504
|
export interface GatewayPlatform {
|
|
@@ -2289,6 +2511,9 @@ export interface GatewayPlatform {
|
|
|
2289
2511
|
*/
|
|
2290
2512
|
greengrassV2?: GreengrassV2;
|
|
2291
2513
|
}
|
|
2514
|
+
/**
|
|
2515
|
+
* @public
|
|
2516
|
+
*/
|
|
2292
2517
|
export interface CreateGatewayRequest {
|
|
2293
2518
|
/**
|
|
2294
2519
|
* <p>A unique, friendly name for the gateway.</p>
|
|
@@ -2305,6 +2530,9 @@ export interface CreateGatewayRequest {
|
|
|
2305
2530
|
*/
|
|
2306
2531
|
tags?: Record<string, string>;
|
|
2307
2532
|
}
|
|
2533
|
+
/**
|
|
2534
|
+
* @public
|
|
2535
|
+
*/
|
|
2308
2536
|
export interface CreateGatewayResponse {
|
|
2309
2537
|
/**
|
|
2310
2538
|
* <p>The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.</p>
|
|
@@ -2313,15 +2541,19 @@ export interface CreateGatewayResponse {
|
|
|
2313
2541
|
/**
|
|
2314
2542
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p>
|
|
2315
2543
|
* <p>
|
|
2316
|
-
* <code>arn
|
|
2544
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:gateway/$\{GatewayId\}</code>
|
|
2317
2545
|
* </p>
|
|
2318
2546
|
*/
|
|
2319
2547
|
gatewayArn: string | undefined;
|
|
2320
2548
|
}
|
|
2549
|
+
/**
|
|
2550
|
+
* @public
|
|
2551
|
+
*/
|
|
2321
2552
|
export declare enum ImageFileType {
|
|
2322
2553
|
PNG = "PNG"
|
|
2323
2554
|
}
|
|
2324
2555
|
/**
|
|
2556
|
+
* @public
|
|
2325
2557
|
* <p>Contains an image file.</p>
|
|
2326
2558
|
*/
|
|
2327
2559
|
export interface ImageFile {
|
|
@@ -2335,6 +2567,9 @@ export interface ImageFile {
|
|
|
2335
2567
|
*/
|
|
2336
2568
|
type: ImageFileType | string | undefined;
|
|
2337
2569
|
}
|
|
2570
|
+
/**
|
|
2571
|
+
* @public
|
|
2572
|
+
*/
|
|
2338
2573
|
export interface CreatePortalRequest {
|
|
2339
2574
|
/**
|
|
2340
2575
|
* <p>A friendly name for the portal.</p>
|
|
@@ -2408,12 +2643,16 @@ export interface CreatePortalRequest {
|
|
|
2408
2643
|
*/
|
|
2409
2644
|
alarms?: Alarms;
|
|
2410
2645
|
}
|
|
2646
|
+
/**
|
|
2647
|
+
* @public
|
|
2648
|
+
*/
|
|
2411
2649
|
export declare enum MonitorErrorCode {
|
|
2412
2650
|
INTERNAL_FAILURE = "INTERNAL_FAILURE",
|
|
2413
2651
|
LIMIT_EXCEEDED = "LIMIT_EXCEEDED",
|
|
2414
2652
|
VALIDATION_ERROR = "VALIDATION_ERROR"
|
|
2415
2653
|
}
|
|
2416
2654
|
/**
|
|
2655
|
+
* @public
|
|
2417
2656
|
* <p>Contains IoT SiteWise Monitor error details.</p>
|
|
2418
2657
|
*/
|
|
2419
2658
|
export interface MonitorErrorDetails {
|
|
@@ -2426,6 +2665,9 @@ export interface MonitorErrorDetails {
|
|
|
2426
2665
|
*/
|
|
2427
2666
|
message?: string;
|
|
2428
2667
|
}
|
|
2668
|
+
/**
|
|
2669
|
+
* @public
|
|
2670
|
+
*/
|
|
2429
2671
|
export declare enum PortalState {
|
|
2430
2672
|
ACTIVE = "ACTIVE",
|
|
2431
2673
|
CREATING = "CREATING",
|
|
@@ -2434,6 +2676,7 @@ export declare enum PortalState {
|
|
|
2434
2676
|
UPDATING = "UPDATING"
|
|
2435
2677
|
}
|
|
2436
2678
|
/**
|
|
2679
|
+
* @public
|
|
2437
2680
|
* <p>Contains information about the current status of a portal.</p>
|
|
2438
2681
|
*/
|
|
2439
2682
|
export interface PortalStatus {
|
|
@@ -2446,6 +2689,9 @@ export interface PortalStatus {
|
|
|
2446
2689
|
*/
|
|
2447
2690
|
error?: MonitorErrorDetails;
|
|
2448
2691
|
}
|
|
2692
|
+
/**
|
|
2693
|
+
* @public
|
|
2694
|
+
*/
|
|
2449
2695
|
export interface CreatePortalResponse {
|
|
2450
2696
|
/**
|
|
2451
2697
|
* <p>The ID of the created portal.</p>
|
|
@@ -2454,7 +2700,7 @@ export interface CreatePortalResponse {
|
|
|
2454
2700
|
/**
|
|
2455
2701
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the portal, which has the following format.</p>
|
|
2456
2702
|
* <p>
|
|
2457
|
-
* <code>arn
|
|
2703
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:portal/$\{PortalId\}</code>
|
|
2458
2704
|
* </p>
|
|
2459
2705
|
*/
|
|
2460
2706
|
portalArn: string | undefined;
|
|
@@ -2474,6 +2720,9 @@ export interface CreatePortalResponse {
|
|
|
2474
2720
|
*/
|
|
2475
2721
|
ssoApplicationId: string | undefined;
|
|
2476
2722
|
}
|
|
2723
|
+
/**
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2477
2726
|
export interface CreateProjectRequest {
|
|
2478
2727
|
/**
|
|
2479
2728
|
* <p>The ID of the portal in which to create the project.</p>
|
|
@@ -2498,6 +2747,9 @@ export interface CreateProjectRequest {
|
|
|
2498
2747
|
*/
|
|
2499
2748
|
tags?: Record<string, string>;
|
|
2500
2749
|
}
|
|
2750
|
+
/**
|
|
2751
|
+
* @public
|
|
2752
|
+
*/
|
|
2501
2753
|
export interface CreateProjectResponse {
|
|
2502
2754
|
/**
|
|
2503
2755
|
* <p>The ID of the project.</p>
|
|
@@ -2506,11 +2758,14 @@ export interface CreateProjectResponse {
|
|
|
2506
2758
|
/**
|
|
2507
2759
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the project, which has the following format.</p>
|
|
2508
2760
|
* <p>
|
|
2509
|
-
* <code>arn
|
|
2761
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:project/$\{ProjectId\}</code>
|
|
2510
2762
|
* </p>
|
|
2511
2763
|
*/
|
|
2512
2764
|
projectArn: string | undefined;
|
|
2513
2765
|
}
|
|
2766
|
+
/**
|
|
2767
|
+
* @public
|
|
2768
|
+
*/
|
|
2514
2769
|
export interface DeleteAccessPolicyRequest {
|
|
2515
2770
|
/**
|
|
2516
2771
|
* <p>The ID of the access policy to be deleted.</p>
|
|
@@ -2521,8 +2776,14 @@ export interface DeleteAccessPolicyRequest {
|
|
|
2521
2776
|
*/
|
|
2522
2777
|
clientToken?: string;
|
|
2523
2778
|
}
|
|
2779
|
+
/**
|
|
2780
|
+
* @public
|
|
2781
|
+
*/
|
|
2524
2782
|
export interface DeleteAccessPolicyResponse {
|
|
2525
2783
|
}
|
|
2784
|
+
/**
|
|
2785
|
+
* @public
|
|
2786
|
+
*/
|
|
2526
2787
|
export interface DeleteAssetRequest {
|
|
2527
2788
|
/**
|
|
2528
2789
|
* <p>The ID of the asset to delete.</p>
|
|
@@ -2533,6 +2794,9 @@ export interface DeleteAssetRequest {
|
|
|
2533
2794
|
*/
|
|
2534
2795
|
clientToken?: string;
|
|
2535
2796
|
}
|
|
2797
|
+
/**
|
|
2798
|
+
* @public
|
|
2799
|
+
*/
|
|
2536
2800
|
export interface DeleteAssetResponse {
|
|
2537
2801
|
/**
|
|
2538
2802
|
* <p>The status of the asset, which contains a state (<code>DELETING</code> after successfully
|
|
@@ -2540,6 +2804,9 @@ export interface DeleteAssetResponse {
|
|
|
2540
2804
|
*/
|
|
2541
2805
|
assetStatus: AssetStatus | undefined;
|
|
2542
2806
|
}
|
|
2807
|
+
/**
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2543
2810
|
export interface DeleteAssetModelRequest {
|
|
2544
2811
|
/**
|
|
2545
2812
|
* <p>The ID of the asset model to delete.</p>
|
|
@@ -2550,6 +2817,9 @@ export interface DeleteAssetModelRequest {
|
|
|
2550
2817
|
*/
|
|
2551
2818
|
clientToken?: string;
|
|
2552
2819
|
}
|
|
2820
|
+
/**
|
|
2821
|
+
* @public
|
|
2822
|
+
*/
|
|
2553
2823
|
export interface DeleteAssetModelResponse {
|
|
2554
2824
|
/**
|
|
2555
2825
|
* <p>The status of the asset model, which contains a state (<code>DELETING</code> after
|
|
@@ -2557,6 +2827,9 @@ export interface DeleteAssetModelResponse {
|
|
|
2557
2827
|
*/
|
|
2558
2828
|
assetModelStatus: AssetModelStatus | undefined;
|
|
2559
2829
|
}
|
|
2830
|
+
/**
|
|
2831
|
+
* @public
|
|
2832
|
+
*/
|
|
2560
2833
|
export interface DeleteDashboardRequest {
|
|
2561
2834
|
/**
|
|
2562
2835
|
* <p>The ID of the dashboard to delete.</p>
|
|
@@ -2567,14 +2840,23 @@ export interface DeleteDashboardRequest {
|
|
|
2567
2840
|
*/
|
|
2568
2841
|
clientToken?: string;
|
|
2569
2842
|
}
|
|
2843
|
+
/**
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2570
2846
|
export interface DeleteDashboardResponse {
|
|
2571
2847
|
}
|
|
2848
|
+
/**
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2572
2851
|
export interface DeleteGatewayRequest {
|
|
2573
2852
|
/**
|
|
2574
2853
|
* <p>The ID of the gateway to delete.</p>
|
|
2575
2854
|
*/
|
|
2576
2855
|
gatewayId: string | undefined;
|
|
2577
2856
|
}
|
|
2857
|
+
/**
|
|
2858
|
+
* @public
|
|
2859
|
+
*/
|
|
2578
2860
|
export interface DeletePortalRequest {
|
|
2579
2861
|
/**
|
|
2580
2862
|
* <p>The ID of the portal to delete.</p>
|
|
@@ -2585,6 +2867,9 @@ export interface DeletePortalRequest {
|
|
|
2585
2867
|
*/
|
|
2586
2868
|
clientToken?: string;
|
|
2587
2869
|
}
|
|
2870
|
+
/**
|
|
2871
|
+
* @public
|
|
2872
|
+
*/
|
|
2588
2873
|
export interface DeletePortalResponse {
|
|
2589
2874
|
/**
|
|
2590
2875
|
* <p>The status of the portal, which contains a state (<code>DELETING</code> after successfully
|
|
@@ -2592,6 +2877,9 @@ export interface DeletePortalResponse {
|
|
|
2592
2877
|
*/
|
|
2593
2878
|
portalStatus: PortalStatus | undefined;
|
|
2594
2879
|
}
|
|
2880
|
+
/**
|
|
2881
|
+
* @public
|
|
2882
|
+
*/
|
|
2595
2883
|
export interface DeleteProjectRequest {
|
|
2596
2884
|
/**
|
|
2597
2885
|
* <p>The ID of the project.</p>
|
|
@@ -2602,8 +2890,14 @@ export interface DeleteProjectRequest {
|
|
|
2602
2890
|
*/
|
|
2603
2891
|
clientToken?: string;
|
|
2604
2892
|
}
|
|
2893
|
+
/**
|
|
2894
|
+
* @public
|
|
2895
|
+
*/
|
|
2605
2896
|
export interface DeleteProjectResponse {
|
|
2606
2897
|
}
|
|
2898
|
+
/**
|
|
2899
|
+
* @public
|
|
2900
|
+
*/
|
|
2607
2901
|
export interface DeleteTimeSeriesRequest {
|
|
2608
2902
|
/**
|
|
2609
2903
|
* <p>The alias that identifies the time series.</p>
|
|
@@ -2622,12 +2916,18 @@ export interface DeleteTimeSeriesRequest {
|
|
|
2622
2916
|
*/
|
|
2623
2917
|
clientToken?: string;
|
|
2624
2918
|
}
|
|
2919
|
+
/**
|
|
2920
|
+
* @public
|
|
2921
|
+
*/
|
|
2625
2922
|
export interface DescribeAccessPolicyRequest {
|
|
2626
2923
|
/**
|
|
2627
2924
|
* <p>The ID of the access policy.</p>
|
|
2628
2925
|
*/
|
|
2629
2926
|
accessPolicyId: string | undefined;
|
|
2630
2927
|
}
|
|
2928
|
+
/**
|
|
2929
|
+
* @public
|
|
2930
|
+
*/
|
|
2631
2931
|
export interface DescribeAccessPolicyResponse {
|
|
2632
2932
|
/**
|
|
2633
2933
|
* <p>The ID of the access policy.</p>
|
|
@@ -2636,7 +2936,7 @@ export interface DescribeAccessPolicyResponse {
|
|
|
2636
2936
|
/**
|
|
2637
2937
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the access policy, which has the following format.</p>
|
|
2638
2938
|
* <p>
|
|
2639
|
-
* <code>arn
|
|
2939
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:access-policy/$\{AccessPolicyId\}</code>
|
|
2640
2940
|
* </p>
|
|
2641
2941
|
*/
|
|
2642
2942
|
accessPolicyArn: string | undefined;
|
|
@@ -2664,6 +2964,9 @@ export interface DescribeAccessPolicyResponse {
|
|
|
2664
2964
|
*/
|
|
2665
2965
|
accessPolicyLastUpdateDate: Date | undefined;
|
|
2666
2966
|
}
|
|
2967
|
+
/**
|
|
2968
|
+
* @public
|
|
2969
|
+
*/
|
|
2667
2970
|
export interface DescribeAssetRequest {
|
|
2668
2971
|
/**
|
|
2669
2972
|
* <p>The ID of the asset.</p>
|
|
@@ -2676,6 +2979,9 @@ export interface DescribeAssetRequest {
|
|
|
2676
2979
|
*/
|
|
2677
2980
|
excludeProperties?: boolean;
|
|
2678
2981
|
}
|
|
2982
|
+
/**
|
|
2983
|
+
* @public
|
|
2984
|
+
*/
|
|
2679
2985
|
export interface DescribeAssetResponse {
|
|
2680
2986
|
/**
|
|
2681
2987
|
* <p>The ID of the asset.</p>
|
|
@@ -2684,7 +2990,7 @@ export interface DescribeAssetResponse {
|
|
|
2684
2990
|
/**
|
|
2685
2991
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset, which has the following format.</p>
|
|
2686
2992
|
* <p>
|
|
2687
|
-
* <code>arn
|
|
2993
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset/$\{AssetId\}</code>
|
|
2688
2994
|
* </p>
|
|
2689
2995
|
*/
|
|
2690
2996
|
assetArn: string | undefined;
|
|
@@ -2727,6 +3033,9 @@ export interface DescribeAssetResponse {
|
|
|
2727
3033
|
*/
|
|
2728
3034
|
assetDescription?: string;
|
|
2729
3035
|
}
|
|
3036
|
+
/**
|
|
3037
|
+
* @public
|
|
3038
|
+
*/
|
|
2730
3039
|
export interface DescribeAssetModelRequest {
|
|
2731
3040
|
/**
|
|
2732
3041
|
* <p>The ID of the asset model.</p>
|
|
@@ -2739,6 +3048,9 @@ export interface DescribeAssetModelRequest {
|
|
|
2739
3048
|
*/
|
|
2740
3049
|
excludeProperties?: boolean;
|
|
2741
3050
|
}
|
|
3051
|
+
/**
|
|
3052
|
+
* @public
|
|
3053
|
+
*/
|
|
2742
3054
|
export interface DescribeAssetModelResponse {
|
|
2743
3055
|
/**
|
|
2744
3056
|
* <p>The ID of the asset model.</p>
|
|
@@ -2747,7 +3059,7 @@ export interface DescribeAssetModelResponse {
|
|
|
2747
3059
|
/**
|
|
2748
3060
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the asset model, which has the following format.</p>
|
|
2749
3061
|
* <p>
|
|
2750
|
-
* <code>arn
|
|
3062
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:asset-model/$\{AssetModelId\}</code>
|
|
2751
3063
|
* </p>
|
|
2752
3064
|
*/
|
|
2753
3065
|
assetModelArn: string | undefined;
|
|
@@ -2789,6 +3101,9 @@ export interface DescribeAssetModelResponse {
|
|
|
2789
3101
|
*/
|
|
2790
3102
|
assetModelStatus: AssetModelStatus | undefined;
|
|
2791
3103
|
}
|
|
3104
|
+
/**
|
|
3105
|
+
* @public
|
|
3106
|
+
*/
|
|
2792
3107
|
export interface DescribeAssetPropertyRequest {
|
|
2793
3108
|
/**
|
|
2794
3109
|
* <p>The ID of the asset.</p>
|
|
@@ -2800,6 +3115,7 @@ export interface DescribeAssetPropertyRequest {
|
|
|
2800
3115
|
propertyId: string | undefined;
|
|
2801
3116
|
}
|
|
2802
3117
|
/**
|
|
3118
|
+
* @public
|
|
2803
3119
|
* <p>Contains asset property information.</p>
|
|
2804
3120
|
*/
|
|
2805
3121
|
export interface Property {
|
|
@@ -2836,6 +3152,7 @@ export interface Property {
|
|
|
2836
3152
|
type?: PropertyType;
|
|
2837
3153
|
}
|
|
2838
3154
|
/**
|
|
3155
|
+
* @public
|
|
2839
3156
|
* <p>Contains information about a composite model property on an asset.</p>
|
|
2840
3157
|
*/
|
|
2841
3158
|
export interface CompositeModelProperty {
|
|
@@ -2858,6 +3175,9 @@ export interface CompositeModelProperty {
|
|
|
2858
3175
|
*/
|
|
2859
3176
|
id?: string;
|
|
2860
3177
|
}
|
|
3178
|
+
/**
|
|
3179
|
+
* @public
|
|
3180
|
+
*/
|
|
2861
3181
|
export interface DescribeAssetPropertyResponse {
|
|
2862
3182
|
/**
|
|
2863
3183
|
* <p>The ID of the asset.</p>
|
|
@@ -2884,12 +3204,18 @@ export interface DescribeAssetPropertyResponse {
|
|
|
2884
3204
|
*/
|
|
2885
3205
|
compositeModel?: CompositeModelProperty;
|
|
2886
3206
|
}
|
|
3207
|
+
/**
|
|
3208
|
+
* @public
|
|
3209
|
+
*/
|
|
2887
3210
|
export interface DescribeBulkImportJobRequest {
|
|
2888
3211
|
/**
|
|
2889
3212
|
* <p>The ID of the job.</p>
|
|
2890
3213
|
*/
|
|
2891
3214
|
jobId: string | undefined;
|
|
2892
3215
|
}
|
|
3216
|
+
/**
|
|
3217
|
+
* @public
|
|
3218
|
+
*/
|
|
2893
3219
|
export interface DescribeBulkImportJobResponse {
|
|
2894
3220
|
/**
|
|
2895
3221
|
* <p>The ID of the job.</p>
|
|
@@ -2956,12 +3282,18 @@ export interface DescribeBulkImportJobResponse {
|
|
|
2956
3282
|
*/
|
|
2957
3283
|
jobLastUpdateDate: Date | undefined;
|
|
2958
3284
|
}
|
|
3285
|
+
/**
|
|
3286
|
+
* @public
|
|
3287
|
+
*/
|
|
2959
3288
|
export interface DescribeDashboardRequest {
|
|
2960
3289
|
/**
|
|
2961
3290
|
* <p>The ID of the dashboard.</p>
|
|
2962
3291
|
*/
|
|
2963
3292
|
dashboardId: string | undefined;
|
|
2964
3293
|
}
|
|
3294
|
+
/**
|
|
3295
|
+
* @public
|
|
3296
|
+
*/
|
|
2965
3297
|
export interface DescribeDashboardResponse {
|
|
2966
3298
|
/**
|
|
2967
3299
|
* <p>The ID of the dashboard.</p>
|
|
@@ -2970,7 +3302,7 @@ export interface DescribeDashboardResponse {
|
|
|
2970
3302
|
/**
|
|
2971
3303
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
|
|
2972
3304
|
* <p>
|
|
2973
|
-
* <code>arn
|
|
3305
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dashboard/$\{DashboardId\}</code>
|
|
2974
3306
|
* </p>
|
|
2975
3307
|
*/
|
|
2976
3308
|
dashboardArn: string | undefined;
|
|
@@ -3000,9 +3332,13 @@ export interface DescribeDashboardResponse {
|
|
|
3000
3332
|
*/
|
|
3001
3333
|
dashboardLastUpdateDate: Date | undefined;
|
|
3002
3334
|
}
|
|
3335
|
+
/**
|
|
3336
|
+
* @public
|
|
3337
|
+
*/
|
|
3003
3338
|
export interface DescribeDefaultEncryptionConfigurationRequest {
|
|
3004
3339
|
}
|
|
3005
3340
|
/**
|
|
3341
|
+
* @public
|
|
3006
3342
|
* <p>Contains the details of an IoT SiteWise configuration error.</p>
|
|
3007
3343
|
*/
|
|
3008
3344
|
export interface ConfigurationErrorDetails {
|
|
@@ -3015,12 +3351,16 @@ export interface ConfigurationErrorDetails {
|
|
|
3015
3351
|
*/
|
|
3016
3352
|
message: string | undefined;
|
|
3017
3353
|
}
|
|
3354
|
+
/**
|
|
3355
|
+
* @public
|
|
3356
|
+
*/
|
|
3018
3357
|
export declare enum ConfigurationState {
|
|
3019
3358
|
ACTIVE = "ACTIVE",
|
|
3020
3359
|
UPDATE_FAILED = "UPDATE_FAILED",
|
|
3021
3360
|
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
|
|
3022
3361
|
}
|
|
3023
3362
|
/**
|
|
3363
|
+
* @public
|
|
3024
3364
|
* <p>Contains current status information for the configuration.</p>
|
|
3025
3365
|
*/
|
|
3026
3366
|
export interface ConfigurationStatus {
|
|
@@ -3033,10 +3373,16 @@ export interface ConfigurationStatus {
|
|
|
3033
3373
|
*/
|
|
3034
3374
|
error?: ConfigurationErrorDetails;
|
|
3035
3375
|
}
|
|
3376
|
+
/**
|
|
3377
|
+
* @public
|
|
3378
|
+
*/
|
|
3036
3379
|
export declare enum EncryptionType {
|
|
3037
3380
|
KMS_BASED_ENCRYPTION = "KMS_BASED_ENCRYPTION",
|
|
3038
3381
|
SITEWISE_DEFAULT_ENCRYPTION = "SITEWISE_DEFAULT_ENCRYPTION"
|
|
3039
3382
|
}
|
|
3383
|
+
/**
|
|
3384
|
+
* @public
|
|
3385
|
+
*/
|
|
3040
3386
|
export interface DescribeDefaultEncryptionConfigurationResponse {
|
|
3041
3387
|
/**
|
|
3042
3388
|
* <p>The type of encryption used for the encryption configuration.</p>
|
|
@@ -3054,12 +3400,18 @@ export interface DescribeDefaultEncryptionConfigurationResponse {
|
|
|
3054
3400
|
*/
|
|
3055
3401
|
configurationStatus: ConfigurationStatus | undefined;
|
|
3056
3402
|
}
|
|
3403
|
+
/**
|
|
3404
|
+
* @public
|
|
3405
|
+
*/
|
|
3057
3406
|
export interface DescribeGatewayRequest {
|
|
3058
3407
|
/**
|
|
3059
3408
|
* <p>The ID of the gateway device.</p>
|
|
3060
3409
|
*/
|
|
3061
3410
|
gatewayId: string | undefined;
|
|
3062
3411
|
}
|
|
3412
|
+
/**
|
|
3413
|
+
* @public
|
|
3414
|
+
*/
|
|
3063
3415
|
export declare enum CapabilitySyncStatus {
|
|
3064
3416
|
IN_SYNC = "IN_SYNC",
|
|
3065
3417
|
OUT_OF_SYNC = "OUT_OF_SYNC",
|
|
@@ -3067,6 +3419,7 @@ export declare enum CapabilitySyncStatus {
|
|
|
3067
3419
|
UNKNOWN = "UNKNOWN"
|
|
3068
3420
|
}
|
|
3069
3421
|
/**
|
|
3422
|
+
* @public
|
|
3070
3423
|
* <p>Contains a summary of a gateway capability configuration.</p>
|
|
3071
3424
|
*/
|
|
3072
3425
|
export interface GatewayCapabilitySummary {
|
|
@@ -3097,6 +3450,9 @@ export interface GatewayCapabilitySummary {
|
|
|
3097
3450
|
*/
|
|
3098
3451
|
capabilitySyncStatus: CapabilitySyncStatus | string | undefined;
|
|
3099
3452
|
}
|
|
3453
|
+
/**
|
|
3454
|
+
* @public
|
|
3455
|
+
*/
|
|
3100
3456
|
export interface DescribeGatewayResponse {
|
|
3101
3457
|
/**
|
|
3102
3458
|
* <p>The ID of the gateway device.</p>
|
|
@@ -3109,7 +3465,7 @@ export interface DescribeGatewayResponse {
|
|
|
3109
3465
|
/**
|
|
3110
3466
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p>
|
|
3111
3467
|
* <p>
|
|
3112
|
-
* <code>arn
|
|
3468
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:gateway/$\{GatewayId\}</code>
|
|
3113
3469
|
* </p>
|
|
3114
3470
|
*/
|
|
3115
3471
|
gatewayArn: string | undefined;
|
|
@@ -3132,6 +3488,9 @@ export interface DescribeGatewayResponse {
|
|
|
3132
3488
|
*/
|
|
3133
3489
|
lastUpdateDate: Date | undefined;
|
|
3134
3490
|
}
|
|
3491
|
+
/**
|
|
3492
|
+
* @public
|
|
3493
|
+
*/
|
|
3135
3494
|
export interface DescribeGatewayCapabilityConfigurationRequest {
|
|
3136
3495
|
/**
|
|
3137
3496
|
* <p>The ID of the gateway that defines the capability configuration.</p>
|
|
@@ -3146,6 +3505,9 @@ export interface DescribeGatewayCapabilityConfigurationRequest {
|
|
|
3146
3505
|
*/
|
|
3147
3506
|
capabilityNamespace: string | undefined;
|
|
3148
3507
|
}
|
|
3508
|
+
/**
|
|
3509
|
+
* @public
|
|
3510
|
+
*/
|
|
3149
3511
|
export interface DescribeGatewayCapabilityConfigurationResponse {
|
|
3150
3512
|
/**
|
|
3151
3513
|
* <p>The ID of the gateway that defines the capability configuration.</p>
|
|
@@ -3179,14 +3541,21 @@ export interface DescribeGatewayCapabilityConfigurationResponse {
|
|
|
3179
3541
|
*/
|
|
3180
3542
|
capabilitySyncStatus: CapabilitySyncStatus | string | undefined;
|
|
3181
3543
|
}
|
|
3544
|
+
/**
|
|
3545
|
+
* @public
|
|
3546
|
+
*/
|
|
3182
3547
|
export interface DescribeLoggingOptionsRequest {
|
|
3183
3548
|
}
|
|
3549
|
+
/**
|
|
3550
|
+
* @public
|
|
3551
|
+
*/
|
|
3184
3552
|
export declare enum LoggingLevel {
|
|
3185
3553
|
ERROR = "ERROR",
|
|
3186
3554
|
INFO = "INFO",
|
|
3187
3555
|
OFF = "OFF"
|
|
3188
3556
|
}
|
|
3189
3557
|
/**
|
|
3558
|
+
* @public
|
|
3190
3559
|
* <p>Contains logging options.</p>
|
|
3191
3560
|
*/
|
|
3192
3561
|
export interface LoggingOptions {
|
|
@@ -3195,12 +3564,18 @@ export interface LoggingOptions {
|
|
|
3195
3564
|
*/
|
|
3196
3565
|
level: LoggingLevel | string | undefined;
|
|
3197
3566
|
}
|
|
3567
|
+
/**
|
|
3568
|
+
* @public
|
|
3569
|
+
*/
|
|
3198
3570
|
export interface DescribeLoggingOptionsResponse {
|
|
3199
3571
|
/**
|
|
3200
3572
|
* <p>The current logging options.</p>
|
|
3201
3573
|
*/
|
|
3202
3574
|
loggingOptions: LoggingOptions | undefined;
|
|
3203
3575
|
}
|
|
3576
|
+
/**
|
|
3577
|
+
* @public
|
|
3578
|
+
*/
|
|
3204
3579
|
export interface DescribePortalRequest {
|
|
3205
3580
|
/**
|
|
3206
3581
|
* <p>The ID of the portal.</p>
|
|
@@ -3208,6 +3583,7 @@ export interface DescribePortalRequest {
|
|
|
3208
3583
|
portalId: string | undefined;
|
|
3209
3584
|
}
|
|
3210
3585
|
/**
|
|
3586
|
+
* @public
|
|
3211
3587
|
* <p>Contains an image that is uploaded to IoT SiteWise and available at a URL.</p>
|
|
3212
3588
|
*/
|
|
3213
3589
|
export interface ImageLocation {
|
|
@@ -3221,6 +3597,9 @@ export interface ImageLocation {
|
|
|
3221
3597
|
*/
|
|
3222
3598
|
url: string | undefined;
|
|
3223
3599
|
}
|
|
3600
|
+
/**
|
|
3601
|
+
* @public
|
|
3602
|
+
*/
|
|
3224
3603
|
export interface DescribePortalResponse {
|
|
3225
3604
|
/**
|
|
3226
3605
|
* <p>The ID of the portal.</p>
|
|
@@ -3229,7 +3608,7 @@ export interface DescribePortalResponse {
|
|
|
3229
3608
|
/**
|
|
3230
3609
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the portal, which has the following format.</p>
|
|
3231
3610
|
* <p>
|
|
3232
|
-
* <code>arn
|
|
3611
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:portal/$\{PortalId\}</code>
|
|
3233
3612
|
* </p>
|
|
3234
3613
|
*/
|
|
3235
3614
|
portalArn: string | undefined;
|
|
@@ -3291,12 +3670,18 @@ export interface DescribePortalResponse {
|
|
|
3291
3670
|
*/
|
|
3292
3671
|
alarms?: Alarms;
|
|
3293
3672
|
}
|
|
3673
|
+
/**
|
|
3674
|
+
* @public
|
|
3675
|
+
*/
|
|
3294
3676
|
export interface DescribeProjectRequest {
|
|
3295
3677
|
/**
|
|
3296
3678
|
* <p>The ID of the project.</p>
|
|
3297
3679
|
*/
|
|
3298
3680
|
projectId: string | undefined;
|
|
3299
3681
|
}
|
|
3682
|
+
/**
|
|
3683
|
+
* @public
|
|
3684
|
+
*/
|
|
3300
3685
|
export interface DescribeProjectResponse {
|
|
3301
3686
|
/**
|
|
3302
3687
|
* <p>The ID of the project.</p>
|
|
@@ -3305,7 +3690,7 @@ export interface DescribeProjectResponse {
|
|
|
3305
3690
|
/**
|
|
3306
3691
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the project, which has the following format.</p>
|
|
3307
3692
|
* <p>
|
|
3308
|
-
* <code>arn
|
|
3693
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:project/$\{ProjectId\}</code>
|
|
3309
3694
|
* </p>
|
|
3310
3695
|
*/
|
|
3311
3696
|
projectArn: string | undefined;
|
|
@@ -3330,13 +3715,20 @@ export interface DescribeProjectResponse {
|
|
|
3330
3715
|
*/
|
|
3331
3716
|
projectLastUpdateDate: Date | undefined;
|
|
3332
3717
|
}
|
|
3718
|
+
/**
|
|
3719
|
+
* @public
|
|
3720
|
+
*/
|
|
3333
3721
|
export interface DescribeStorageConfigurationRequest {
|
|
3334
3722
|
}
|
|
3723
|
+
/**
|
|
3724
|
+
* @public
|
|
3725
|
+
*/
|
|
3335
3726
|
export declare enum DisassociatedDataStorageState {
|
|
3336
3727
|
DISABLED = "DISABLED",
|
|
3337
3728
|
ENABLED = "ENABLED"
|
|
3338
3729
|
}
|
|
3339
3730
|
/**
|
|
3731
|
+
* @public
|
|
3340
3732
|
* <p>Contains information about a customer managed Amazon S3 bucket.</p>
|
|
3341
3733
|
*/
|
|
3342
3734
|
export interface CustomerManagedS3Storage {
|
|
@@ -3352,6 +3744,7 @@ export interface CustomerManagedS3Storage {
|
|
|
3352
3744
|
roleArn: string | undefined;
|
|
3353
3745
|
}
|
|
3354
3746
|
/**
|
|
3747
|
+
* @public
|
|
3355
3748
|
* <p>Contains information about the storage destination.</p>
|
|
3356
3749
|
*/
|
|
3357
3750
|
export interface MultiLayerStorage {
|
|
@@ -3361,6 +3754,7 @@ export interface MultiLayerStorage {
|
|
|
3361
3754
|
customerManagedS3Storage: CustomerManagedS3Storage | undefined;
|
|
3362
3755
|
}
|
|
3363
3756
|
/**
|
|
3757
|
+
* @public
|
|
3364
3758
|
* <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
3365
3759
|
*/
|
|
3366
3760
|
export interface RetentionPeriod {
|
|
@@ -3381,10 +3775,16 @@ export interface RetentionPeriod {
|
|
|
3381
3775
|
*/
|
|
3382
3776
|
unlimited?: boolean;
|
|
3383
3777
|
}
|
|
3778
|
+
/**
|
|
3779
|
+
* @public
|
|
3780
|
+
*/
|
|
3384
3781
|
export declare enum StorageType {
|
|
3385
3782
|
MULTI_LAYER_STORAGE = "MULTI_LAYER_STORAGE",
|
|
3386
3783
|
SITEWISE_DEFAULT_STORAGE = "SITEWISE_DEFAULT_STORAGE"
|
|
3387
3784
|
}
|
|
3785
|
+
/**
|
|
3786
|
+
* @public
|
|
3787
|
+
*/
|
|
3388
3788
|
export interface DescribeStorageConfigurationResponse {
|
|
3389
3789
|
/**
|
|
3390
3790
|
* <p>The storage tier that you specified for your data.
|
|
@@ -3440,6 +3840,9 @@ export interface DescribeStorageConfigurationResponse {
|
|
|
3440
3840
|
*/
|
|
3441
3841
|
lastUpdateDate?: Date;
|
|
3442
3842
|
}
|
|
3843
|
+
/**
|
|
3844
|
+
* @public
|
|
3845
|
+
*/
|
|
3443
3846
|
export interface DescribeTimeSeriesRequest {
|
|
3444
3847
|
/**
|
|
3445
3848
|
* <p>The alias that identifies the time series.</p>
|
|
@@ -3454,6 +3857,9 @@ export interface DescribeTimeSeriesRequest {
|
|
|
3454
3857
|
*/
|
|
3455
3858
|
propertyId?: string;
|
|
3456
3859
|
}
|
|
3860
|
+
/**
|
|
3861
|
+
* @public
|
|
3862
|
+
*/
|
|
3457
3863
|
export interface DescribeTimeSeriesResponse {
|
|
3458
3864
|
/**
|
|
3459
3865
|
* <p>The ID of the asset in which the asset property was created.</p>
|
|
@@ -3495,11 +3901,14 @@ export interface DescribeTimeSeriesResponse {
|
|
|
3495
3901
|
/**
|
|
3496
3902
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p>
|
|
3497
3903
|
* <p>
|
|
3498
|
-
* <code>arn
|
|
3904
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}</code>
|
|
3499
3905
|
* </p>
|
|
3500
3906
|
*/
|
|
3501
3907
|
timeSeriesArn: string | undefined;
|
|
3502
3908
|
}
|
|
3909
|
+
/**
|
|
3910
|
+
* @public
|
|
3911
|
+
*/
|
|
3503
3912
|
export interface DisassociateAssetsRequest {
|
|
3504
3913
|
/**
|
|
3505
3914
|
* <p>The ID of the parent asset from which to disassociate the child asset.</p>
|
|
@@ -3521,6 +3930,9 @@ export interface DisassociateAssetsRequest {
|
|
|
3521
3930
|
*/
|
|
3522
3931
|
clientToken?: string;
|
|
3523
3932
|
}
|
|
3933
|
+
/**
|
|
3934
|
+
* @public
|
|
3935
|
+
*/
|
|
3524
3936
|
export interface DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
3525
3937
|
/**
|
|
3526
3938
|
* <p>The alias that identifies the time series.</p>
|
|
@@ -3539,6 +3951,9 @@ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
|
3539
3951
|
*/
|
|
3540
3952
|
clientToken?: string;
|
|
3541
3953
|
}
|
|
3954
|
+
/**
|
|
3955
|
+
* @public
|
|
3956
|
+
*/
|
|
3542
3957
|
export interface GetAssetPropertyAggregatesRequest {
|
|
3543
3958
|
/**
|
|
3544
3959
|
* <p>The ID of the asset.</p>
|
|
@@ -3591,6 +4006,9 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
3591
4006
|
*/
|
|
3592
4007
|
maxResults?: number;
|
|
3593
4008
|
}
|
|
4009
|
+
/**
|
|
4010
|
+
* @public
|
|
4011
|
+
*/
|
|
3594
4012
|
export interface GetAssetPropertyAggregatesResponse {
|
|
3595
4013
|
/**
|
|
3596
4014
|
* <p>The requested aggregated values.</p>
|
|
@@ -3601,6 +4019,9 @@ export interface GetAssetPropertyAggregatesResponse {
|
|
|
3601
4019
|
*/
|
|
3602
4020
|
nextToken?: string;
|
|
3603
4021
|
}
|
|
4022
|
+
/**
|
|
4023
|
+
* @public
|
|
4024
|
+
*/
|
|
3604
4025
|
export interface GetAssetPropertyValueRequest {
|
|
3605
4026
|
/**
|
|
3606
4027
|
* <p>The ID of the asset.</p>
|
|
@@ -3618,12 +4039,18 @@ export interface GetAssetPropertyValueRequest {
|
|
|
3618
4039
|
*/
|
|
3619
4040
|
propertyAlias?: string;
|
|
3620
4041
|
}
|
|
4042
|
+
/**
|
|
4043
|
+
* @public
|
|
4044
|
+
*/
|
|
3621
4045
|
export interface GetAssetPropertyValueResponse {
|
|
3622
4046
|
/**
|
|
3623
4047
|
* <p>The current asset property value.</p>
|
|
3624
4048
|
*/
|
|
3625
4049
|
propertyValue?: AssetPropertyValue;
|
|
3626
4050
|
}
|
|
4051
|
+
/**
|
|
4052
|
+
* @public
|
|
4053
|
+
*/
|
|
3627
4054
|
export interface GetAssetPropertyValueHistoryRequest {
|
|
3628
4055
|
/**
|
|
3629
4056
|
* <p>The ID of the asset.</p>
|
|
@@ -3668,6 +4095,9 @@ export interface GetAssetPropertyValueHistoryRequest {
|
|
|
3668
4095
|
*/
|
|
3669
4096
|
maxResults?: number;
|
|
3670
4097
|
}
|
|
4098
|
+
/**
|
|
4099
|
+
* @public
|
|
4100
|
+
*/
|
|
3671
4101
|
export interface GetAssetPropertyValueHistoryResponse {
|
|
3672
4102
|
/**
|
|
3673
4103
|
* <p>The asset property's value history.</p>
|
|
@@ -3678,6 +4108,9 @@ export interface GetAssetPropertyValueHistoryResponse {
|
|
|
3678
4108
|
*/
|
|
3679
4109
|
nextToken?: string;
|
|
3680
4110
|
}
|
|
4111
|
+
/**
|
|
4112
|
+
* @public
|
|
4113
|
+
*/
|
|
3681
4114
|
export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
3682
4115
|
/**
|
|
3683
4116
|
* <p>The ID of the asset.</p>
|
|
@@ -3789,6 +4222,7 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
3789
4222
|
intervalWindowInSeconds?: number;
|
|
3790
4223
|
}
|
|
3791
4224
|
/**
|
|
4225
|
+
* @public
|
|
3792
4226
|
* <p>Contains information about an interpolated asset property value.</p>
|
|
3793
4227
|
*/
|
|
3794
4228
|
export interface InterpolatedAssetPropertyValue {
|
|
@@ -3801,6 +4235,9 @@ export interface InterpolatedAssetPropertyValue {
|
|
|
3801
4235
|
*/
|
|
3802
4236
|
value: Variant | undefined;
|
|
3803
4237
|
}
|
|
4238
|
+
/**
|
|
4239
|
+
* @public
|
|
4240
|
+
*/
|
|
3804
4241
|
export interface GetInterpolatedAssetPropertyValuesResponse {
|
|
3805
4242
|
/**
|
|
3806
4243
|
* <p>The requested interpolated values.</p>
|
|
@@ -3811,15 +4248,24 @@ export interface GetInterpolatedAssetPropertyValuesResponse {
|
|
|
3811
4248
|
*/
|
|
3812
4249
|
nextToken?: string;
|
|
3813
4250
|
}
|
|
4251
|
+
/**
|
|
4252
|
+
* @public
|
|
4253
|
+
*/
|
|
3814
4254
|
export declare enum IdentityType {
|
|
3815
4255
|
GROUP = "GROUP",
|
|
3816
4256
|
IAM = "IAM",
|
|
3817
4257
|
USER = "USER"
|
|
3818
4258
|
}
|
|
4259
|
+
/**
|
|
4260
|
+
* @public
|
|
4261
|
+
*/
|
|
3819
4262
|
export declare enum ResourceType {
|
|
3820
4263
|
PORTAL = "PORTAL",
|
|
3821
4264
|
PROJECT = "PROJECT"
|
|
3822
4265
|
}
|
|
4266
|
+
/**
|
|
4267
|
+
* @public
|
|
4268
|
+
*/
|
|
3823
4269
|
export interface ListAccessPoliciesRequest {
|
|
3824
4270
|
/**
|
|
3825
4271
|
* <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
|
|
@@ -3857,6 +4303,9 @@ export interface ListAccessPoliciesRequest {
|
|
|
3857
4303
|
*/
|
|
3858
4304
|
maxResults?: number;
|
|
3859
4305
|
}
|
|
4306
|
+
/**
|
|
4307
|
+
* @public
|
|
4308
|
+
*/
|
|
3860
4309
|
export interface ListAccessPoliciesResponse {
|
|
3861
4310
|
/**
|
|
3862
4311
|
* <p>A list that summarizes each access policy.</p>
|
|
@@ -3867,10 +4316,16 @@ export interface ListAccessPoliciesResponse {
|
|
|
3867
4316
|
*/
|
|
3868
4317
|
nextToken?: string;
|
|
3869
4318
|
}
|
|
4319
|
+
/**
|
|
4320
|
+
* @public
|
|
4321
|
+
*/
|
|
3870
4322
|
export declare enum ListAssetModelPropertiesFilter {
|
|
3871
4323
|
ALL = "ALL",
|
|
3872
4324
|
BASE = "BASE"
|
|
3873
4325
|
}
|
|
4326
|
+
/**
|
|
4327
|
+
* @public
|
|
4328
|
+
*/
|
|
3874
4329
|
export interface ListAssetModelPropertiesRequest {
|
|
3875
4330
|
/**
|
|
3876
4331
|
* <p>The ID of the asset model.</p>
|
|
@@ -3904,6 +4359,9 @@ export interface ListAssetModelPropertiesRequest {
|
|
|
3904
4359
|
*/
|
|
3905
4360
|
filter?: ListAssetModelPropertiesFilter | string;
|
|
3906
4361
|
}
|
|
4362
|
+
/**
|
|
4363
|
+
* @public
|
|
4364
|
+
*/
|
|
3907
4365
|
export interface ListAssetModelPropertiesResponse {
|
|
3908
4366
|
/**
|
|
3909
4367
|
* <p>A list that summarizes the properties associated with the specified asset model.</p>
|
|
@@ -3914,6 +4372,9 @@ export interface ListAssetModelPropertiesResponse {
|
|
|
3914
4372
|
*/
|
|
3915
4373
|
nextToken?: string;
|
|
3916
4374
|
}
|
|
4375
|
+
/**
|
|
4376
|
+
* @public
|
|
4377
|
+
*/
|
|
3917
4378
|
export interface ListAssetModelsRequest {
|
|
3918
4379
|
/**
|
|
3919
4380
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -3925,6 +4386,9 @@ export interface ListAssetModelsRequest {
|
|
|
3925
4386
|
*/
|
|
3926
4387
|
maxResults?: number;
|
|
3927
4388
|
}
|
|
4389
|
+
/**
|
|
4390
|
+
* @public
|
|
4391
|
+
*/
|
|
3928
4392
|
export interface ListAssetModelsResponse {
|
|
3929
4393
|
/**
|
|
3930
4394
|
* <p>A list that summarizes each asset model.</p>
|
|
@@ -3935,10 +4399,16 @@ export interface ListAssetModelsResponse {
|
|
|
3935
4399
|
*/
|
|
3936
4400
|
nextToken?: string;
|
|
3937
4401
|
}
|
|
4402
|
+
/**
|
|
4403
|
+
* @public
|
|
4404
|
+
*/
|
|
3938
4405
|
export declare enum ListAssetPropertiesFilter {
|
|
3939
4406
|
ALL = "ALL",
|
|
3940
4407
|
BASE = "BASE"
|
|
3941
4408
|
}
|
|
4409
|
+
/**
|
|
4410
|
+
* @public
|
|
4411
|
+
*/
|
|
3942
4412
|
export interface ListAssetPropertiesRequest {
|
|
3943
4413
|
/**
|
|
3944
4414
|
* <p>The ID of the asset.</p>
|
|
@@ -3972,6 +4442,9 @@ export interface ListAssetPropertiesRequest {
|
|
|
3972
4442
|
*/
|
|
3973
4443
|
filter?: ListAssetPropertiesFilter | string;
|
|
3974
4444
|
}
|
|
4445
|
+
/**
|
|
4446
|
+
* @public
|
|
4447
|
+
*/
|
|
3975
4448
|
export interface ListAssetPropertiesResponse {
|
|
3976
4449
|
/**
|
|
3977
4450
|
* <p>A list that summarizes the properties associated with the specified asset.</p>
|
|
@@ -3982,9 +4455,15 @@ export interface ListAssetPropertiesResponse {
|
|
|
3982
4455
|
*/
|
|
3983
4456
|
nextToken?: string;
|
|
3984
4457
|
}
|
|
4458
|
+
/**
|
|
4459
|
+
* @public
|
|
4460
|
+
*/
|
|
3985
4461
|
export declare enum TraversalType {
|
|
3986
4462
|
PATH_TO_ROOT = "PATH_TO_ROOT"
|
|
3987
4463
|
}
|
|
4464
|
+
/**
|
|
4465
|
+
* @public
|
|
4466
|
+
*/
|
|
3988
4467
|
export interface ListAssetRelationshipsRequest {
|
|
3989
4468
|
/**
|
|
3990
4469
|
* <p>The ID of the asset.</p>
|
|
@@ -4012,6 +4491,9 @@ export interface ListAssetRelationshipsRequest {
|
|
|
4012
4491
|
*/
|
|
4013
4492
|
maxResults?: number;
|
|
4014
4493
|
}
|
|
4494
|
+
/**
|
|
4495
|
+
* @public
|
|
4496
|
+
*/
|
|
4015
4497
|
export interface ListAssetRelationshipsResponse {
|
|
4016
4498
|
/**
|
|
4017
4499
|
* <p>A list that summarizes each asset relationship.</p>
|
|
@@ -4022,10 +4504,16 @@ export interface ListAssetRelationshipsResponse {
|
|
|
4022
4504
|
*/
|
|
4023
4505
|
nextToken?: string;
|
|
4024
4506
|
}
|
|
4507
|
+
/**
|
|
4508
|
+
* @public
|
|
4509
|
+
*/
|
|
4025
4510
|
export declare enum ListAssetsFilter {
|
|
4026
4511
|
ALL = "ALL",
|
|
4027
4512
|
TOP_LEVEL = "TOP_LEVEL"
|
|
4028
4513
|
}
|
|
4514
|
+
/**
|
|
4515
|
+
* @public
|
|
4516
|
+
*/
|
|
4029
4517
|
export interface ListAssetsRequest {
|
|
4030
4518
|
/**
|
|
4031
4519
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -4061,6 +4549,9 @@ export interface ListAssetsRequest {
|
|
|
4061
4549
|
*/
|
|
4062
4550
|
filter?: ListAssetsFilter | string;
|
|
4063
4551
|
}
|
|
4552
|
+
/**
|
|
4553
|
+
* @public
|
|
4554
|
+
*/
|
|
4064
4555
|
export interface ListAssetsResponse {
|
|
4065
4556
|
/**
|
|
4066
4557
|
* <p>A list that summarizes each asset.</p>
|
|
@@ -4071,10 +4562,16 @@ export interface ListAssetsResponse {
|
|
|
4071
4562
|
*/
|
|
4072
4563
|
nextToken?: string;
|
|
4073
4564
|
}
|
|
4565
|
+
/**
|
|
4566
|
+
* @public
|
|
4567
|
+
*/
|
|
4074
4568
|
export declare enum TraversalDirection {
|
|
4075
4569
|
CHILD = "CHILD",
|
|
4076
4570
|
PARENT = "PARENT"
|
|
4077
4571
|
}
|
|
4572
|
+
/**
|
|
4573
|
+
* @public
|
|
4574
|
+
*/
|
|
4078
4575
|
export interface ListAssociatedAssetsRequest {
|
|
4079
4576
|
/**
|
|
4080
4577
|
* <p>The ID of the asset to query.</p>
|
|
@@ -4116,6 +4613,9 @@ export interface ListAssociatedAssetsRequest {
|
|
|
4116
4613
|
*/
|
|
4117
4614
|
maxResults?: number;
|
|
4118
4615
|
}
|
|
4616
|
+
/**
|
|
4617
|
+
* @public
|
|
4618
|
+
*/
|
|
4119
4619
|
export interface ListAssociatedAssetsResponse {
|
|
4120
4620
|
/**
|
|
4121
4621
|
* <p>A list that summarizes the associated assets.</p>
|
|
@@ -4126,6 +4626,9 @@ export interface ListAssociatedAssetsResponse {
|
|
|
4126
4626
|
*/
|
|
4127
4627
|
nextToken?: string;
|
|
4128
4628
|
}
|
|
4629
|
+
/**
|
|
4630
|
+
* @public
|
|
4631
|
+
*/
|
|
4129
4632
|
export declare enum ListBulkImportJobsFilter {
|
|
4130
4633
|
ALL = "ALL",
|
|
4131
4634
|
CANCELLED = "CANCELLED",
|
|
@@ -4135,6 +4638,9 @@ export declare enum ListBulkImportJobsFilter {
|
|
|
4135
4638
|
PENDING = "PENDING",
|
|
4136
4639
|
RUNNING = "RUNNING"
|
|
4137
4640
|
}
|
|
4641
|
+
/**
|
|
4642
|
+
* @public
|
|
4643
|
+
*/
|
|
4138
4644
|
export interface ListBulkImportJobsRequest {
|
|
4139
4645
|
/**
|
|
4140
4646
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -4150,6 +4656,7 @@ export interface ListBulkImportJobsRequest {
|
|
|
4150
4656
|
filter?: ListBulkImportJobsFilter | string;
|
|
4151
4657
|
}
|
|
4152
4658
|
/**
|
|
4659
|
+
* @public
|
|
4153
4660
|
* <p>Contains a job summary information.</p>
|
|
4154
4661
|
*/
|
|
4155
4662
|
export interface JobSummary {
|
|
@@ -4194,6 +4701,9 @@ export interface JobSummary {
|
|
|
4194
4701
|
*/
|
|
4195
4702
|
status: JobStatus | string | undefined;
|
|
4196
4703
|
}
|
|
4704
|
+
/**
|
|
4705
|
+
* @public
|
|
4706
|
+
*/
|
|
4197
4707
|
export interface ListBulkImportJobsResponse {
|
|
4198
4708
|
/**
|
|
4199
4709
|
* <p>One or more job summaries to list.</p>
|
|
@@ -4204,6 +4714,9 @@ export interface ListBulkImportJobsResponse {
|
|
|
4204
4714
|
*/
|
|
4205
4715
|
nextToken?: string;
|
|
4206
4716
|
}
|
|
4717
|
+
/**
|
|
4718
|
+
* @public
|
|
4719
|
+
*/
|
|
4207
4720
|
export interface ListDashboardsRequest {
|
|
4208
4721
|
/**
|
|
4209
4722
|
* <p>The ID of the project.</p>
|
|
@@ -4220,6 +4733,7 @@ export interface ListDashboardsRequest {
|
|
|
4220
4733
|
maxResults?: number;
|
|
4221
4734
|
}
|
|
4222
4735
|
/**
|
|
4736
|
+
* @public
|
|
4223
4737
|
* <p>Contains a dashboard summary.</p>
|
|
4224
4738
|
*/
|
|
4225
4739
|
export interface DashboardSummary {
|
|
@@ -4244,6 +4758,9 @@ export interface DashboardSummary {
|
|
|
4244
4758
|
*/
|
|
4245
4759
|
lastUpdateDate?: Date;
|
|
4246
4760
|
}
|
|
4761
|
+
/**
|
|
4762
|
+
* @public
|
|
4763
|
+
*/
|
|
4247
4764
|
export interface ListDashboardsResponse {
|
|
4248
4765
|
/**
|
|
4249
4766
|
* <p>A list that summarizes each dashboard in the project.</p>
|
|
@@ -4254,6 +4771,9 @@ export interface ListDashboardsResponse {
|
|
|
4254
4771
|
*/
|
|
4255
4772
|
nextToken?: string;
|
|
4256
4773
|
}
|
|
4774
|
+
/**
|
|
4775
|
+
* @public
|
|
4776
|
+
*/
|
|
4257
4777
|
export interface ListGatewaysRequest {
|
|
4258
4778
|
/**
|
|
4259
4779
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -4266,6 +4786,7 @@ export interface ListGatewaysRequest {
|
|
|
4266
4786
|
maxResults?: number;
|
|
4267
4787
|
}
|
|
4268
4788
|
/**
|
|
4789
|
+
* @public
|
|
4269
4790
|
* <p>Contains a summary of a gateway.</p>
|
|
4270
4791
|
*/
|
|
4271
4792
|
export interface GatewaySummary {
|
|
@@ -4296,6 +4817,9 @@ export interface GatewaySummary {
|
|
|
4296
4817
|
*/
|
|
4297
4818
|
lastUpdateDate: Date | undefined;
|
|
4298
4819
|
}
|
|
4820
|
+
/**
|
|
4821
|
+
* @public
|
|
4822
|
+
*/
|
|
4299
4823
|
export interface ListGatewaysResponse {
|
|
4300
4824
|
/**
|
|
4301
4825
|
* <p>A list that summarizes each gateway.</p>
|
|
@@ -4306,6 +4830,9 @@ export interface ListGatewaysResponse {
|
|
|
4306
4830
|
*/
|
|
4307
4831
|
nextToken?: string;
|
|
4308
4832
|
}
|
|
4833
|
+
/**
|
|
4834
|
+
* @public
|
|
4835
|
+
*/
|
|
4309
4836
|
export interface ListPortalsRequest {
|
|
4310
4837
|
/**
|
|
4311
4838
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -4318,6 +4845,7 @@ export interface ListPortalsRequest {
|
|
|
4318
4845
|
maxResults?: number;
|
|
4319
4846
|
}
|
|
4320
4847
|
/**
|
|
4848
|
+
* @public
|
|
4321
4849
|
* <p>Contains a portal summary.</p>
|
|
4322
4850
|
*/
|
|
4323
4851
|
export interface PortalSummary {
|
|
@@ -4358,6 +4886,9 @@ export interface PortalSummary {
|
|
|
4358
4886
|
*/
|
|
4359
4887
|
status: PortalStatus | undefined;
|
|
4360
4888
|
}
|
|
4889
|
+
/**
|
|
4890
|
+
* @public
|
|
4891
|
+
*/
|
|
4361
4892
|
export interface ListPortalsResponse {
|
|
4362
4893
|
/**
|
|
4363
4894
|
* <p>A list that summarizes each portal.</p>
|
|
@@ -4368,6 +4899,9 @@ export interface ListPortalsResponse {
|
|
|
4368
4899
|
*/
|
|
4369
4900
|
nextToken?: string;
|
|
4370
4901
|
}
|
|
4902
|
+
/**
|
|
4903
|
+
* @public
|
|
4904
|
+
*/
|
|
4371
4905
|
export interface ListProjectAssetsRequest {
|
|
4372
4906
|
/**
|
|
4373
4907
|
* <p>The ID of the project.</p>
|
|
@@ -4383,6 +4917,9 @@ export interface ListProjectAssetsRequest {
|
|
|
4383
4917
|
*/
|
|
4384
4918
|
maxResults?: number;
|
|
4385
4919
|
}
|
|
4920
|
+
/**
|
|
4921
|
+
* @public
|
|
4922
|
+
*/
|
|
4386
4923
|
export interface ListProjectAssetsResponse {
|
|
4387
4924
|
/**
|
|
4388
4925
|
* <p>A list that contains the IDs of each asset associated with the project.</p>
|
|
@@ -4393,6 +4930,9 @@ export interface ListProjectAssetsResponse {
|
|
|
4393
4930
|
*/
|
|
4394
4931
|
nextToken?: string;
|
|
4395
4932
|
}
|
|
4933
|
+
/**
|
|
4934
|
+
* @public
|
|
4935
|
+
*/
|
|
4396
4936
|
export interface ListProjectsRequest {
|
|
4397
4937
|
/**
|
|
4398
4938
|
* <p>The ID of the portal.</p>
|
|
@@ -4409,6 +4949,7 @@ export interface ListProjectsRequest {
|
|
|
4409
4949
|
maxResults?: number;
|
|
4410
4950
|
}
|
|
4411
4951
|
/**
|
|
4952
|
+
* @public
|
|
4412
4953
|
* <p>Contains project summary information.</p>
|
|
4413
4954
|
*/
|
|
4414
4955
|
export interface ProjectSummary {
|
|
@@ -4433,6 +4974,9 @@ export interface ProjectSummary {
|
|
|
4433
4974
|
*/
|
|
4434
4975
|
lastUpdateDate?: Date;
|
|
4435
4976
|
}
|
|
4977
|
+
/**
|
|
4978
|
+
* @public
|
|
4979
|
+
*/
|
|
4436
4980
|
export interface ListProjectsResponse {
|
|
4437
4981
|
/**
|
|
4438
4982
|
* <p>A list that summarizes each project in the portal.</p>
|
|
@@ -4443,12 +4987,18 @@ export interface ListProjectsResponse {
|
|
|
4443
4987
|
*/
|
|
4444
4988
|
nextToken?: string;
|
|
4445
4989
|
}
|
|
4990
|
+
/**
|
|
4991
|
+
* @public
|
|
4992
|
+
*/
|
|
4446
4993
|
export interface ListTagsForResourceRequest {
|
|
4447
4994
|
/**
|
|
4448
4995
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource.</p>
|
|
4449
4996
|
*/
|
|
4450
4997
|
resourceArn: string | undefined;
|
|
4451
4998
|
}
|
|
4999
|
+
/**
|
|
5000
|
+
* @public
|
|
5001
|
+
*/
|
|
4452
5002
|
export interface ListTagsForResourceResponse {
|
|
4453
5003
|
/**
|
|
4454
5004
|
* <p>The list of key-value pairs that contain metadata for the resource. For more information,
|
|
@@ -4458,6 +5008,7 @@ export interface ListTagsForResourceResponse {
|
|
|
4458
5008
|
tags?: Record<string, string>;
|
|
4459
5009
|
}
|
|
4460
5010
|
/**
|
|
5011
|
+
* @public
|
|
4461
5012
|
* <p>You are not authorized.</p>
|
|
4462
5013
|
*/
|
|
4463
5014
|
export declare class UnauthorizedException extends __BaseException {
|
|
@@ -4468,10 +5019,16 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
4468
5019
|
*/
|
|
4469
5020
|
constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
|
|
4470
5021
|
}
|
|
5022
|
+
/**
|
|
5023
|
+
* @public
|
|
5024
|
+
*/
|
|
4471
5025
|
export declare enum ListTimeSeriesType {
|
|
4472
5026
|
ASSOCIATED = "ASSOCIATED",
|
|
4473
5027
|
DISASSOCIATED = "DISASSOCIATED"
|
|
4474
5028
|
}
|
|
5029
|
+
/**
|
|
5030
|
+
* @public
|
|
5031
|
+
*/
|
|
4475
5032
|
export interface ListTimeSeriesRequest {
|
|
4476
5033
|
/**
|
|
4477
5034
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -4508,6 +5065,7 @@ export interface ListTimeSeriesRequest {
|
|
|
4508
5065
|
timeSeriesType?: ListTimeSeriesType | string;
|
|
4509
5066
|
}
|
|
4510
5067
|
/**
|
|
5068
|
+
* @public
|
|
4511
5069
|
* <p>Contains a summary of a time series (data stream).</p>
|
|
4512
5070
|
*/
|
|
4513
5071
|
export interface TimeSeriesSummary {
|
|
@@ -4551,11 +5109,14 @@ export interface TimeSeriesSummary {
|
|
|
4551
5109
|
/**
|
|
4552
5110
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p>
|
|
4553
5111
|
* <p>
|
|
4554
|
-
* <code>arn
|
|
5112
|
+
* <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}</code>
|
|
4555
5113
|
* </p>
|
|
4556
5114
|
*/
|
|
4557
5115
|
timeSeriesArn: string | undefined;
|
|
4558
5116
|
}
|
|
5117
|
+
/**
|
|
5118
|
+
* @public
|
|
5119
|
+
*/
|
|
4559
5120
|
export interface ListTimeSeriesResponse {
|
|
4560
5121
|
/**
|
|
4561
5122
|
* <p>One or more time series summaries to list.</p>
|
|
@@ -4566,6 +5127,9 @@ export interface ListTimeSeriesResponse {
|
|
|
4566
5127
|
*/
|
|
4567
5128
|
nextToken?: string;
|
|
4568
5129
|
}
|
|
5130
|
+
/**
|
|
5131
|
+
* @public
|
|
5132
|
+
*/
|
|
4569
5133
|
export interface PutDefaultEncryptionConfigurationRequest {
|
|
4570
5134
|
/**
|
|
4571
5135
|
* <p>The type of encryption used for the encryption configuration.</p>
|
|
@@ -4577,6 +5141,9 @@ export interface PutDefaultEncryptionConfigurationRequest {
|
|
|
4577
5141
|
*/
|
|
4578
5142
|
kmsKeyId?: string;
|
|
4579
5143
|
}
|
|
5144
|
+
/**
|
|
5145
|
+
* @public
|
|
5146
|
+
*/
|
|
4580
5147
|
export interface PutDefaultEncryptionConfigurationResponse {
|
|
4581
5148
|
/**
|
|
4582
5149
|
* <p>The type of encryption used for the encryption configuration.</p>
|
|
@@ -4594,14 +5161,23 @@ export interface PutDefaultEncryptionConfigurationResponse {
|
|
|
4594
5161
|
*/
|
|
4595
5162
|
configurationStatus: ConfigurationStatus | undefined;
|
|
4596
5163
|
}
|
|
5164
|
+
/**
|
|
5165
|
+
* @public
|
|
5166
|
+
*/
|
|
4597
5167
|
export interface PutLoggingOptionsRequest {
|
|
4598
5168
|
/**
|
|
4599
5169
|
* <p>The logging options to set.</p>
|
|
4600
5170
|
*/
|
|
4601
5171
|
loggingOptions: LoggingOptions | undefined;
|
|
4602
5172
|
}
|
|
5173
|
+
/**
|
|
5174
|
+
* @public
|
|
5175
|
+
*/
|
|
4603
5176
|
export interface PutLoggingOptionsResponse {
|
|
4604
5177
|
}
|
|
5178
|
+
/**
|
|
5179
|
+
* @public
|
|
5180
|
+
*/
|
|
4605
5181
|
export interface PutStorageConfigurationRequest {
|
|
4606
5182
|
/**
|
|
4607
5183
|
* <p>The storage tier that you specified for your data.
|
|
@@ -4650,6 +5226,9 @@ export interface PutStorageConfigurationRequest {
|
|
|
4650
5226
|
*/
|
|
4651
5227
|
retentionPeriod?: RetentionPeriod;
|
|
4652
5228
|
}
|
|
5229
|
+
/**
|
|
5230
|
+
* @public
|
|
5231
|
+
*/
|
|
4653
5232
|
export interface PutStorageConfigurationResponse {
|
|
4654
5233
|
/**
|
|
4655
5234
|
* <p>The storage tier that you specified for your data.
|
|
@@ -4701,6 +5280,9 @@ export interface PutStorageConfigurationResponse {
|
|
|
4701
5280
|
*/
|
|
4702
5281
|
configurationStatus: ConfigurationStatus | undefined;
|
|
4703
5282
|
}
|
|
5283
|
+
/**
|
|
5284
|
+
* @public
|
|
5285
|
+
*/
|
|
4704
5286
|
export interface TagResourceRequest {
|
|
4705
5287
|
/**
|
|
4706
5288
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to tag.</p>
|
|
@@ -4713,9 +5295,13 @@ export interface TagResourceRequest {
|
|
|
4713
5295
|
*/
|
|
4714
5296
|
tags: Record<string, string> | undefined;
|
|
4715
5297
|
}
|
|
5298
|
+
/**
|
|
5299
|
+
* @public
|
|
5300
|
+
*/
|
|
4716
5301
|
export interface TagResourceResponse {
|
|
4717
5302
|
}
|
|
4718
5303
|
/**
|
|
5304
|
+
* @public
|
|
4719
5305
|
* <p>You've reached the limit for the number of tags allowed for a resource. For more
|
|
4720
5306
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions">Tag naming limits and
|
|
4721
5307
|
* requirements</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
@@ -4732,6 +5318,9 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
4732
5318
|
*/
|
|
4733
5319
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
4734
5320
|
}
|
|
5321
|
+
/**
|
|
5322
|
+
* @public
|
|
5323
|
+
*/
|
|
4735
5324
|
export interface UntagResourceRequest {
|
|
4736
5325
|
/**
|
|
4737
5326
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to untag.</p>
|
|
@@ -4742,8 +5331,14 @@ export interface UntagResourceRequest {
|
|
|
4742
5331
|
*/
|
|
4743
5332
|
tagKeys: string[] | undefined;
|
|
4744
5333
|
}
|
|
5334
|
+
/**
|
|
5335
|
+
* @public
|
|
5336
|
+
*/
|
|
4745
5337
|
export interface UntagResourceResponse {
|
|
4746
5338
|
}
|
|
5339
|
+
/**
|
|
5340
|
+
* @public
|
|
5341
|
+
*/
|
|
4747
5342
|
export interface UpdateAccessPolicyRequest {
|
|
4748
5343
|
/**
|
|
4749
5344
|
* <p>The ID of the access policy.</p>
|
|
@@ -4766,8 +5361,14 @@ export interface UpdateAccessPolicyRequest {
|
|
|
4766
5361
|
*/
|
|
4767
5362
|
clientToken?: string;
|
|
4768
5363
|
}
|
|
5364
|
+
/**
|
|
5365
|
+
* @public
|
|
5366
|
+
*/
|
|
4769
5367
|
export interface UpdateAccessPolicyResponse {
|
|
4770
5368
|
}
|
|
5369
|
+
/**
|
|
5370
|
+
* @public
|
|
5371
|
+
*/
|
|
4771
5372
|
export interface UpdateAssetRequest {
|
|
4772
5373
|
/**
|
|
4773
5374
|
* <p>The ID of the asset to update.</p>
|
|
@@ -4786,6 +5387,9 @@ export interface UpdateAssetRequest {
|
|
|
4786
5387
|
*/
|
|
4787
5388
|
assetDescription?: string;
|
|
4788
5389
|
}
|
|
5390
|
+
/**
|
|
5391
|
+
* @public
|
|
5392
|
+
*/
|
|
4789
5393
|
export interface UpdateAssetResponse {
|
|
4790
5394
|
/**
|
|
4791
5395
|
* <p>The status of the asset, which contains a state (<code>UPDATING</code> after successfully
|
|
@@ -4793,6 +5397,9 @@ export interface UpdateAssetResponse {
|
|
|
4793
5397
|
*/
|
|
4794
5398
|
assetStatus: AssetStatus | undefined;
|
|
4795
5399
|
}
|
|
5400
|
+
/**
|
|
5401
|
+
* @public
|
|
5402
|
+
*/
|
|
4796
5403
|
export interface UpdateAssetModelRequest {
|
|
4797
5404
|
/**
|
|
4798
5405
|
* <p>The ID of the asset model to update.</p>
|
|
@@ -4833,6 +5440,9 @@ export interface UpdateAssetModelRequest {
|
|
|
4833
5440
|
*/
|
|
4834
5441
|
clientToken?: string;
|
|
4835
5442
|
}
|
|
5443
|
+
/**
|
|
5444
|
+
* @public
|
|
5445
|
+
*/
|
|
4836
5446
|
export interface UpdateAssetModelResponse {
|
|
4837
5447
|
/**
|
|
4838
5448
|
* <p>The status of the asset model, which contains a state (<code>UPDATING</code> after
|
|
@@ -4840,6 +5450,9 @@ export interface UpdateAssetModelResponse {
|
|
|
4840
5450
|
*/
|
|
4841
5451
|
assetModelStatus: AssetModelStatus | undefined;
|
|
4842
5452
|
}
|
|
5453
|
+
/**
|
|
5454
|
+
* @public
|
|
5455
|
+
*/
|
|
4843
5456
|
export interface UpdateAssetPropertyRequest {
|
|
4844
5457
|
/**
|
|
4845
5458
|
* <p>The ID of the asset to be updated.</p>
|
|
@@ -4875,6 +5488,9 @@ export interface UpdateAssetPropertyRequest {
|
|
|
4875
5488
|
*/
|
|
4876
5489
|
propertyUnit?: string;
|
|
4877
5490
|
}
|
|
5491
|
+
/**
|
|
5492
|
+
* @public
|
|
5493
|
+
*/
|
|
4878
5494
|
export interface UpdateDashboardRequest {
|
|
4879
5495
|
/**
|
|
4880
5496
|
* <p>The ID of the dashboard to update.</p>
|
|
@@ -4898,8 +5514,14 @@ export interface UpdateDashboardRequest {
|
|
|
4898
5514
|
*/
|
|
4899
5515
|
clientToken?: string;
|
|
4900
5516
|
}
|
|
5517
|
+
/**
|
|
5518
|
+
* @public
|
|
5519
|
+
*/
|
|
4901
5520
|
export interface UpdateDashboardResponse {
|
|
4902
5521
|
}
|
|
5522
|
+
/**
|
|
5523
|
+
* @public
|
|
5524
|
+
*/
|
|
4903
5525
|
export interface UpdateGatewayRequest {
|
|
4904
5526
|
/**
|
|
4905
5527
|
* <p>The ID of the gateway to update.</p>
|
|
@@ -4910,6 +5532,9 @@ export interface UpdateGatewayRequest {
|
|
|
4910
5532
|
*/
|
|
4911
5533
|
gatewayName: string | undefined;
|
|
4912
5534
|
}
|
|
5535
|
+
/**
|
|
5536
|
+
* @public
|
|
5537
|
+
*/
|
|
4913
5538
|
export interface UpdateGatewayCapabilityConfigurationRequest {
|
|
4914
5539
|
/**
|
|
4915
5540
|
* <p>The ID of the gateway to be updated.</p>
|
|
@@ -4929,6 +5554,9 @@ export interface UpdateGatewayCapabilityConfigurationRequest {
|
|
|
4929
5554
|
*/
|
|
4930
5555
|
capabilityConfiguration: string | undefined;
|
|
4931
5556
|
}
|
|
5557
|
+
/**
|
|
5558
|
+
* @public
|
|
5559
|
+
*/
|
|
4932
5560
|
export interface UpdateGatewayCapabilityConfigurationResponse {
|
|
4933
5561
|
/**
|
|
4934
5562
|
* <p>The namespace of the gateway capability.</p>
|
|
@@ -4956,6 +5584,7 @@ export interface UpdateGatewayCapabilityConfigurationResponse {
|
|
|
4956
5584
|
capabilitySyncStatus: CapabilitySyncStatus | string | undefined;
|
|
4957
5585
|
}
|
|
4958
5586
|
/**
|
|
5587
|
+
* @public
|
|
4959
5588
|
* <p>Contains an image that is one of the following:</p>
|
|
4960
5589
|
* <ul>
|
|
4961
5590
|
* <li>
|
|
@@ -4976,6 +5605,9 @@ export interface Image {
|
|
|
4976
5605
|
*/
|
|
4977
5606
|
file?: ImageFile;
|
|
4978
5607
|
}
|
|
5608
|
+
/**
|
|
5609
|
+
* @public
|
|
5610
|
+
*/
|
|
4979
5611
|
export interface UpdatePortalRequest {
|
|
4980
5612
|
/**
|
|
4981
5613
|
* <p>The ID of the portal to update.</p>
|
|
@@ -5026,6 +5658,9 @@ export interface UpdatePortalRequest {
|
|
|
5026
5658
|
*/
|
|
5027
5659
|
alarms?: Alarms;
|
|
5028
5660
|
}
|
|
5661
|
+
/**
|
|
5662
|
+
* @public
|
|
5663
|
+
*/
|
|
5029
5664
|
export interface UpdatePortalResponse {
|
|
5030
5665
|
/**
|
|
5031
5666
|
* <p>The status of the portal, which contains a state (<code>UPDATING</code> after successfully
|
|
@@ -5033,6 +5668,9 @@ export interface UpdatePortalResponse {
|
|
|
5033
5668
|
*/
|
|
5034
5669
|
portalStatus: PortalStatus | undefined;
|
|
5035
5670
|
}
|
|
5671
|
+
/**
|
|
5672
|
+
* @public
|
|
5673
|
+
*/
|
|
5036
5674
|
export interface UpdateProjectRequest {
|
|
5037
5675
|
/**
|
|
5038
5676
|
* <p>The ID of the project to update.</p>
|
|
@@ -5051,6 +5689,9 @@ export interface UpdateProjectRequest {
|
|
|
5051
5689
|
*/
|
|
5052
5690
|
clientToken?: string;
|
|
5053
5691
|
}
|
|
5692
|
+
/**
|
|
5693
|
+
* @public
|
|
5694
|
+
*/
|
|
5054
5695
|
export interface UpdateProjectResponse {
|
|
5055
5696
|
}
|
|
5056
5697
|
/**
|