@aws-sdk/client-iotsitewise 3.454.0 → 3.456.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/README.md +88 -0
- package/dist-cjs/IoTSiteWise.js +22 -0
- package/dist-cjs/commands/CreateAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/DeleteAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/DescribeActionCommand.js +51 -0
- package/dist-cjs/commands/DescribeAssetCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/DescribeAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/ExecuteActionCommand.js +51 -0
- package/dist-cjs/commands/ExecuteQueryCommand.js +51 -0
- package/dist-cjs/commands/ListActionsCommand.js +51 -0
- package/dist-cjs/commands/ListAssetModelCompositeModelsCommand.js +51 -0
- package/dist-cjs/commands/ListCompositionRelationshipsCommand.js +51 -0
- package/dist-cjs/commands/UpdateAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/index.js +11 -0
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +59 -15
- package/dist-cjs/models/models_1.js +18 -0
- package/dist-cjs/pagination/ExecuteQueryPaginator.js +29 -0
- package/dist-cjs/pagination/ListAssetModelCompositeModelsPaginator.js +29 -0
- package/dist-cjs/pagination/ListCompositionRelationshipsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1018 -25
- package/dist-es/IoTSiteWise.js +22 -0
- package/dist-es/commands/CreateAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/DeleteAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/DescribeActionCommand.js +47 -0
- package/dist-es/commands/DescribeAssetCompositeModelCommand.js +47 -0
- package/dist-es/commands/DescribeAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/ExecuteActionCommand.js +47 -0
- package/dist-es/commands/ExecuteQueryCommand.js +47 -0
- package/dist-es/commands/ListActionsCommand.js +47 -0
- package/dist-es/commands/ListAssetModelCompositeModelsCommand.js +47 -0
- package/dist-es/commands/ListCompositionRelationshipsCommand.js +47 -0
- package/dist-es/commands/UpdateAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +54 -13
- package/dist-es/models/models_1.js +14 -0
- package/dist-es/pagination/ExecuteQueryPaginator.js +25 -0
- package/dist-es/pagination/ListAssetModelCompositeModelsPaginator.js +25 -0
- package/dist-es/pagination/ListCompositionRelationshipsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1038 -68
- package/dist-types/IoTSiteWise.d.ts +77 -0
- package/dist-types/IoTSiteWiseClient.d.ts +13 -2
- package/dist-types/commands/CreateAssetCommand.d.ts +2 -0
- package/dist-types/commands/CreateAssetModelCommand.d.ts +52 -4
- package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +212 -0
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +8 -3
- package/dist-types/commands/DeleteAssetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +111 -0
- package/dist-types/commands/DescribeActionCommand.d.ts +97 -0
- package/dist-types/commands/DescribeAssetCommand.d.ts +32 -0
- package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +145 -0
- package/dist-types/commands/DescribeAssetModelCommand.d.ts +46 -4
- package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +209 -0
- package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +44 -4
- package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +4 -1
- package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/ExecuteActionCommand.d.ts +106 -0
- package/dist-types/commands/ExecuteQueryCommand.d.ts +130 -0
- package/dist-types/commands/ListActionsCommand.d.ts +101 -0
- package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +106 -0
- package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +21 -2
- package/dist-types/commands/ListAssetModelsCommand.d.ts +5 -0
- package/dist-types/commands/ListAssetPropertiesCommand.d.ts +8 -1
- package/dist-types/commands/ListAssetsCommand.d.ts +2 -0
- package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +2 -0
- package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +98 -0
- package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutLoggingOptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutStorageConfigurationCommand.d.ts +11 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAssetModelCommand.d.ts +31 -5
- package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +220 -0
- package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePortalCommand.d.ts +1 -1
- package/dist-types/commands/UpdateProjectCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1377 -773
- package/dist-types/models/models_1.d.ts +796 -0
- package/dist-types/pagination/ExecuteQueryPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAssetModelCompositeModelsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCompositionRelationshipsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +187 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/CreateAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeActionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeAssetCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ExecuteActionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutLoggingOptionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssetModelCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateAssetPropertyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGatewayCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePortalCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateProjectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +284 -130
- package/dist-types/ts3.4/models/models_1.d.ts +190 -0
- package/dist-types/ts3.4/pagination/ExecuteQueryPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAssetModelCompositeModelsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCompositionRelationshipsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
- package/package.json +1 -1
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>Access is denied.</p>
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
|
+
}
|
|
3
15
|
/**
|
|
4
16
|
* @public
|
|
5
17
|
* <p>Contains information for a group identity in an access policy.</p>
|
|
@@ -56,7 +68,7 @@ export interface UserIdentity {
|
|
|
56
68
|
* @public
|
|
57
69
|
* <p>Contains an identity that can access an IoT SiteWise Monitor resource.</p>
|
|
58
70
|
* <note>
|
|
59
|
-
* <p>Currently, you can't use Amazon Web Services
|
|
71
|
+
* <p>Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the
|
|
60
72
|
* IAM Identity Center identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">IAM Identity Center console</a>.</p>
|
|
61
73
|
* </note>
|
|
62
74
|
*/
|
|
@@ -170,6 +182,70 @@ export interface AccessPolicySummary {
|
|
|
170
182
|
*/
|
|
171
183
|
lastUpdateDate?: Date;
|
|
172
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
* <p>Contains a definition for an action.</p>
|
|
188
|
+
*/
|
|
189
|
+
export interface ActionDefinition {
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
* <p>The ID of the action definition.</p>
|
|
193
|
+
*/
|
|
194
|
+
actionDefinitionId: string | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* @public
|
|
197
|
+
* <p>The name of the action definition.</p>
|
|
198
|
+
*/
|
|
199
|
+
actionName: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* @public
|
|
202
|
+
* <p>The type of the action definition.</p>
|
|
203
|
+
*/
|
|
204
|
+
actionType: string | undefined;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* @public
|
|
208
|
+
* <p>The JSON payload of the action.</p>
|
|
209
|
+
*/
|
|
210
|
+
export interface ActionPayload {
|
|
211
|
+
/**
|
|
212
|
+
* @public
|
|
213
|
+
* <p>The payload of the action in a JSON string.</p>
|
|
214
|
+
*/
|
|
215
|
+
stringValue: string | undefined;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* @public
|
|
219
|
+
* <p>The resource the action will be taken on.</p>
|
|
220
|
+
*/
|
|
221
|
+
export interface TargetResource {
|
|
222
|
+
/**
|
|
223
|
+
* @public
|
|
224
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
225
|
+
*/
|
|
226
|
+
assetId: string | undefined;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* @public
|
|
230
|
+
* <p>Contains the summary of the actions.</p>
|
|
231
|
+
*/
|
|
232
|
+
export interface ActionSummary {
|
|
233
|
+
/**
|
|
234
|
+
* @public
|
|
235
|
+
* <p>The ID of the action.</p>
|
|
236
|
+
*/
|
|
237
|
+
actionId?: string;
|
|
238
|
+
/**
|
|
239
|
+
* @public
|
|
240
|
+
* <p>The ID of the action definition.</p>
|
|
241
|
+
*/
|
|
242
|
+
actionDefinitionId?: string;
|
|
243
|
+
/**
|
|
244
|
+
* @public
|
|
245
|
+
* <p>The resource the action will be taken on.</p>
|
|
246
|
+
*/
|
|
247
|
+
targetResource?: TargetResource;
|
|
248
|
+
}
|
|
173
249
|
/**
|
|
174
250
|
* @public
|
|
175
251
|
* @enum
|
|
@@ -322,6 +398,22 @@ export interface PropertyNotification {
|
|
|
322
398
|
*/
|
|
323
399
|
state: PropertyNotificationState | undefined;
|
|
324
400
|
}
|
|
401
|
+
/**
|
|
402
|
+
* @public
|
|
403
|
+
* <p>Represents one level between a property and the root of the asset.</p>
|
|
404
|
+
*/
|
|
405
|
+
export interface AssetPropertyPathSegment {
|
|
406
|
+
/**
|
|
407
|
+
* @public
|
|
408
|
+
* <p>The ID of the path segment.</p>
|
|
409
|
+
*/
|
|
410
|
+
id?: string;
|
|
411
|
+
/**
|
|
412
|
+
* @public
|
|
413
|
+
* <p>The name of the path segment.</p>
|
|
414
|
+
*/
|
|
415
|
+
name?: string;
|
|
416
|
+
}
|
|
325
417
|
/**
|
|
326
418
|
* @public
|
|
327
419
|
* <p>Contains asset property information.</p>
|
|
@@ -366,6 +458,16 @@ export interface AssetProperty {
|
|
|
366
458
|
* <p>The unit (such as <code>Newtons</code> or <code>RPM</code>) of the asset property.</p>
|
|
367
459
|
*/
|
|
368
460
|
unit?: string;
|
|
461
|
+
/**
|
|
462
|
+
* @public
|
|
463
|
+
* <p>The structured path to the property from the root of the asset.</p>
|
|
464
|
+
*/
|
|
465
|
+
path?: AssetPropertyPathSegment[];
|
|
466
|
+
/**
|
|
467
|
+
* @public
|
|
468
|
+
* <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
469
|
+
*/
|
|
470
|
+
externalId?: string;
|
|
369
471
|
}
|
|
370
472
|
/**
|
|
371
473
|
* @public
|
|
@@ -401,6 +503,77 @@ export interface AssetCompositeModel {
|
|
|
401
503
|
* </p>
|
|
402
504
|
*/
|
|
403
505
|
id?: string;
|
|
506
|
+
/**
|
|
507
|
+
* @public
|
|
508
|
+
* <p>The external ID of the asset composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
509
|
+
*/
|
|
510
|
+
externalId?: string;
|
|
511
|
+
}
|
|
512
|
+
/**
|
|
513
|
+
* @public
|
|
514
|
+
* <p>Represents one level between a composite model and the root of the asset.</p>
|
|
515
|
+
*/
|
|
516
|
+
export interface AssetCompositeModelPathSegment {
|
|
517
|
+
/**
|
|
518
|
+
* @public
|
|
519
|
+
* <p>The ID of the path segment.</p>
|
|
520
|
+
*/
|
|
521
|
+
id?: string;
|
|
522
|
+
/**
|
|
523
|
+
* @public
|
|
524
|
+
* <p>The name of the path segment.</p>
|
|
525
|
+
*/
|
|
526
|
+
name?: string;
|
|
527
|
+
}
|
|
528
|
+
/**
|
|
529
|
+
* @public
|
|
530
|
+
* <p>Contains a summary of the composite model for a specific asset.</p>
|
|
531
|
+
*/
|
|
532
|
+
export interface AssetCompositeModelSummary {
|
|
533
|
+
/**
|
|
534
|
+
* @public
|
|
535
|
+
* <p>The ID of the composite model that this summary describes.</p>
|
|
536
|
+
*/
|
|
537
|
+
id: string | undefined;
|
|
538
|
+
/**
|
|
539
|
+
* @public
|
|
540
|
+
* <p>An external ID to assign to the asset model.</p>
|
|
541
|
+
* <p>If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using
|
|
542
|
+
* <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p>
|
|
543
|
+
*/
|
|
544
|
+
externalId?: string;
|
|
545
|
+
/**
|
|
546
|
+
* @public
|
|
547
|
+
* <p>The name of the composite model that this summary describes.</p>
|
|
548
|
+
*/
|
|
549
|
+
name: string | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* @public
|
|
552
|
+
* <p>The type of asset model.</p>
|
|
553
|
+
* <ul>
|
|
554
|
+
* <li>
|
|
555
|
+
* <p>
|
|
556
|
+
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
|
|
557
|
+
* Can't be included as a component in another asset model.</p>
|
|
558
|
+
* </li>
|
|
559
|
+
* <li>
|
|
560
|
+
* <p>
|
|
561
|
+
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
|
|
562
|
+
* models of other asset models. You can't create assets directly from this type of asset model. </p>
|
|
563
|
+
* </li>
|
|
564
|
+
* </ul>
|
|
565
|
+
*/
|
|
566
|
+
type: string | undefined;
|
|
567
|
+
/**
|
|
568
|
+
* @public
|
|
569
|
+
* <p>A description of the composite model that this summary describes.</p>
|
|
570
|
+
*/
|
|
571
|
+
description: string | undefined;
|
|
572
|
+
/**
|
|
573
|
+
* @public
|
|
574
|
+
* <p>The path that includes all the components of the asset model for the asset.</p>
|
|
575
|
+
*/
|
|
576
|
+
path: AssetCompositeModelPathSegment[] | undefined;
|
|
404
577
|
}
|
|
405
578
|
/**
|
|
406
579
|
* @public
|
|
@@ -420,7 +593,7 @@ export type AssetErrorCode = (typeof AssetErrorCode)[keyof typeof AssetErrorCode
|
|
|
420
593
|
export interface AssetErrorDetails {
|
|
421
594
|
/**
|
|
422
595
|
* @public
|
|
423
|
-
* <p>The ID of the asset.</p>
|
|
596
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
424
597
|
*/
|
|
425
598
|
assetId: string | undefined;
|
|
426
599
|
/**
|
|
@@ -450,6 +623,13 @@ export interface AssetHierarchy {
|
|
|
450
623
|
* API operation.</p>
|
|
451
624
|
*/
|
|
452
625
|
name: string | undefined;
|
|
626
|
+
/**
|
|
627
|
+
* @public
|
|
628
|
+
* <p>The external ID of the hierarchy, if it has one. When you update an asset hierarchy,
|
|
629
|
+
* you may assign an external ID if it doesn't already have one. You can't change the external ID
|
|
630
|
+
* of an asset hierarchy that already has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
631
|
+
*/
|
|
632
|
+
externalId?: string;
|
|
453
633
|
}
|
|
454
634
|
/**
|
|
455
635
|
* @public
|
|
@@ -468,6 +648,22 @@ export interface AssetHierarchyInfo {
|
|
|
468
648
|
*/
|
|
469
649
|
childAssetId?: string;
|
|
470
650
|
}
|
|
651
|
+
/**
|
|
652
|
+
* @public
|
|
653
|
+
* <p>Represents one level between a property and the root of the asset model.</p>
|
|
654
|
+
*/
|
|
655
|
+
export interface AssetModelPropertyPathSegment {
|
|
656
|
+
/**
|
|
657
|
+
* @public
|
|
658
|
+
* <p>The ID of the path segment.</p>
|
|
659
|
+
*/
|
|
660
|
+
id?: string;
|
|
661
|
+
/**
|
|
662
|
+
* @public
|
|
663
|
+
* <p>The name of the path segment.</p>
|
|
664
|
+
*/
|
|
665
|
+
name?: string;
|
|
666
|
+
}
|
|
471
667
|
/**
|
|
472
668
|
* @public
|
|
473
669
|
* <p>Contains an asset attribute property. For more information, see
|
|
@@ -566,19 +762,26 @@ export interface VariableValue {
|
|
|
566
762
|
/**
|
|
567
763
|
* @public
|
|
568
764
|
* <p>The ID of the property to use as the variable. You can use the property <code>name</code>
|
|
569
|
-
* if it's from the same asset model
|
|
765
|
+
* if it's from the same asset model. If the property has an external ID, you can specify
|
|
766
|
+
* <code>externalId:</code> followed by the external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
570
767
|
*/
|
|
571
|
-
propertyId
|
|
768
|
+
propertyId?: string;
|
|
572
769
|
/**
|
|
573
770
|
* @public
|
|
574
771
|
* <p>The ID of the hierarchy to query for the property ID. You can use the hierarchy's name
|
|
575
|
-
* instead of the hierarchy's ID
|
|
772
|
+
* instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify
|
|
773
|
+
* <code>externalId:</code> followed by the external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
576
774
|
* <p>You use a hierarchy ID instead of a model ID because you can have several hierarchies
|
|
577
775
|
* using the same model and therefore the same <code>propertyId</code>. For example, you might
|
|
578
776
|
* have separately grouped assets that come from the same asset model. For more information, see
|
|
579
777
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
580
778
|
*/
|
|
581
779
|
hierarchyId?: string;
|
|
780
|
+
/**
|
|
781
|
+
* @public
|
|
782
|
+
* <p>The path of the property.</p>
|
|
783
|
+
*/
|
|
784
|
+
propertyPath?: AssetModelPropertyPathSegment[];
|
|
582
785
|
}
|
|
583
786
|
/**
|
|
584
787
|
* @public
|
|
@@ -828,6 +1031,20 @@ export interface AssetModelProperty {
|
|
|
828
1031
|
/**
|
|
829
1032
|
* @public
|
|
830
1033
|
* <p>The ID of the asset model property.</p>
|
|
1034
|
+
* <ul>
|
|
1035
|
+
* <li>
|
|
1036
|
+
* <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1037
|
+
* to create a <i>new</i> property: You can specify its ID here, if desired.
|
|
1038
|
+
* IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
1039
|
+
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
1040
|
+
* If you specify your own ID, it must be globally unique.</p>
|
|
1041
|
+
* </li>
|
|
1042
|
+
* <li>
|
|
1043
|
+
* <p>If you are calling UpdateAssetModel to modify an <i>existing</i>
|
|
1044
|
+
* property: This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
1045
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1046
|
+
* </li>
|
|
1047
|
+
* </ul>
|
|
831
1048
|
*/
|
|
832
1049
|
id?: string;
|
|
833
1050
|
/**
|
|
@@ -857,6 +1074,18 @@ export interface AssetModelProperty {
|
|
|
857
1074
|
* <p>The property type (see <code>PropertyType</code>).</p>
|
|
858
1075
|
*/
|
|
859
1076
|
type: PropertyType | undefined;
|
|
1077
|
+
/**
|
|
1078
|
+
* @public
|
|
1079
|
+
* <p>The structured path to the property from the root of the asset model.</p>
|
|
1080
|
+
*/
|
|
1081
|
+
path?: AssetModelPropertyPathSegment[];
|
|
1082
|
+
/**
|
|
1083
|
+
* @public
|
|
1084
|
+
* <p>The external ID (if any) provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1085
|
+
* operation. You can assign an external ID by specifying
|
|
1086
|
+
* this value as part of a call to <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>. However, you can't change the external ID if one is already assigned. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1087
|
+
*/
|
|
1088
|
+
externalId?: string;
|
|
860
1089
|
}
|
|
861
1090
|
/**
|
|
862
1091
|
* @public
|
|
@@ -892,6 +1121,11 @@ export interface AssetModelCompositeModel {
|
|
|
892
1121
|
* </p>
|
|
893
1122
|
*/
|
|
894
1123
|
id?: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* @public
|
|
1126
|
+
* <p>The external ID of the asset model composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1127
|
+
*/
|
|
1128
|
+
externalId?: string;
|
|
895
1129
|
}
|
|
896
1130
|
/**
|
|
897
1131
|
* @public
|
|
@@ -932,6 +1166,19 @@ export interface AssetModelPropertyDefinition {
|
|
|
932
1166
|
* type in a property definition.</p>
|
|
933
1167
|
*/
|
|
934
1168
|
type: PropertyType | undefined;
|
|
1169
|
+
/**
|
|
1170
|
+
* @public
|
|
1171
|
+
* <p>The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
1172
|
+
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
1173
|
+
* If you specify your own ID, it must be globally unique.</p>
|
|
1174
|
+
*/
|
|
1175
|
+
id?: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* @public
|
|
1178
|
+
* <p>An external ID to assign to the property definition. The external ID must be unique among
|
|
1179
|
+
* property definitions within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1180
|
+
*/
|
|
1181
|
+
externalId?: string;
|
|
935
1182
|
}
|
|
936
1183
|
/**
|
|
937
1184
|
* @public
|
|
@@ -960,6 +1207,83 @@ export interface AssetModelCompositeModelDefinition {
|
|
|
960
1207
|
* <p>The asset property definitions for this composite model.</p>
|
|
961
1208
|
*/
|
|
962
1209
|
properties?: AssetModelPropertyDefinition[];
|
|
1210
|
+
/**
|
|
1211
|
+
* @public
|
|
1212
|
+
* <p>The ID to assign to the composite model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
1213
|
+
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
1214
|
+
* If you specify your own ID, it must be globally unique.</p>
|
|
1215
|
+
*/
|
|
1216
|
+
id?: string;
|
|
1217
|
+
/**
|
|
1218
|
+
* @public
|
|
1219
|
+
* <p>An external ID to assign to the composite model. The external ID must be unique among
|
|
1220
|
+
* composite models within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1221
|
+
*/
|
|
1222
|
+
externalId?: string;
|
|
1223
|
+
}
|
|
1224
|
+
/**
|
|
1225
|
+
* @public
|
|
1226
|
+
* <p>Represents one level between a composite model and the root of the asset model.</p>
|
|
1227
|
+
*/
|
|
1228
|
+
export interface AssetModelCompositeModelPathSegment {
|
|
1229
|
+
/**
|
|
1230
|
+
* @public
|
|
1231
|
+
* <p>The ID of the path segment.</p>
|
|
1232
|
+
*/
|
|
1233
|
+
id?: string;
|
|
1234
|
+
/**
|
|
1235
|
+
* @public
|
|
1236
|
+
* <p>The name of the path segment.</p>
|
|
1237
|
+
*/
|
|
1238
|
+
name?: string;
|
|
1239
|
+
}
|
|
1240
|
+
/**
|
|
1241
|
+
* @public
|
|
1242
|
+
* <p>Contains a summary of the composite model.</p>
|
|
1243
|
+
*/
|
|
1244
|
+
export interface AssetModelCompositeModelSummary {
|
|
1245
|
+
/**
|
|
1246
|
+
* @public
|
|
1247
|
+
* <p>The ID of the the composite model that this summary describes..</p>
|
|
1248
|
+
*/
|
|
1249
|
+
id: string | undefined;
|
|
1250
|
+
/**
|
|
1251
|
+
* @public
|
|
1252
|
+
* <p>The external ID of a composite model on this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1253
|
+
*/
|
|
1254
|
+
externalId?: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* @public
|
|
1257
|
+
* <p>The name of the the composite model that this summary describes..</p>
|
|
1258
|
+
*/
|
|
1259
|
+
name: string | undefined;
|
|
1260
|
+
/**
|
|
1261
|
+
* @public
|
|
1262
|
+
* <p>The type of asset model.</p>
|
|
1263
|
+
* <ul>
|
|
1264
|
+
* <li>
|
|
1265
|
+
* <p>
|
|
1266
|
+
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
|
|
1267
|
+
* Can't be included as a component in another asset model.</p>
|
|
1268
|
+
* </li>
|
|
1269
|
+
* <li>
|
|
1270
|
+
* <p>
|
|
1271
|
+
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
|
|
1272
|
+
* models of other asset models. You can't create assets directly from this type of asset model. </p>
|
|
1273
|
+
* </li>
|
|
1274
|
+
* </ul>
|
|
1275
|
+
*/
|
|
1276
|
+
type: string | undefined;
|
|
1277
|
+
/**
|
|
1278
|
+
* @public
|
|
1279
|
+
* <p>The description of the the composite model that this summary describes..</p>
|
|
1280
|
+
*/
|
|
1281
|
+
description?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* @public
|
|
1284
|
+
* <p>The path that includes all the pieces that make up the composite model.</p>
|
|
1285
|
+
*/
|
|
1286
|
+
path?: AssetModelCompositeModelPathSegment[];
|
|
963
1287
|
}
|
|
964
1288
|
/**
|
|
965
1289
|
* @public
|
|
@@ -970,6 +1294,20 @@ export interface AssetModelHierarchy {
|
|
|
970
1294
|
/**
|
|
971
1295
|
* @public
|
|
972
1296
|
* <p>The ID of the asset model hierarchy. This ID is a <code>hierarchyId</code>.</p>
|
|
1297
|
+
* <ul>
|
|
1298
|
+
* <li>
|
|
1299
|
+
* <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1300
|
+
* to create a <i>new</i> hierarchy: You can specify its ID here, if desired.
|
|
1301
|
+
* IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
1302
|
+
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
1303
|
+
* If you specify your own ID, it must be globally unique.</p>
|
|
1304
|
+
* </li>
|
|
1305
|
+
* <li>
|
|
1306
|
+
* <p>If you are calling UpdateAssetModel to modify an <i>existing</i>
|
|
1307
|
+
* hierarchy: This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
1308
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1309
|
+
* </li>
|
|
1310
|
+
* </ul>
|
|
973
1311
|
*/
|
|
974
1312
|
id?: string;
|
|
975
1313
|
/**
|
|
@@ -980,10 +1318,21 @@ export interface AssetModelHierarchy {
|
|
|
980
1318
|
name: string | undefined;
|
|
981
1319
|
/**
|
|
982
1320
|
* @public
|
|
983
|
-
* <p>The ID of the asset model. All assets in this hierarchy must be instances of the
|
|
984
|
-
*
|
|
1321
|
+
* <p>The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the
|
|
1322
|
+
* <code>childAssetModelId</code> asset model. IoT SiteWise will always return the actual
|
|
1323
|
+
* asset model ID for this value. However, when you are specifying this value as part of a call to
|
|
1324
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>, you may provide either the asset model ID or else <code>externalId:</code>
|
|
1325
|
+
* followed by the asset model's external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.
|
|
1326
|
+
* </p>
|
|
985
1327
|
*/
|
|
986
1328
|
childAssetModelId: string | undefined;
|
|
1329
|
+
/**
|
|
1330
|
+
* @public
|
|
1331
|
+
* <p>The external ID (if any) provided in the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html">CreateAssetModel</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
|
|
1332
|
+
* operation. You can assign an external ID by specifying
|
|
1333
|
+
* this value as part of a call to <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>. However, you can't change the external ID if one is already assigned. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1334
|
+
*/
|
|
1335
|
+
externalId?: string;
|
|
987
1336
|
}
|
|
988
1337
|
/**
|
|
989
1338
|
* @public
|
|
@@ -999,9 +1348,23 @@ export interface AssetModelHierarchyDefinition {
|
|
|
999
1348
|
name: string | undefined;
|
|
1000
1349
|
/**
|
|
1001
1350
|
* @public
|
|
1002
|
-
* <p>The ID of an asset model for this hierarchy
|
|
1351
|
+
* <p>The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
1352
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1003
1353
|
*/
|
|
1004
1354
|
childAssetModelId: string | undefined;
|
|
1355
|
+
/**
|
|
1356
|
+
* @public
|
|
1357
|
+
* <p>The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
1358
|
+
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
1359
|
+
* If you specify your own ID, it must be globally unique.</p>
|
|
1360
|
+
*/
|
|
1361
|
+
id?: string;
|
|
1362
|
+
/**
|
|
1363
|
+
* @public
|
|
1364
|
+
* <p>An external ID to assign to the asset model hierarchy. The external ID must be unique among
|
|
1365
|
+
* asset model hierarchies within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1366
|
+
*/
|
|
1367
|
+
externalId?: string;
|
|
1005
1368
|
}
|
|
1006
1369
|
/**
|
|
1007
1370
|
* @public
|
|
@@ -1047,6 +1410,16 @@ export interface AssetModelPropertySummary {
|
|
|
1047
1410
|
* </p>
|
|
1048
1411
|
*/
|
|
1049
1412
|
assetModelCompositeModelId?: string;
|
|
1413
|
+
/**
|
|
1414
|
+
* @public
|
|
1415
|
+
* <p>The structured path to the property from the root of the asset model.</p>
|
|
1416
|
+
*/
|
|
1417
|
+
path?: AssetModelPropertyPathSegment[];
|
|
1418
|
+
/**
|
|
1419
|
+
* @public
|
|
1420
|
+
* <p>The external ID of the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1421
|
+
*/
|
|
1422
|
+
externalId?: string;
|
|
1050
1423
|
}
|
|
1051
1424
|
/**
|
|
1052
1425
|
* @public
|
|
@@ -1142,6 +1515,18 @@ export interface AssetModelStatus {
|
|
|
1142
1515
|
*/
|
|
1143
1516
|
error?: ErrorDetails;
|
|
1144
1517
|
}
|
|
1518
|
+
/**
|
|
1519
|
+
* @public
|
|
1520
|
+
* @enum
|
|
1521
|
+
*/
|
|
1522
|
+
export declare const AssetModelType: {
|
|
1523
|
+
readonly ASSET_MODEL: "ASSET_MODEL";
|
|
1524
|
+
readonly COMPONENT_MODEL: "COMPONENT_MODEL";
|
|
1525
|
+
};
|
|
1526
|
+
/**
|
|
1527
|
+
* @public
|
|
1528
|
+
*/
|
|
1529
|
+
export type AssetModelType = (typeof AssetModelType)[keyof typeof AssetModelType];
|
|
1145
1530
|
/**
|
|
1146
1531
|
* @public
|
|
1147
1532
|
* <p>Contains a summary of an asset model.</p>
|
|
@@ -1149,7 +1534,7 @@ export interface AssetModelStatus {
|
|
|
1149
1534
|
export interface AssetModelSummary {
|
|
1150
1535
|
/**
|
|
1151
1536
|
* @public
|
|
1152
|
-
* <p>The ID of the asset model (used with IoT SiteWise
|
|
1537
|
+
* <p>The ID of the asset model (used with IoT SiteWise API operations).</p>
|
|
1153
1538
|
*/
|
|
1154
1539
|
id: string | undefined;
|
|
1155
1540
|
/**
|
|
@@ -1185,6 +1570,28 @@ export interface AssetModelSummary {
|
|
|
1185
1570
|
* <p>The current status of the asset model.</p>
|
|
1186
1571
|
*/
|
|
1187
1572
|
status: AssetModelStatus | undefined;
|
|
1573
|
+
/**
|
|
1574
|
+
* @public
|
|
1575
|
+
* <p>The type of asset model.</p>
|
|
1576
|
+
* <ul>
|
|
1577
|
+
* <li>
|
|
1578
|
+
* <p>
|
|
1579
|
+
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
|
|
1580
|
+
* Can't be included as a component in another asset model.</p>
|
|
1581
|
+
* </li>
|
|
1582
|
+
* <li>
|
|
1583
|
+
* <p>
|
|
1584
|
+
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
|
|
1585
|
+
* models of other asset models. You can't create assets directly from this type of asset model. </p>
|
|
1586
|
+
* </li>
|
|
1587
|
+
* </ul>
|
|
1588
|
+
*/
|
|
1589
|
+
assetModelType?: AssetModelType;
|
|
1590
|
+
/**
|
|
1591
|
+
* @public
|
|
1592
|
+
* <p>The external ID of the asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1593
|
+
*/
|
|
1594
|
+
externalId?: string;
|
|
1188
1595
|
}
|
|
1189
1596
|
/**
|
|
1190
1597
|
* @public
|
|
@@ -1195,7 +1602,7 @@ export interface AssetPropertySummary {
|
|
|
1195
1602
|
* @public
|
|
1196
1603
|
* <p>The ID of the property.</p>
|
|
1197
1604
|
*/
|
|
1198
|
-
id
|
|
1605
|
+
id: string | undefined;
|
|
1199
1606
|
/**
|
|
1200
1607
|
* @public
|
|
1201
1608
|
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
@@ -1224,8 +1631,18 @@ export interface AssetPropertySummary {
|
|
|
1224
1631
|
* </p>
|
|
1225
1632
|
*/
|
|
1226
1633
|
assetCompositeModelId?: string;
|
|
1227
|
-
|
|
1228
|
-
|
|
1634
|
+
/**
|
|
1635
|
+
* @public
|
|
1636
|
+
* <p>The structured path to the property from the root of the asset.</p>
|
|
1637
|
+
*/
|
|
1638
|
+
path?: AssetPropertyPathSegment[];
|
|
1639
|
+
/**
|
|
1640
|
+
* @public
|
|
1641
|
+
* <p>The external ID of the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1642
|
+
*/
|
|
1643
|
+
externalId?: string;
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1229
1646
|
* @public
|
|
1230
1647
|
* <p>Contains a timestamp with optional nanosecond granularity.</p>
|
|
1231
1648
|
*/
|
|
@@ -1254,7 +1671,7 @@ export interface Variant {
|
|
|
1254
1671
|
stringValue?: string;
|
|
1255
1672
|
/**
|
|
1256
1673
|
* @public
|
|
1257
|
-
* <p>Asset property data of type integer (
|
|
1674
|
+
* <p>Asset property data of type integer (number that's greater than or equal to zero).</p>
|
|
1258
1675
|
*/
|
|
1259
1676
|
integerValue?: number;
|
|
1260
1677
|
/**
|
|
@@ -1367,7 +1784,7 @@ export interface AssetStatus {
|
|
|
1367
1784
|
export interface AssetSummary {
|
|
1368
1785
|
/**
|
|
1369
1786
|
* @public
|
|
1370
|
-
* <p>The ID of the asset.</p>
|
|
1787
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
1371
1788
|
*/
|
|
1372
1789
|
id: string | undefined;
|
|
1373
1790
|
/**
|
|
@@ -1413,6 +1830,11 @@ export interface AssetSummary {
|
|
|
1413
1830
|
* <p>A description for the asset.</p>
|
|
1414
1831
|
*/
|
|
1415
1832
|
description?: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* @public
|
|
1835
|
+
* <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1836
|
+
*/
|
|
1837
|
+
externalId?: string;
|
|
1416
1838
|
}
|
|
1417
1839
|
/**
|
|
1418
1840
|
* @public
|
|
@@ -1420,19 +1842,22 @@ export interface AssetSummary {
|
|
|
1420
1842
|
export interface AssociateAssetsRequest {
|
|
1421
1843
|
/**
|
|
1422
1844
|
* @public
|
|
1423
|
-
* <p>The ID of the parent asset
|
|
1845
|
+
* <p>The ID of the parent asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
1846
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1424
1847
|
*/
|
|
1425
1848
|
assetId: string | undefined;
|
|
1426
1849
|
/**
|
|
1427
1850
|
* @public
|
|
1428
|
-
* <p>The ID of a hierarchy in the parent asset's model.
|
|
1851
|
+
* <p>The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
1852
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) Hierarchies allow different groupings
|
|
1429
1853
|
* of assets to be formed that all come from the same asset model. For more information, see
|
|
1430
1854
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1431
1855
|
*/
|
|
1432
1856
|
hierarchyId: string | undefined;
|
|
1433
1857
|
/**
|
|
1434
1858
|
* @public
|
|
1435
|
-
* <p>The ID of the child asset to be associated
|
|
1859
|
+
* <p>The ID of the child asset to be associated. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
1860
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1436
1861
|
*/
|
|
1437
1862
|
childAssetId: string | undefined;
|
|
1438
1863
|
/**
|
|
@@ -1560,7 +1985,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1560
1985
|
export interface AssociatedAssetsSummary {
|
|
1561
1986
|
/**
|
|
1562
1987
|
* @public
|
|
1563
|
-
* <p>The ID of the asset.</p>
|
|
1988
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
1564
1989
|
*/
|
|
1565
1990
|
id: string | undefined;
|
|
1566
1991
|
/**
|
|
@@ -1606,6 +2031,11 @@ export interface AssociatedAssetsSummary {
|
|
|
1606
2031
|
* <p>A description for the asset.</p>
|
|
1607
2032
|
*/
|
|
1608
2033
|
description?: string;
|
|
2034
|
+
/**
|
|
2035
|
+
* @public
|
|
2036
|
+
* <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2037
|
+
*/
|
|
2038
|
+
externalId?: string;
|
|
1609
2039
|
}
|
|
1610
2040
|
/**
|
|
1611
2041
|
* @public
|
|
@@ -1618,12 +2048,14 @@ export interface AssociateTimeSeriesToAssetPropertyRequest {
|
|
|
1618
2048
|
alias: string | undefined;
|
|
1619
2049
|
/**
|
|
1620
2050
|
* @public
|
|
1621
|
-
* <p>The ID of the asset in which the asset property was created
|
|
2051
|
+
* <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
2052
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1622
2053
|
*/
|
|
1623
2054
|
assetId: string | undefined;
|
|
1624
2055
|
/**
|
|
1625
2056
|
* @public
|
|
1626
|
-
* <p>The ID of the asset property
|
|
2057
|
+
* <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
2058
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
1627
2059
|
*/
|
|
1628
2060
|
propertyId: string | undefined;
|
|
1629
2061
|
/**
|
|
@@ -1744,7 +2176,7 @@ export interface BatchGetAssetPropertyAggregatesEntry {
|
|
|
1744
2176
|
assetId?: string;
|
|
1745
2177
|
/**
|
|
1746
2178
|
* @public
|
|
1747
|
-
* <p>The ID of the asset property.</p>
|
|
2179
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
1748
2180
|
*/
|
|
1749
2181
|
propertyId?: string;
|
|
1750
2182
|
/**
|
|
@@ -1989,7 +2421,7 @@ export interface BatchGetAssetPropertyValueEntry {
|
|
|
1989
2421
|
assetId?: string;
|
|
1990
2422
|
/**
|
|
1991
2423
|
* @public
|
|
1992
|
-
* <p>The ID of the asset property.</p>
|
|
2424
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
1993
2425
|
*/
|
|
1994
2426
|
propertyId?: string;
|
|
1995
2427
|
/**
|
|
@@ -2162,7 +2594,7 @@ export interface BatchGetAssetPropertyValueHistoryEntry {
|
|
|
2162
2594
|
assetId?: string;
|
|
2163
2595
|
/**
|
|
2164
2596
|
* @public
|
|
2165
|
-
* <p>The ID of the asset property.</p>
|
|
2597
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
2166
2598
|
*/
|
|
2167
2599
|
propertyId?: string;
|
|
2168
2600
|
/**
|
|
@@ -2522,7 +2954,8 @@ export interface CreateAssetRequest {
|
|
|
2522
2954
|
assetName: string | undefined;
|
|
2523
2955
|
/**
|
|
2524
2956
|
* @public
|
|
2525
|
-
* <p>The ID of the asset model from which to create the asset
|
|
2957
|
+
* <p>The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
2958
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2526
2959
|
*/
|
|
2527
2960
|
assetModelId: string | undefined;
|
|
2528
2961
|
/**
|
|
@@ -2542,6 +2975,18 @@ export interface CreateAssetRequest {
|
|
|
2542
2975
|
* <p>A description for the asset.</p>
|
|
2543
2976
|
*/
|
|
2544
2977
|
assetDescription?: string;
|
|
2978
|
+
/**
|
|
2979
|
+
* @public
|
|
2980
|
+
* <p>The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
2981
|
+
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
2982
|
+
* If you specify your own ID, it must be globally unique.</p>
|
|
2983
|
+
*/
|
|
2984
|
+
assetId?: string;
|
|
2985
|
+
/**
|
|
2986
|
+
* @public
|
|
2987
|
+
* <p>An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2988
|
+
*/
|
|
2989
|
+
assetExternalId?: string;
|
|
2545
2990
|
}
|
|
2546
2991
|
/**
|
|
2547
2992
|
* @public
|
|
@@ -2549,8 +2994,8 @@ export interface CreateAssetRequest {
|
|
|
2549
2994
|
export interface CreateAssetResponse {
|
|
2550
2995
|
/**
|
|
2551
2996
|
* @public
|
|
2552
|
-
* <p>The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other
|
|
2553
|
-
* IoT SiteWise
|
|
2997
|
+
* <p>The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other
|
|
2998
|
+
* IoT SiteWise API operations.</p>
|
|
2554
2999
|
*/
|
|
2555
3000
|
assetId: string | undefined;
|
|
2556
3001
|
/**
|
|
@@ -2601,10 +3046,14 @@ export interface CreateAssetModelRequest {
|
|
|
2601
3046
|
assetModelHierarchies?: AssetModelHierarchyDefinition[];
|
|
2602
3047
|
/**
|
|
2603
3048
|
* @public
|
|
2604
|
-
* <p>The composite
|
|
2605
|
-
*
|
|
2606
|
-
*
|
|
2607
|
-
* models to define alarms on this asset model.</p>
|
|
3049
|
+
* <p>The composite models that are part of this asset model. It groups properties
|
|
3050
|
+
* (such as attributes, measurements, transforms, and metrics) and child composite models that
|
|
3051
|
+
* model parts of your industrial equipment. Each composite model has a type that defines the
|
|
3052
|
+
* properties that the composite model supports. Use composite models to define alarms on this asset model.</p>
|
|
3053
|
+
* <note>
|
|
3054
|
+
* <p>When creating custom composite models, you need to use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">CreateAssetModelCompositeModel</a>. For more information,
|
|
3055
|
+
* see <LINK>.</p>
|
|
3056
|
+
* </note>
|
|
2608
3057
|
*/
|
|
2609
3058
|
assetModelCompositeModels?: AssetModelCompositeModelDefinition[];
|
|
2610
3059
|
/**
|
|
@@ -2619,6 +3068,35 @@ export interface CreateAssetModelRequest {
|
|
|
2619
3068
|
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
2620
3069
|
*/
|
|
2621
3070
|
tags?: Record<string, string>;
|
|
3071
|
+
/**
|
|
3072
|
+
* @public
|
|
3073
|
+
* <p>The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
|
|
3074
|
+
* However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
|
|
3075
|
+
* If you specify your own ID, it must be globally unique.</p>
|
|
3076
|
+
*/
|
|
3077
|
+
assetModelId?: string;
|
|
3078
|
+
/**
|
|
3079
|
+
* @public
|
|
3080
|
+
* <p>An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3081
|
+
*/
|
|
3082
|
+
assetModelExternalId?: string;
|
|
3083
|
+
/**
|
|
3084
|
+
* @public
|
|
3085
|
+
* <p>The type of asset model.</p>
|
|
3086
|
+
* <ul>
|
|
3087
|
+
* <li>
|
|
3088
|
+
* <p>
|
|
3089
|
+
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
|
|
3090
|
+
* Can't be included as a component in another asset model.</p>
|
|
3091
|
+
* </li>
|
|
3092
|
+
* <li>
|
|
3093
|
+
* <p>
|
|
3094
|
+
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
|
|
3095
|
+
* models of other asset models. You can't create assets directly from this type of asset model. </p>
|
|
3096
|
+
* </li>
|
|
3097
|
+
* </ul>
|
|
3098
|
+
*/
|
|
3099
|
+
assetModelType?: AssetModelType;
|
|
2622
3100
|
}
|
|
2623
3101
|
/**
|
|
2624
3102
|
* @public
|
|
@@ -2626,7 +3104,7 @@ export interface CreateAssetModelRequest {
|
|
|
2626
3104
|
export interface CreateAssetModelResponse {
|
|
2627
3105
|
/**
|
|
2628
3106
|
* @public
|
|
2629
|
-
* <p>The ID of the asset model. You can use this ID when you call other IoT SiteWise
|
|
3107
|
+
* <p>The ID of the asset model, in UUID format. You can use this ID when you call other IoT SiteWise API operations.</p>
|
|
2630
3108
|
*/
|
|
2631
3109
|
assetModelId: string | undefined;
|
|
2632
3110
|
/**
|
|
@@ -2644,6 +3122,87 @@ export interface CreateAssetModelResponse {
|
|
|
2644
3122
|
*/
|
|
2645
3123
|
assetModelStatus: AssetModelStatus | undefined;
|
|
2646
3124
|
}
|
|
3125
|
+
/**
|
|
3126
|
+
* @public
|
|
3127
|
+
*/
|
|
3128
|
+
export interface CreateAssetModelCompositeModelRequest {
|
|
3129
|
+
/**
|
|
3130
|
+
* @public
|
|
3131
|
+
* <p>The ID of the asset model this composite model is a part of.</p>
|
|
3132
|
+
*/
|
|
3133
|
+
assetModelId: string | undefined;
|
|
3134
|
+
/**
|
|
3135
|
+
* @public
|
|
3136
|
+
* <p>The ID of the parent composite model in this asset model relationship.</p>
|
|
3137
|
+
*/
|
|
3138
|
+
parentAssetModelCompositeModelId?: string;
|
|
3139
|
+
/**
|
|
3140
|
+
* @public
|
|
3141
|
+
* <p>An external ID to assign to the composite model.</p>
|
|
3142
|
+
* <p>If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using
|
|
3143
|
+
* <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p>
|
|
3144
|
+
*/
|
|
3145
|
+
assetModelCompositeModelExternalId?: string;
|
|
3146
|
+
/**
|
|
3147
|
+
* @public
|
|
3148
|
+
* <p>The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However,
|
|
3149
|
+
* if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.</p>
|
|
3150
|
+
*/
|
|
3151
|
+
assetModelCompositeModelId?: string;
|
|
3152
|
+
/**
|
|
3153
|
+
* @public
|
|
3154
|
+
* <p>A description for the composite model.</p>
|
|
3155
|
+
*/
|
|
3156
|
+
assetModelCompositeModelDescription?: string;
|
|
3157
|
+
/**
|
|
3158
|
+
* @public
|
|
3159
|
+
* <p>A unique, friendly name for the composite model.</p>
|
|
3160
|
+
*/
|
|
3161
|
+
assetModelCompositeModelName: string | undefined;
|
|
3162
|
+
/**
|
|
3163
|
+
* @public
|
|
3164
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
|
|
3165
|
+
*/
|
|
3166
|
+
assetModelCompositeModelType: string | undefined;
|
|
3167
|
+
/**
|
|
3168
|
+
* @public
|
|
3169
|
+
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3170
|
+
*/
|
|
3171
|
+
clientToken?: string;
|
|
3172
|
+
/**
|
|
3173
|
+
* @public
|
|
3174
|
+
* <p>The ID of a composite model on this asset.</p>
|
|
3175
|
+
*/
|
|
3176
|
+
composedAssetModelId?: string;
|
|
3177
|
+
/**
|
|
3178
|
+
* @public
|
|
3179
|
+
* <p>The property definitions of the composite model. For more information, see <LINK>.</p>
|
|
3180
|
+
* <p>You can specify up to 200 properties per composite model. For more
|
|
3181
|
+
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3182
|
+
*/
|
|
3183
|
+
assetModelCompositeModelProperties?: AssetModelPropertyDefinition[];
|
|
3184
|
+
}
|
|
3185
|
+
/**
|
|
3186
|
+
* @public
|
|
3187
|
+
*/
|
|
3188
|
+
export interface CreateAssetModelCompositeModelResponse {
|
|
3189
|
+
/**
|
|
3190
|
+
* @public
|
|
3191
|
+
* <p>The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.</p>
|
|
3192
|
+
*/
|
|
3193
|
+
assetModelCompositeModelId: string | undefined;
|
|
3194
|
+
/**
|
|
3195
|
+
* @public
|
|
3196
|
+
* <p>The path to the composite model listing the parent composite models.</p>
|
|
3197
|
+
*/
|
|
3198
|
+
assetModelCompositeModelPath: AssetModelCompositeModelPathSegment[] | undefined;
|
|
3199
|
+
/**
|
|
3200
|
+
* @public
|
|
3201
|
+
* <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
|
|
3202
|
+
* states</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3203
|
+
*/
|
|
3204
|
+
assetModelStatus: AssetModelStatus | undefined;
|
|
3205
|
+
}
|
|
2647
3206
|
/**
|
|
2648
3207
|
* @public
|
|
2649
3208
|
* <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
|
|
@@ -2707,25 +3266,36 @@ export declare const ColumnName: {
|
|
|
2707
3266
|
export type ColumnName = (typeof ColumnName)[keyof typeof ColumnName];
|
|
2708
3267
|
/**
|
|
2709
3268
|
* @public
|
|
2710
|
-
* <p>A .
|
|
3269
|
+
* <p>A .CSV file.</p>
|
|
2711
3270
|
*/
|
|
2712
3271
|
export interface Csv {
|
|
2713
3272
|
/**
|
|
2714
3273
|
* @public
|
|
2715
3274
|
* <p>The column names specified in the .csv file.</p>
|
|
2716
3275
|
*/
|
|
2717
|
-
columnNames
|
|
3276
|
+
columnNames: ColumnName[] | undefined;
|
|
3277
|
+
}
|
|
3278
|
+
/**
|
|
3279
|
+
* @public
|
|
3280
|
+
* <p>A parquet file.</p>
|
|
3281
|
+
*/
|
|
3282
|
+
export interface Parquet {
|
|
2718
3283
|
}
|
|
2719
3284
|
/**
|
|
2720
3285
|
* @public
|
|
2721
|
-
* <p>The file format of the data.</p>
|
|
3286
|
+
* <p>The file format of the data in S3.</p>
|
|
2722
3287
|
*/
|
|
2723
3288
|
export interface FileFormat {
|
|
2724
3289
|
/**
|
|
2725
3290
|
* @public
|
|
2726
|
-
* <p>The .
|
|
3291
|
+
* <p>The file is in .CSV format.</p>
|
|
2727
3292
|
*/
|
|
2728
3293
|
csv?: Csv;
|
|
3294
|
+
/**
|
|
3295
|
+
* @public
|
|
3296
|
+
* <p>The file is in parquet format.</p>
|
|
3297
|
+
*/
|
|
3298
|
+
parquet?: Parquet;
|
|
2729
3299
|
}
|
|
2730
3300
|
/**
|
|
2731
3301
|
* @public
|
|
@@ -2734,7 +3304,7 @@ export interface FileFormat {
|
|
|
2734
3304
|
export interface JobConfiguration {
|
|
2735
3305
|
/**
|
|
2736
3306
|
* @public
|
|
2737
|
-
* <p>The file format of the data in
|
|
3307
|
+
* <p>The file format of the data in S3.</p>
|
|
2738
3308
|
*/
|
|
2739
3309
|
fileFormat: FileFormat | undefined;
|
|
2740
3310
|
}
|
|
@@ -2767,6 +3337,17 @@ export interface CreateBulkImportJobRequest {
|
|
|
2767
3337
|
* <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
|
|
2768
3338
|
*/
|
|
2769
3339
|
jobConfiguration: JobConfiguration | undefined;
|
|
3340
|
+
/**
|
|
3341
|
+
* @public
|
|
3342
|
+
* <p>If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are
|
|
3343
|
+
* computed. If set to false, historical data is ingested into IoT SiteWise as is.</p>
|
|
3344
|
+
*/
|
|
3345
|
+
adaptiveIngestion?: boolean;
|
|
3346
|
+
/**
|
|
3347
|
+
* @public
|
|
3348
|
+
* <p>If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.</p>
|
|
3349
|
+
*/
|
|
3350
|
+
deleteFilesAfterImport?: boolean;
|
|
2770
3351
|
}
|
|
2771
3352
|
/**
|
|
2772
3353
|
* @public
|
|
@@ -2800,7 +3381,7 @@ export interface CreateBulkImportJobResponse {
|
|
|
2800
3381
|
jobName: string | undefined;
|
|
2801
3382
|
/**
|
|
2802
3383
|
* @public
|
|
2803
|
-
* <p>The status of the bulk import job can be one of following values
|
|
3384
|
+
* <p>The status of the bulk import job can be one of following values:</p>
|
|
2804
3385
|
* <ul>
|
|
2805
3386
|
* <li>
|
|
2806
3387
|
* <p>
|
|
@@ -2963,7 +3544,7 @@ export interface CreateGatewayRequest {
|
|
|
2963
3544
|
export interface CreateGatewayResponse {
|
|
2964
3545
|
/**
|
|
2965
3546
|
* @public
|
|
2966
|
-
* <p>The ID of the gateway device. You can use this ID when you call other IoT SiteWise
|
|
3547
|
+
* <p>The ID of the gateway device. You can use this ID when you call other IoT SiteWise API operations.</p>
|
|
2967
3548
|
*/
|
|
2968
3549
|
gatewayId: string | undefined;
|
|
2969
3550
|
/**
|
|
@@ -3054,7 +3635,7 @@ export interface CreatePortalRequest {
|
|
|
3054
3635
|
* <ul>
|
|
3055
3636
|
* <li>
|
|
3056
3637
|
* <p>
|
|
3057
|
-
* <code>SSO</code> – The portal uses IAM Identity Center
|
|
3638
|
+
* <code>SSO</code> – The portal uses IAM Identity Center to authenticate users and manage
|
|
3058
3639
|
* user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center.
|
|
3059
3640
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso">Enabling IAM Identity Center</a> in the
|
|
3060
3641
|
* <i>IoT SiteWise User Guide</i>. This option is only available in Amazon Web Services Regions other than
|
|
@@ -3261,7 +3842,8 @@ export interface DeleteAccessPolicyResponse {
|
|
|
3261
3842
|
export interface DeleteAssetRequest {
|
|
3262
3843
|
/**
|
|
3263
3844
|
* @public
|
|
3264
|
-
* <p>The ID of the asset to delete
|
|
3845
|
+
* <p>The ID of the asset to delete. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
3846
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3265
3847
|
*/
|
|
3266
3848
|
assetId: string | undefined;
|
|
3267
3849
|
/**
|
|
@@ -3287,7 +3869,8 @@ export interface DeleteAssetResponse {
|
|
|
3287
3869
|
export interface DeleteAssetModelRequest {
|
|
3288
3870
|
/**
|
|
3289
3871
|
* @public
|
|
3290
|
-
* <p>The ID of the asset model to delete
|
|
3872
|
+
* <p>The ID of the asset model to delete. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
3873
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3291
3874
|
*/
|
|
3292
3875
|
assetModelId: string | undefined;
|
|
3293
3876
|
/**
|
|
@@ -3307,6 +3890,37 @@ export interface DeleteAssetModelResponse {
|
|
|
3307
3890
|
*/
|
|
3308
3891
|
assetModelStatus: AssetModelStatus | undefined;
|
|
3309
3892
|
}
|
|
3893
|
+
/**
|
|
3894
|
+
* @public
|
|
3895
|
+
*/
|
|
3896
|
+
export interface DeleteAssetModelCompositeModelRequest {
|
|
3897
|
+
/**
|
|
3898
|
+
* @public
|
|
3899
|
+
* <p>The ID of the asset model, in UUID format.</p>
|
|
3900
|
+
*/
|
|
3901
|
+
assetModelId: string | undefined;
|
|
3902
|
+
/**
|
|
3903
|
+
* @public
|
|
3904
|
+
* <p>The ID of a composite model on this asset model.</p>
|
|
3905
|
+
*/
|
|
3906
|
+
assetModelCompositeModelId: string | undefined;
|
|
3907
|
+
/**
|
|
3908
|
+
* @public
|
|
3909
|
+
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
3910
|
+
*/
|
|
3911
|
+
clientToken?: string;
|
|
3912
|
+
}
|
|
3913
|
+
/**
|
|
3914
|
+
* @public
|
|
3915
|
+
*/
|
|
3916
|
+
export interface DeleteAssetModelCompositeModelResponse {
|
|
3917
|
+
/**
|
|
3918
|
+
* @public
|
|
3919
|
+
* <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
|
|
3920
|
+
* states</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3921
|
+
*/
|
|
3922
|
+
assetModelStatus: AssetModelStatus | undefined;
|
|
3923
|
+
}
|
|
3310
3924
|
/**
|
|
3311
3925
|
* @public
|
|
3312
3926
|
*/
|
|
@@ -3394,12 +4008,14 @@ export interface DeleteTimeSeriesRequest {
|
|
|
3394
4008
|
alias?: string;
|
|
3395
4009
|
/**
|
|
3396
4010
|
* @public
|
|
3397
|
-
* <p>The ID of the asset in which the asset property was created
|
|
4011
|
+
* <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4012
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3398
4013
|
*/
|
|
3399
4014
|
assetId?: string;
|
|
3400
4015
|
/**
|
|
3401
4016
|
* @public
|
|
3402
|
-
* <p>The ID of the asset property
|
|
4017
|
+
* <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4018
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3403
4019
|
*/
|
|
3404
4020
|
propertyId?: string;
|
|
3405
4021
|
/**
|
|
@@ -3464,13 +4080,54 @@ export interface DescribeAccessPolicyResponse {
|
|
|
3464
4080
|
*/
|
|
3465
4081
|
accessPolicyLastUpdateDate: Date | undefined;
|
|
3466
4082
|
}
|
|
4083
|
+
/**
|
|
4084
|
+
* @public
|
|
4085
|
+
*/
|
|
4086
|
+
export interface DescribeActionRequest {
|
|
4087
|
+
/**
|
|
4088
|
+
* @public
|
|
4089
|
+
* <p>The ID of the action.</p>
|
|
4090
|
+
*/
|
|
4091
|
+
actionId: string | undefined;
|
|
4092
|
+
}
|
|
4093
|
+
/**
|
|
4094
|
+
* @public
|
|
4095
|
+
*/
|
|
4096
|
+
export interface DescribeActionResponse {
|
|
4097
|
+
/**
|
|
4098
|
+
* @public
|
|
4099
|
+
* <p>The ID of the action.</p>
|
|
4100
|
+
*/
|
|
4101
|
+
actionId: string | undefined;
|
|
4102
|
+
/**
|
|
4103
|
+
* @public
|
|
4104
|
+
* <p>The resource the action will be taken on.</p>
|
|
4105
|
+
*/
|
|
4106
|
+
targetResource: TargetResource | undefined;
|
|
4107
|
+
/**
|
|
4108
|
+
* @public
|
|
4109
|
+
* <p>The ID of the action definition.</p>
|
|
4110
|
+
*/
|
|
4111
|
+
actionDefinitionId: string | undefined;
|
|
4112
|
+
/**
|
|
4113
|
+
* @public
|
|
4114
|
+
* <p>The JSON payload of the action.</p>
|
|
4115
|
+
*/
|
|
4116
|
+
actionPayload: ActionPayload | undefined;
|
|
4117
|
+
/**
|
|
4118
|
+
* @public
|
|
4119
|
+
* <p>The time the action was executed.</p>
|
|
4120
|
+
*/
|
|
4121
|
+
executionTime: Date | undefined;
|
|
4122
|
+
}
|
|
3467
4123
|
/**
|
|
3468
4124
|
* @public
|
|
3469
4125
|
*/
|
|
3470
4126
|
export interface DescribeAssetRequest {
|
|
3471
4127
|
/**
|
|
3472
4128
|
* @public
|
|
3473
|
-
* <p>The ID of the asset
|
|
4129
|
+
* <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4130
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3474
4131
|
*/
|
|
3475
4132
|
assetId: string | undefined;
|
|
3476
4133
|
/**
|
|
@@ -3487,7 +4144,7 @@ export interface DescribeAssetRequest {
|
|
|
3487
4144
|
export interface DescribeAssetResponse {
|
|
3488
4145
|
/**
|
|
3489
4146
|
* @public
|
|
3490
|
-
* <p>The ID of the asset.</p>
|
|
4147
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
3491
4148
|
*/
|
|
3492
4149
|
assetId: string | undefined;
|
|
3493
4150
|
/**
|
|
@@ -3545,6 +4202,91 @@ export interface DescribeAssetResponse {
|
|
|
3545
4202
|
* <p>A description for the asset.</p>
|
|
3546
4203
|
*/
|
|
3547
4204
|
assetDescription?: string;
|
|
4205
|
+
/**
|
|
4206
|
+
* @public
|
|
4207
|
+
* <p>The list of the immediate child custom composite model summaries for the asset.</p>
|
|
4208
|
+
*/
|
|
4209
|
+
assetCompositeModelSummaries?: AssetCompositeModelSummary[];
|
|
4210
|
+
/**
|
|
4211
|
+
* @public
|
|
4212
|
+
* <p>The external ID of the asset, if any.</p>
|
|
4213
|
+
*/
|
|
4214
|
+
assetExternalId?: string;
|
|
4215
|
+
}
|
|
4216
|
+
/**
|
|
4217
|
+
* @public
|
|
4218
|
+
*/
|
|
4219
|
+
export interface DescribeAssetCompositeModelRequest {
|
|
4220
|
+
/**
|
|
4221
|
+
* @public
|
|
4222
|
+
* <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4223
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4224
|
+
*/
|
|
4225
|
+
assetId: string | undefined;
|
|
4226
|
+
/**
|
|
4227
|
+
* @public
|
|
4228
|
+
* <p>The ID of a composite model on this asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4229
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4230
|
+
*/
|
|
4231
|
+
assetCompositeModelId: string | undefined;
|
|
4232
|
+
}
|
|
4233
|
+
/**
|
|
4234
|
+
* @public
|
|
4235
|
+
*/
|
|
4236
|
+
export interface DescribeAssetCompositeModelResponse {
|
|
4237
|
+
/**
|
|
4238
|
+
* @public
|
|
4239
|
+
* <p>The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other
|
|
4240
|
+
* IoT SiteWise APIs.</p>
|
|
4241
|
+
*/
|
|
4242
|
+
assetId: string | undefined;
|
|
4243
|
+
/**
|
|
4244
|
+
* @public
|
|
4245
|
+
* <p>The ID of a composite model on this asset.</p>
|
|
4246
|
+
*/
|
|
4247
|
+
assetCompositeModelId: string | undefined;
|
|
4248
|
+
/**
|
|
4249
|
+
* @public
|
|
4250
|
+
* <p>An external ID to assign to the asset model.</p>
|
|
4251
|
+
* <p>If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using
|
|
4252
|
+
* <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p>
|
|
4253
|
+
*/
|
|
4254
|
+
assetCompositeModelExternalId?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
* @public
|
|
4257
|
+
* <p>The path to the composite model listing the parent composite models.</p>
|
|
4258
|
+
*/
|
|
4259
|
+
assetCompositeModelPath: AssetCompositeModelPathSegment[] | undefined;
|
|
4260
|
+
/**
|
|
4261
|
+
* @public
|
|
4262
|
+
* <p>The unique, friendly name for the composite model.</p>
|
|
4263
|
+
*/
|
|
4264
|
+
assetCompositeModelName: string | undefined;
|
|
4265
|
+
/**
|
|
4266
|
+
* @public
|
|
4267
|
+
* <p>A description for the composite model.</p>
|
|
4268
|
+
*/
|
|
4269
|
+
assetCompositeModelDescription: string | undefined;
|
|
4270
|
+
/**
|
|
4271
|
+
* @public
|
|
4272
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
|
|
4273
|
+
*/
|
|
4274
|
+
assetCompositeModelType: string | undefined;
|
|
4275
|
+
/**
|
|
4276
|
+
* @public
|
|
4277
|
+
* <p>The property definitions of the composite model that was used to create the asset.</p>
|
|
4278
|
+
*/
|
|
4279
|
+
assetCompositeModelProperties: AssetProperty[] | undefined;
|
|
4280
|
+
/**
|
|
4281
|
+
* @public
|
|
4282
|
+
* <p>The list of composite model summaries.</p>
|
|
4283
|
+
*/
|
|
4284
|
+
assetCompositeModelSummaries: AssetCompositeModelSummary[] | undefined;
|
|
4285
|
+
/**
|
|
4286
|
+
* @public
|
|
4287
|
+
* <p>The available actions for a composite model on this asset.</p>
|
|
4288
|
+
*/
|
|
4289
|
+
actionDefinitions?: ActionDefinition[];
|
|
3548
4290
|
}
|
|
3549
4291
|
/**
|
|
3550
4292
|
* @public
|
|
@@ -3552,7 +4294,8 @@ export interface DescribeAssetResponse {
|
|
|
3552
4294
|
export interface DescribeAssetModelRequest {
|
|
3553
4295
|
/**
|
|
3554
4296
|
* @public
|
|
3555
|
-
* <p>The ID of the asset model
|
|
4297
|
+
* <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4298
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3556
4299
|
*/
|
|
3557
4300
|
assetModelId: string | undefined;
|
|
3558
4301
|
/**
|
|
@@ -3569,7 +4312,7 @@ export interface DescribeAssetModelRequest {
|
|
|
3569
4312
|
export interface DescribeAssetModelResponse {
|
|
3570
4313
|
/**
|
|
3571
4314
|
* @public
|
|
3572
|
-
* <p>The ID of the asset model.</p>
|
|
4315
|
+
* <p>The ID of the asset model, in UUID format.</p>
|
|
3573
4316
|
*/
|
|
3574
4317
|
assetModelId: string | undefined;
|
|
3575
4318
|
/**
|
|
@@ -3606,7 +4349,7 @@ export interface DescribeAssetModelResponse {
|
|
|
3606
4349
|
assetModelHierarchies: AssetModelHierarchy[] | undefined;
|
|
3607
4350
|
/**
|
|
3608
4351
|
* @public
|
|
3609
|
-
* <p>The list of composite
|
|
4352
|
+
* <p>The list of built-in composite models for the asset model, such as those with those of type <code>AWS/ALARMS</code>.</p>
|
|
3610
4353
|
*/
|
|
3611
4354
|
assetModelCompositeModels?: AssetModelCompositeModel[];
|
|
3612
4355
|
/**
|
|
@@ -3625,40 +4368,173 @@ export interface DescribeAssetModelResponse {
|
|
|
3625
4368
|
* message.</p>
|
|
3626
4369
|
*/
|
|
3627
4370
|
assetModelStatus: AssetModelStatus | undefined;
|
|
4371
|
+
/**
|
|
4372
|
+
* @public
|
|
4373
|
+
* <p>The type of asset model.</p>
|
|
4374
|
+
* <ul>
|
|
4375
|
+
* <li>
|
|
4376
|
+
* <p>
|
|
4377
|
+
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
|
|
4378
|
+
* Can't be included as a component in another asset model.</p>
|
|
4379
|
+
* </li>
|
|
4380
|
+
* <li>
|
|
4381
|
+
* <p>
|
|
4382
|
+
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
|
|
4383
|
+
* models of other asset models. You can't create assets directly from this type of asset model. </p>
|
|
4384
|
+
* </li>
|
|
4385
|
+
* </ul>
|
|
4386
|
+
*/
|
|
4387
|
+
assetModelType?: AssetModelType;
|
|
4388
|
+
/**
|
|
4389
|
+
* @public
|
|
4390
|
+
* <p>The list of the immediate child custom composite model summaries for the asset model.</p>
|
|
4391
|
+
*/
|
|
4392
|
+
assetModelCompositeModelSummaries?: AssetModelCompositeModelSummary[];
|
|
4393
|
+
/**
|
|
4394
|
+
* @public
|
|
4395
|
+
* <p>The external ID of the asset model, if any.</p>
|
|
4396
|
+
*/
|
|
4397
|
+
assetModelExternalId?: string;
|
|
3628
4398
|
}
|
|
3629
4399
|
/**
|
|
3630
4400
|
* @public
|
|
3631
4401
|
*/
|
|
3632
|
-
export interface
|
|
4402
|
+
export interface DescribeAssetModelCompositeModelRequest {
|
|
3633
4403
|
/**
|
|
3634
4404
|
* @public
|
|
3635
|
-
* <p>The ID of the asset
|
|
4405
|
+
* <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4406
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3636
4407
|
*/
|
|
3637
|
-
|
|
4408
|
+
assetModelId: string | undefined;
|
|
3638
4409
|
/**
|
|
3639
4410
|
* @public
|
|
3640
|
-
* <p>The ID of
|
|
4411
|
+
* <p>The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4412
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3641
4413
|
*/
|
|
3642
|
-
|
|
4414
|
+
assetModelCompositeModelId: string | undefined;
|
|
3643
4415
|
}
|
|
3644
4416
|
/**
|
|
3645
4417
|
* @public
|
|
3646
|
-
* <p>
|
|
4418
|
+
* <p>Represents a composite model that composed an asset model of type <code>COMPONENT_MODEL</code>.</p>
|
|
3647
4419
|
*/
|
|
3648
|
-
export interface
|
|
4420
|
+
export interface CompositionRelationshipItem {
|
|
3649
4421
|
/**
|
|
3650
4422
|
* @public
|
|
3651
|
-
* <p>The ID of the
|
|
4423
|
+
* <p>The ID of the component.</p>
|
|
3652
4424
|
*/
|
|
3653
|
-
id
|
|
4425
|
+
id?: string;
|
|
4426
|
+
}
|
|
4427
|
+
/**
|
|
4428
|
+
* @public
|
|
4429
|
+
* <p>Metadata for the composition relationship established by using <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
|
|
4430
|
+
* <code>CreateAssetModelCompositeModel</code>
|
|
4431
|
+
* </a>.</p>
|
|
4432
|
+
*/
|
|
4433
|
+
export interface CompositionDetails {
|
|
3654
4434
|
/**
|
|
3655
4435
|
* @public
|
|
3656
|
-
* <p>
|
|
4436
|
+
* <p>An array detailing the composition relationship for this composite model.</p>
|
|
3657
4437
|
*/
|
|
3658
|
-
|
|
4438
|
+
compositionRelationship?: CompositionRelationshipItem[];
|
|
4439
|
+
}
|
|
4440
|
+
/**
|
|
4441
|
+
* @public
|
|
4442
|
+
*/
|
|
4443
|
+
export interface DescribeAssetModelCompositeModelResponse {
|
|
3659
4444
|
/**
|
|
3660
4445
|
* @public
|
|
3661
|
-
* <p>The
|
|
4446
|
+
* <p>The ID of the asset model, in UUID format.</p>
|
|
4447
|
+
*/
|
|
4448
|
+
assetModelId: string | undefined;
|
|
4449
|
+
/**
|
|
4450
|
+
* @public
|
|
4451
|
+
* <p>The ID of a composite model on this asset model.</p>
|
|
4452
|
+
*/
|
|
4453
|
+
assetModelCompositeModelId: string | undefined;
|
|
4454
|
+
/**
|
|
4455
|
+
* @public
|
|
4456
|
+
* <p>The external ID of a composite model on this asset model.</p>
|
|
4457
|
+
*/
|
|
4458
|
+
assetModelCompositeModelExternalId?: string;
|
|
4459
|
+
/**
|
|
4460
|
+
* @public
|
|
4461
|
+
* <p>The path to the composite model listing the parent composite models.</p>
|
|
4462
|
+
*/
|
|
4463
|
+
assetModelCompositeModelPath: AssetModelCompositeModelPathSegment[] | undefined;
|
|
4464
|
+
/**
|
|
4465
|
+
* @public
|
|
4466
|
+
* <p>The unique, friendly name for the composite model.</p>
|
|
4467
|
+
*/
|
|
4468
|
+
assetModelCompositeModelName: string | undefined;
|
|
4469
|
+
/**
|
|
4470
|
+
* @public
|
|
4471
|
+
* <p>The description for the composite model.</p>
|
|
4472
|
+
*/
|
|
4473
|
+
assetModelCompositeModelDescription: string | undefined;
|
|
4474
|
+
/**
|
|
4475
|
+
* @public
|
|
4476
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
|
|
4477
|
+
*/
|
|
4478
|
+
assetModelCompositeModelType: string | undefined;
|
|
4479
|
+
/**
|
|
4480
|
+
* @public
|
|
4481
|
+
* <p>The property definitions of the composite model.</p>
|
|
4482
|
+
*/
|
|
4483
|
+
assetModelCompositeModelProperties: AssetModelProperty[] | undefined;
|
|
4484
|
+
/**
|
|
4485
|
+
* @public
|
|
4486
|
+
* <p>Metadata for the composition relationship established by using <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
|
|
4487
|
+
* <code>CreateAssetModelCompositeModel</code>
|
|
4488
|
+
* </a>.
|
|
4489
|
+
* For instance, an array detailing the path of the composition relationship for this composite model.</p>
|
|
4490
|
+
*/
|
|
4491
|
+
compositionDetails?: CompositionDetails;
|
|
4492
|
+
/**
|
|
4493
|
+
* @public
|
|
4494
|
+
* <p>The list of composite model summaries for the composite model.</p>
|
|
4495
|
+
*/
|
|
4496
|
+
assetModelCompositeModelSummaries: AssetModelCompositeModelSummary[] | undefined;
|
|
4497
|
+
/**
|
|
4498
|
+
* @public
|
|
4499
|
+
* <p>The available actions for a composite model on this asset model.</p>
|
|
4500
|
+
*/
|
|
4501
|
+
actionDefinitions?: ActionDefinition[];
|
|
4502
|
+
}
|
|
4503
|
+
/**
|
|
4504
|
+
* @public
|
|
4505
|
+
*/
|
|
4506
|
+
export interface DescribeAssetPropertyRequest {
|
|
4507
|
+
/**
|
|
4508
|
+
* @public
|
|
4509
|
+
* <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4510
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4511
|
+
*/
|
|
4512
|
+
assetId: string | undefined;
|
|
4513
|
+
/**
|
|
4514
|
+
* @public
|
|
4515
|
+
* <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
4516
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4517
|
+
*/
|
|
4518
|
+
propertyId: string | undefined;
|
|
4519
|
+
}
|
|
4520
|
+
/**
|
|
4521
|
+
* @public
|
|
4522
|
+
* <p>Contains asset property information.</p>
|
|
4523
|
+
*/
|
|
4524
|
+
export interface Property {
|
|
4525
|
+
/**
|
|
4526
|
+
* @public
|
|
4527
|
+
* <p>The ID of the asset property.</p>
|
|
4528
|
+
*/
|
|
4529
|
+
id: string | undefined;
|
|
4530
|
+
/**
|
|
4531
|
+
* @public
|
|
4532
|
+
* <p>The name of the property.</p>
|
|
4533
|
+
*/
|
|
4534
|
+
name: string | undefined;
|
|
4535
|
+
/**
|
|
4536
|
+
* @public
|
|
4537
|
+
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
3662
4538
|
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
3663
4539
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
|
|
3664
4540
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -3684,6 +4560,16 @@ export interface Property {
|
|
|
3684
4560
|
* <p>The property type (see <code>PropertyType</code>). A property contains one type.</p>
|
|
3685
4561
|
*/
|
|
3686
4562
|
type?: PropertyType;
|
|
4563
|
+
/**
|
|
4564
|
+
* @public
|
|
4565
|
+
* <p>The structured path to the property from the root of the asset.</p>
|
|
4566
|
+
*/
|
|
4567
|
+
path?: AssetPropertyPathSegment[];
|
|
4568
|
+
/**
|
|
4569
|
+
* @public
|
|
4570
|
+
* <p>The external ID of the asset property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4571
|
+
*/
|
|
4572
|
+
externalId?: string;
|
|
3687
4573
|
}
|
|
3688
4574
|
/**
|
|
3689
4575
|
* @public
|
|
@@ -3712,6 +4598,11 @@ export interface CompositeModelProperty {
|
|
|
3712
4598
|
* </p>
|
|
3713
4599
|
*/
|
|
3714
4600
|
id?: string;
|
|
4601
|
+
/**
|
|
4602
|
+
* @public
|
|
4603
|
+
* <p>The external ID of the composite model that contains the property. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4604
|
+
*/
|
|
4605
|
+
externalId?: string;
|
|
3715
4606
|
}
|
|
3716
4607
|
/**
|
|
3717
4608
|
* @public
|
|
@@ -3719,7 +4610,7 @@ export interface CompositeModelProperty {
|
|
|
3719
4610
|
export interface DescribeAssetPropertyResponse {
|
|
3720
4611
|
/**
|
|
3721
4612
|
* @public
|
|
3722
|
-
* <p>The ID of the asset.</p>
|
|
4613
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
3723
4614
|
*/
|
|
3724
4615
|
assetId: string | undefined;
|
|
3725
4616
|
/**
|
|
@@ -3729,7 +4620,7 @@ export interface DescribeAssetPropertyResponse {
|
|
|
3729
4620
|
assetName: string | undefined;
|
|
3730
4621
|
/**
|
|
3731
4622
|
* @public
|
|
3732
|
-
* <p>The ID of the asset model.</p>
|
|
4623
|
+
* <p>The ID of the asset model, in UUID format.</p>
|
|
3733
4624
|
*/
|
|
3734
4625
|
assetModelId: string | undefined;
|
|
3735
4626
|
/**
|
|
@@ -3742,10 +4633,15 @@ export interface DescribeAssetPropertyResponse {
|
|
|
3742
4633
|
assetProperty?: Property;
|
|
3743
4634
|
/**
|
|
3744
4635
|
* @public
|
|
3745
|
-
* <p>The composite
|
|
4636
|
+
* <p>The composite model that declares this asset property, if this asset property exists
|
|
3746
4637
|
* in a composite model.</p>
|
|
3747
4638
|
*/
|
|
3748
4639
|
compositeModel?: CompositeModelProperty;
|
|
4640
|
+
/**
|
|
4641
|
+
* @public
|
|
4642
|
+
* <p>The external ID of the asset. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4643
|
+
*/
|
|
4644
|
+
assetExternalId?: string;
|
|
3749
4645
|
}
|
|
3750
4646
|
/**
|
|
3751
4647
|
* @public
|
|
@@ -3773,7 +4669,7 @@ export interface DescribeBulkImportJobResponse {
|
|
|
3773
4669
|
jobName: string | undefined;
|
|
3774
4670
|
/**
|
|
3775
4671
|
* @public
|
|
3776
|
-
* <p>The status of the bulk import job can be one of following values
|
|
4672
|
+
* <p>The status of the bulk import job can be one of following values:</p>
|
|
3777
4673
|
* <ul>
|
|
3778
4674
|
* <li>
|
|
3779
4675
|
* <p>
|
|
@@ -3834,6 +4730,17 @@ export interface DescribeBulkImportJobResponse {
|
|
|
3834
4730
|
* <p>The date the job was last updated, in Unix epoch time.</p>
|
|
3835
4731
|
*/
|
|
3836
4732
|
jobLastUpdateDate: Date | undefined;
|
|
4733
|
+
/**
|
|
4734
|
+
* @public
|
|
4735
|
+
* <p>If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are
|
|
4736
|
+
* computed. If set to false, historical data is ingested into IoT SiteWise as is.</p>
|
|
4737
|
+
*/
|
|
4738
|
+
adaptiveIngestion?: boolean;
|
|
4739
|
+
/**
|
|
4740
|
+
* @public
|
|
4741
|
+
* <p>If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.</p>
|
|
4742
|
+
*/
|
|
4743
|
+
deleteFilesAfterImport?: boolean;
|
|
3837
4744
|
}
|
|
3838
4745
|
/**
|
|
3839
4746
|
* @public
|
|
@@ -4236,7 +5143,7 @@ export interface DescribePortalResponse {
|
|
|
4236
5143
|
portalDescription?: string;
|
|
4237
5144
|
/**
|
|
4238
5145
|
* @public
|
|
4239
|
-
* <p>The IAM Identity Center application generated client ID (used with IAM Identity Center
|
|
5146
|
+
* <p>The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes
|
|
4240
5147
|
* <code>portalClientId</code> for only portals that use IAM Identity Center to authenticate users.</p>
|
|
4241
5148
|
*/
|
|
4242
5149
|
portalClientId: string | undefined;
|
|
@@ -4396,7 +5303,7 @@ export interface MultiLayerStorage {
|
|
|
4396
5303
|
}
|
|
4397
5304
|
/**
|
|
4398
5305
|
* @public
|
|
4399
|
-
* <p>
|
|
5306
|
+
* <p>The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
4400
5307
|
*/
|
|
4401
5308
|
export interface RetentionPeriod {
|
|
4402
5309
|
/**
|
|
@@ -4430,6 +5337,34 @@ export declare const StorageType: {
|
|
|
4430
5337
|
* @public
|
|
4431
5338
|
*/
|
|
4432
5339
|
export type StorageType = (typeof StorageType)[keyof typeof StorageType];
|
|
5340
|
+
/**
|
|
5341
|
+
* @public
|
|
5342
|
+
* @enum
|
|
5343
|
+
*/
|
|
5344
|
+
export declare const WarmTierState: {
|
|
5345
|
+
readonly DISABLED: "DISABLED";
|
|
5346
|
+
readonly ENABLED: "ENABLED";
|
|
5347
|
+
};
|
|
5348
|
+
/**
|
|
5349
|
+
* @public
|
|
5350
|
+
*/
|
|
5351
|
+
export type WarmTierState = (typeof WarmTierState)[keyof typeof WarmTierState];
|
|
5352
|
+
/**
|
|
5353
|
+
* @public
|
|
5354
|
+
* <p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>
|
|
5355
|
+
*/
|
|
5356
|
+
export interface WarmTierRetentionPeriod {
|
|
5357
|
+
/**
|
|
5358
|
+
* @public
|
|
5359
|
+
* <p>The number of days the data is stored in the warm tier.</p>
|
|
5360
|
+
*/
|
|
5361
|
+
numberOfDays?: number;
|
|
5362
|
+
/**
|
|
5363
|
+
* @public
|
|
5364
|
+
* <p>If set to true, the data is stored indefinitely in the warm tier.</p>
|
|
5365
|
+
*/
|
|
5366
|
+
unlimited?: boolean;
|
|
5367
|
+
}
|
|
4433
5368
|
/**
|
|
4434
5369
|
* @public
|
|
4435
5370
|
*/
|
|
@@ -4480,7 +5415,7 @@ export interface DescribeStorageConfigurationResponse {
|
|
|
4480
5415
|
disassociatedDataStorage?: DisassociatedDataStorageState;
|
|
4481
5416
|
/**
|
|
4482
5417
|
* @public
|
|
4483
|
-
* <p>
|
|
5418
|
+
* <p>The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
4484
5419
|
*/
|
|
4485
5420
|
retentionPeriod?: RetentionPeriod;
|
|
4486
5421
|
/**
|
|
@@ -4493,6 +5428,16 @@ export interface DescribeStorageConfigurationResponse {
|
|
|
4493
5428
|
* <p>The date the storage configuration was last updated, in Unix epoch time.</p>
|
|
4494
5429
|
*/
|
|
4495
5430
|
lastUpdateDate?: Date;
|
|
5431
|
+
/**
|
|
5432
|
+
* @public
|
|
5433
|
+
* <p>A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.</p>
|
|
5434
|
+
*/
|
|
5435
|
+
warmTier?: WarmTierState;
|
|
5436
|
+
/**
|
|
5437
|
+
* @public
|
|
5438
|
+
* <p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>
|
|
5439
|
+
*/
|
|
5440
|
+
warmTierRetentionPeriod?: WarmTierRetentionPeriod;
|
|
4496
5441
|
}
|
|
4497
5442
|
/**
|
|
4498
5443
|
* @public
|
|
@@ -4505,12 +5450,14 @@ export interface DescribeTimeSeriesRequest {
|
|
|
4505
5450
|
alias?: string;
|
|
4506
5451
|
/**
|
|
4507
5452
|
* @public
|
|
4508
|
-
* <p>The ID of the asset in which the asset property was created
|
|
5453
|
+
* <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5454
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4509
5455
|
*/
|
|
4510
5456
|
assetId?: string;
|
|
4511
5457
|
/**
|
|
4512
5458
|
* @public
|
|
4513
|
-
* <p>The ID of the asset property
|
|
5459
|
+
* <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5460
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4514
5461
|
*/
|
|
4515
5462
|
propertyId?: string;
|
|
4516
5463
|
}
|
|
@@ -4525,7 +5472,7 @@ export interface DescribeTimeSeriesResponse {
|
|
|
4525
5472
|
assetId?: string;
|
|
4526
5473
|
/**
|
|
4527
5474
|
* @public
|
|
4528
|
-
* <p>The ID of the asset property.</p>
|
|
5475
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
4529
5476
|
*/
|
|
4530
5477
|
propertyId?: string;
|
|
4531
5478
|
/**
|
|
@@ -4578,12 +5525,14 @@ export interface DescribeTimeSeriesResponse {
|
|
|
4578
5525
|
export interface DisassociateAssetsRequest {
|
|
4579
5526
|
/**
|
|
4580
5527
|
* @public
|
|
4581
|
-
* <p>The ID of the parent asset from which to disassociate the child asset
|
|
5528
|
+
* <p>The ID of the parent asset from which to disassociate the child asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5529
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4582
5530
|
*/
|
|
4583
5531
|
assetId: string | undefined;
|
|
4584
5532
|
/**
|
|
4585
5533
|
* @public
|
|
4586
|
-
* <p>The ID of a hierarchy in the parent asset's model.
|
|
5534
|
+
* <p>The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5535
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) Hierarchies allow different groupings
|
|
4587
5536
|
* of assets to be formed that all come from the same asset model. You can use the hierarchy ID
|
|
4588
5537
|
* to identify the correct asset to disassociate. For more information, see
|
|
4589
5538
|
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
@@ -4591,7 +5540,8 @@ export interface DisassociateAssetsRequest {
|
|
|
4591
5540
|
hierarchyId: string | undefined;
|
|
4592
5541
|
/**
|
|
4593
5542
|
* @public
|
|
4594
|
-
* <p>The ID of the child asset to disassociate
|
|
5543
|
+
* <p>The ID of the child asset to disassociate. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5544
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4595
5545
|
*/
|
|
4596
5546
|
childAssetId: string | undefined;
|
|
4597
5547
|
/**
|
|
@@ -4611,12 +5561,14 @@ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
|
4611
5561
|
alias: string | undefined;
|
|
4612
5562
|
/**
|
|
4613
5563
|
* @public
|
|
4614
|
-
* <p>The ID of the asset in which the asset property was created
|
|
5564
|
+
* <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5565
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4615
5566
|
*/
|
|
4616
5567
|
assetId: string | undefined;
|
|
4617
5568
|
/**
|
|
4618
5569
|
* @public
|
|
4619
|
-
* <p>The ID of the asset property
|
|
5570
|
+
* <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
5571
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4620
5572
|
*/
|
|
4621
5573
|
propertyId: string | undefined;
|
|
4622
5574
|
/**
|
|
@@ -4625,18 +5577,139 @@ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
|
4625
5577
|
*/
|
|
4626
5578
|
clientToken?: string;
|
|
4627
5579
|
}
|
|
5580
|
+
/**
|
|
5581
|
+
* @public
|
|
5582
|
+
*/
|
|
5583
|
+
export interface ExecuteActionRequest {
|
|
5584
|
+
/**
|
|
5585
|
+
* @public
|
|
5586
|
+
* <p>The resource the action will be taken on.</p>
|
|
5587
|
+
*/
|
|
5588
|
+
targetResource: TargetResource | undefined;
|
|
5589
|
+
/**
|
|
5590
|
+
* @public
|
|
5591
|
+
* <p>The ID of the action definition.</p>
|
|
5592
|
+
*/
|
|
5593
|
+
actionDefinitionId: string | undefined;
|
|
5594
|
+
/**
|
|
5595
|
+
* @public
|
|
5596
|
+
* <p>The JSON payload of the action.</p>
|
|
5597
|
+
*/
|
|
5598
|
+
actionPayload: ActionPayload | undefined;
|
|
5599
|
+
/**
|
|
5600
|
+
* @public
|
|
5601
|
+
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
5602
|
+
*/
|
|
5603
|
+
clientToken?: string;
|
|
5604
|
+
}
|
|
5605
|
+
/**
|
|
5606
|
+
* @public
|
|
5607
|
+
*/
|
|
5608
|
+
export interface ExecuteActionResponse {
|
|
5609
|
+
/**
|
|
5610
|
+
* @public
|
|
5611
|
+
* <p>The ID of the action.</p>
|
|
5612
|
+
*/
|
|
5613
|
+
actionId: string | undefined;
|
|
5614
|
+
}
|
|
5615
|
+
/**
|
|
5616
|
+
* @public
|
|
5617
|
+
*/
|
|
5618
|
+
export interface ExecuteQueryRequest {
|
|
5619
|
+
/**
|
|
5620
|
+
* @public
|
|
5621
|
+
* <p>The IoT SiteWise query statement.</p>
|
|
5622
|
+
*/
|
|
5623
|
+
queryStatement: string | undefined;
|
|
5624
|
+
/**
|
|
5625
|
+
* @public
|
|
5626
|
+
* <p>The string that specifies the next page of results.</p>
|
|
5627
|
+
*/
|
|
5628
|
+
nextToken?: string;
|
|
5629
|
+
/**
|
|
5630
|
+
* @public
|
|
5631
|
+
* <p>The maximum number of results to return at one time. The default is 25.</p>
|
|
5632
|
+
*/
|
|
5633
|
+
maxResults?: number;
|
|
5634
|
+
}
|
|
5635
|
+
/**
|
|
5636
|
+
* @public
|
|
5637
|
+
* @enum
|
|
5638
|
+
*/
|
|
5639
|
+
export declare const ScalarType: {
|
|
5640
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
5641
|
+
readonly DOUBLE: "DOUBLE";
|
|
5642
|
+
readonly INT: "INT";
|
|
5643
|
+
readonly STRING: "STRING";
|
|
5644
|
+
readonly TIMESTAMP: "TIMESTAMP";
|
|
5645
|
+
};
|
|
5646
|
+
/**
|
|
5647
|
+
* @public
|
|
5648
|
+
*/
|
|
5649
|
+
export type ScalarType = (typeof ScalarType)[keyof typeof ScalarType];
|
|
5650
|
+
/**
|
|
5651
|
+
* @public
|
|
5652
|
+
* <p>The data type of the column.</p>
|
|
5653
|
+
*/
|
|
5654
|
+
export interface ColumnType {
|
|
5655
|
+
/**
|
|
5656
|
+
* @public
|
|
5657
|
+
* <p>The allowed data types that the column has as it's value.</p>
|
|
5658
|
+
*/
|
|
5659
|
+
scalarType?: ScalarType;
|
|
5660
|
+
}
|
|
5661
|
+
/**
|
|
5662
|
+
* @public
|
|
5663
|
+
* <p>A description of the column in the query results.</p>
|
|
5664
|
+
*/
|
|
5665
|
+
export interface ColumnInfo {
|
|
5666
|
+
/**
|
|
5667
|
+
* @public
|
|
5668
|
+
* <p>The name of the column description.</p>
|
|
5669
|
+
*/
|
|
5670
|
+
name?: string;
|
|
5671
|
+
/**
|
|
5672
|
+
* @public
|
|
5673
|
+
* <p>The type of the column description.</p>
|
|
5674
|
+
*/
|
|
5675
|
+
type?: ColumnType;
|
|
5676
|
+
}
|
|
5677
|
+
/**
|
|
5678
|
+
* @public
|
|
5679
|
+
* <p>The query timed out.</p>
|
|
5680
|
+
*/
|
|
5681
|
+
export declare class QueryTimeoutException extends __BaseException {
|
|
5682
|
+
readonly name: "QueryTimeoutException";
|
|
5683
|
+
readonly $fault: "client";
|
|
5684
|
+
/**
|
|
5685
|
+
* @internal
|
|
5686
|
+
*/
|
|
5687
|
+
constructor(opts: __ExceptionOptionType<QueryTimeoutException, __BaseException>);
|
|
5688
|
+
}
|
|
5689
|
+
/**
|
|
5690
|
+
* @public
|
|
5691
|
+
* <p>The validation failed for this query.</p>
|
|
5692
|
+
*/
|
|
5693
|
+
export declare class ValidationException extends __BaseException {
|
|
5694
|
+
readonly name: "ValidationException";
|
|
5695
|
+
readonly $fault: "client";
|
|
5696
|
+
/**
|
|
5697
|
+
* @internal
|
|
5698
|
+
*/
|
|
5699
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
5700
|
+
}
|
|
4628
5701
|
/**
|
|
4629
5702
|
* @public
|
|
4630
5703
|
*/
|
|
4631
5704
|
export interface GetAssetPropertyAggregatesRequest {
|
|
4632
5705
|
/**
|
|
4633
5706
|
* @public
|
|
4634
|
-
* <p>The ID of the asset.</p>
|
|
5707
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
4635
5708
|
*/
|
|
4636
5709
|
assetId?: string;
|
|
4637
5710
|
/**
|
|
4638
5711
|
* @public
|
|
4639
|
-
* <p>The ID of the asset property.</p>
|
|
5712
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
4640
5713
|
*/
|
|
4641
5714
|
propertyId?: string;
|
|
4642
5715
|
/**
|
|
@@ -4694,7 +5767,7 @@ export interface GetAssetPropertyAggregatesRequest {
|
|
|
4694
5767
|
* </li>
|
|
4695
5768
|
* <li>
|
|
4696
5769
|
* <p>The number of data points in the result set is equal to the value of
|
|
4697
|
-
* <code>maxResults</code>. The maximum value of <code>maxResults</code> is
|
|
5770
|
+
* <code>maxResults</code>. The maximum value of <code>maxResults</code> is 2500.</p>
|
|
4698
5771
|
* </li>
|
|
4699
5772
|
* </ul>
|
|
4700
5773
|
*/
|
|
@@ -4721,12 +5794,12 @@ export interface GetAssetPropertyAggregatesResponse {
|
|
|
4721
5794
|
export interface GetAssetPropertyValueRequest {
|
|
4722
5795
|
/**
|
|
4723
5796
|
* @public
|
|
4724
|
-
* <p>The ID of the asset.</p>
|
|
5797
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
4725
5798
|
*/
|
|
4726
5799
|
assetId?: string;
|
|
4727
5800
|
/**
|
|
4728
5801
|
* @public
|
|
4729
|
-
* <p>The ID of the asset property.</p>
|
|
5802
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
4730
5803
|
*/
|
|
4731
5804
|
propertyId?: string;
|
|
4732
5805
|
/**
|
|
@@ -4754,12 +5827,12 @@ export interface GetAssetPropertyValueResponse {
|
|
|
4754
5827
|
export interface GetAssetPropertyValueHistoryRequest {
|
|
4755
5828
|
/**
|
|
4756
5829
|
* @public
|
|
4757
|
-
* <p>The ID of the asset.</p>
|
|
5830
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
4758
5831
|
*/
|
|
4759
5832
|
assetId?: string;
|
|
4760
5833
|
/**
|
|
4761
5834
|
* @public
|
|
4762
|
-
* <p>The ID of the asset property.</p>
|
|
5835
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
4763
5836
|
*/
|
|
4764
5837
|
propertyId?: string;
|
|
4765
5838
|
/**
|
|
@@ -4834,12 +5907,12 @@ export interface GetAssetPropertyValueHistoryResponse {
|
|
|
4834
5907
|
export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
4835
5908
|
/**
|
|
4836
5909
|
* @public
|
|
4837
|
-
* <p>The ID of the asset.</p>
|
|
5910
|
+
* <p>The ID of the asset, in UUID format.</p>
|
|
4838
5911
|
*/
|
|
4839
5912
|
assetId?: string;
|
|
4840
5913
|
/**
|
|
4841
5914
|
* @public
|
|
4842
|
-
* <p>The ID of the asset property.</p>
|
|
5915
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
4843
5916
|
*/
|
|
4844
5917
|
propertyId?: string;
|
|
4845
5918
|
/**
|
|
@@ -5076,73 +6149,63 @@ export interface ListAccessPoliciesResponse {
|
|
|
5076
6149
|
* @public
|
|
5077
6150
|
* @enum
|
|
5078
6151
|
*/
|
|
5079
|
-
export declare const
|
|
5080
|
-
readonly
|
|
5081
|
-
readonly BASE: "BASE";
|
|
6152
|
+
export declare const TargetResourceType: {
|
|
6153
|
+
readonly ASSET: "ASSET";
|
|
5082
6154
|
};
|
|
5083
6155
|
/**
|
|
5084
6156
|
* @public
|
|
5085
6157
|
*/
|
|
5086
|
-
export type
|
|
6158
|
+
export type TargetResourceType = (typeof TargetResourceType)[keyof typeof TargetResourceType];
|
|
5087
6159
|
/**
|
|
5088
6160
|
* @public
|
|
5089
6161
|
*/
|
|
5090
|
-
export interface
|
|
6162
|
+
export interface ListActionsRequest {
|
|
5091
6163
|
/**
|
|
5092
6164
|
* @public
|
|
5093
|
-
* <p>The
|
|
6165
|
+
* <p>The type of resource.</p>
|
|
5094
6166
|
*/
|
|
5095
|
-
|
|
6167
|
+
targetResourceType: TargetResourceType | undefined;
|
|
5096
6168
|
/**
|
|
5097
6169
|
* @public
|
|
5098
|
-
* <p>The
|
|
6170
|
+
* <p>The ID of the target resource.</p>
|
|
5099
6171
|
*/
|
|
5100
|
-
|
|
6172
|
+
targetResourceId: string | undefined;
|
|
5101
6173
|
/**
|
|
5102
6174
|
* @public
|
|
5103
|
-
* <p>The
|
|
6175
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
5104
6176
|
*/
|
|
5105
|
-
|
|
6177
|
+
nextToken?: string;
|
|
5106
6178
|
/**
|
|
5107
6179
|
* @public
|
|
5108
|
-
* <p>
|
|
5109
|
-
* options:</p>
|
|
5110
|
-
* <ul>
|
|
5111
|
-
* <li>
|
|
5112
|
-
* <p>
|
|
5113
|
-
* <code>ALL</code> – The list includes all asset model properties for a given asset
|
|
5114
|
-
* model ID. </p>
|
|
5115
|
-
* </li>
|
|
5116
|
-
* <li>
|
|
5117
|
-
* <p>
|
|
5118
|
-
* <code>BASE</code> – The list includes only base asset model properties for a given
|
|
5119
|
-
* asset model ID. </p>
|
|
5120
|
-
* </li>
|
|
5121
|
-
* </ul>
|
|
5122
|
-
* <p>Default: <code>BASE</code>
|
|
5123
|
-
* </p>
|
|
6180
|
+
* <p>The maximum number of results to return for each paginated request.</p>
|
|
5124
6181
|
*/
|
|
5125
|
-
|
|
6182
|
+
maxResults?: number;
|
|
5126
6183
|
}
|
|
5127
6184
|
/**
|
|
5128
6185
|
* @public
|
|
5129
6186
|
*/
|
|
5130
|
-
export interface
|
|
6187
|
+
export interface ListActionsResponse {
|
|
5131
6188
|
/**
|
|
5132
6189
|
* @public
|
|
5133
|
-
* <p>A list that summarizes the
|
|
6190
|
+
* <p>A list that summarizes the actions associated with the specified asset.</p>
|
|
5134
6191
|
*/
|
|
5135
|
-
|
|
6192
|
+
actionSummaries: ActionSummary[] | undefined;
|
|
5136
6193
|
/**
|
|
5137
6194
|
* @public
|
|
5138
6195
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
5139
6196
|
*/
|
|
5140
|
-
nextToken
|
|
6197
|
+
nextToken: string | undefined;
|
|
5141
6198
|
}
|
|
5142
6199
|
/**
|
|
5143
6200
|
* @public
|
|
5144
6201
|
*/
|
|
5145
|
-
export interface
|
|
6202
|
+
export interface ListAssetModelCompositeModelsRequest {
|
|
6203
|
+
/**
|
|
6204
|
+
* @public
|
|
6205
|
+
* <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6206
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6207
|
+
*/
|
|
6208
|
+
assetModelId: string | undefined;
|
|
5146
6209
|
/**
|
|
5147
6210
|
* @public
|
|
5148
6211
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -5158,12 +6221,12 @@ export interface ListAssetModelsRequest {
|
|
|
5158
6221
|
/**
|
|
5159
6222
|
* @public
|
|
5160
6223
|
*/
|
|
5161
|
-
export interface
|
|
6224
|
+
export interface ListAssetModelCompositeModelsResponse {
|
|
5162
6225
|
/**
|
|
5163
6226
|
* @public
|
|
5164
|
-
* <p>A list that summarizes each
|
|
6227
|
+
* <p>A list that summarizes each composite model.</p>
|
|
5165
6228
|
*/
|
|
5166
|
-
|
|
6229
|
+
assetModelCompositeModelSummaries: AssetModelCompositeModelSummary[] | undefined;
|
|
5167
6230
|
/**
|
|
5168
6231
|
* @public
|
|
5169
6232
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
@@ -5174,23 +6237,24 @@ export interface ListAssetModelsResponse {
|
|
|
5174
6237
|
* @public
|
|
5175
6238
|
* @enum
|
|
5176
6239
|
*/
|
|
5177
|
-
export declare const
|
|
6240
|
+
export declare const ListAssetModelPropertiesFilter: {
|
|
5178
6241
|
readonly ALL: "ALL";
|
|
5179
6242
|
readonly BASE: "BASE";
|
|
5180
6243
|
};
|
|
5181
6244
|
/**
|
|
5182
6245
|
* @public
|
|
5183
6246
|
*/
|
|
5184
|
-
export type
|
|
6247
|
+
export type ListAssetModelPropertiesFilter = (typeof ListAssetModelPropertiesFilter)[keyof typeof ListAssetModelPropertiesFilter];
|
|
5185
6248
|
/**
|
|
5186
6249
|
* @public
|
|
5187
6250
|
*/
|
|
5188
|
-
export interface
|
|
6251
|
+
export interface ListAssetModelPropertiesRequest {
|
|
5189
6252
|
/**
|
|
5190
6253
|
* @public
|
|
5191
|
-
* <p>The ID of the asset
|
|
6254
|
+
* <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6255
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5192
6256
|
*/
|
|
5193
|
-
|
|
6257
|
+
assetModelId: string | undefined;
|
|
5194
6258
|
/**
|
|
5195
6259
|
* @public
|
|
5196
6260
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
@@ -5203,7 +6267,123 @@ export interface ListAssetPropertiesRequest {
|
|
|
5203
6267
|
maxResults?: number;
|
|
5204
6268
|
/**
|
|
5205
6269
|
* @public
|
|
5206
|
-
* <p> Filters the requested list of asset properties. You can choose one of the following
|
|
6270
|
+
* <p> Filters the requested list of asset model properties. You can choose one of the following
|
|
6271
|
+
* options:</p>
|
|
6272
|
+
* <ul>
|
|
6273
|
+
* <li>
|
|
6274
|
+
* <p>
|
|
6275
|
+
* <code>ALL</code> – The list includes all asset model properties for a given asset
|
|
6276
|
+
* model ID. </p>
|
|
6277
|
+
* </li>
|
|
6278
|
+
* <li>
|
|
6279
|
+
* <p>
|
|
6280
|
+
* <code>BASE</code> – The list includes only base asset model properties for a given
|
|
6281
|
+
* asset model ID. </p>
|
|
6282
|
+
* </li>
|
|
6283
|
+
* </ul>
|
|
6284
|
+
* <p>Default: <code>BASE</code>
|
|
6285
|
+
* </p>
|
|
6286
|
+
*/
|
|
6287
|
+
filter?: ListAssetModelPropertiesFilter;
|
|
6288
|
+
}
|
|
6289
|
+
/**
|
|
6290
|
+
* @public
|
|
6291
|
+
*/
|
|
6292
|
+
export interface ListAssetModelPropertiesResponse {
|
|
6293
|
+
/**
|
|
6294
|
+
* @public
|
|
6295
|
+
* <p>A list that summarizes the properties associated with the specified asset model.</p>
|
|
6296
|
+
*/
|
|
6297
|
+
assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
|
|
6298
|
+
/**
|
|
6299
|
+
* @public
|
|
6300
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6301
|
+
*/
|
|
6302
|
+
nextToken?: string;
|
|
6303
|
+
}
|
|
6304
|
+
/**
|
|
6305
|
+
* @public
|
|
6306
|
+
*/
|
|
6307
|
+
export interface ListAssetModelsRequest {
|
|
6308
|
+
/**
|
|
6309
|
+
* @public
|
|
6310
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
6311
|
+
*/
|
|
6312
|
+
nextToken?: string;
|
|
6313
|
+
/**
|
|
6314
|
+
* @public
|
|
6315
|
+
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6316
|
+
* <p>Default: 50</p>
|
|
6317
|
+
*/
|
|
6318
|
+
maxResults?: number;
|
|
6319
|
+
/**
|
|
6320
|
+
* @public
|
|
6321
|
+
* <p>The type of asset model.</p>
|
|
6322
|
+
* <ul>
|
|
6323
|
+
* <li>
|
|
6324
|
+
* <p>
|
|
6325
|
+
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
|
|
6326
|
+
* Can't be included as a component in another asset model.</p>
|
|
6327
|
+
* </li>
|
|
6328
|
+
* <li>
|
|
6329
|
+
* <p>
|
|
6330
|
+
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
|
|
6331
|
+
* models of other asset models. You can't create assets directly from this type of asset model. </p>
|
|
6332
|
+
* </li>
|
|
6333
|
+
* </ul>
|
|
6334
|
+
*/
|
|
6335
|
+
assetModelTypes?: AssetModelType[];
|
|
6336
|
+
}
|
|
6337
|
+
/**
|
|
6338
|
+
* @public
|
|
6339
|
+
*/
|
|
6340
|
+
export interface ListAssetModelsResponse {
|
|
6341
|
+
/**
|
|
6342
|
+
* @public
|
|
6343
|
+
* <p>A list that summarizes each asset model.</p>
|
|
6344
|
+
*/
|
|
6345
|
+
assetModelSummaries: AssetModelSummary[] | undefined;
|
|
6346
|
+
/**
|
|
6347
|
+
* @public
|
|
6348
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6349
|
+
*/
|
|
6350
|
+
nextToken?: string;
|
|
6351
|
+
}
|
|
6352
|
+
/**
|
|
6353
|
+
* @public
|
|
6354
|
+
* @enum
|
|
6355
|
+
*/
|
|
6356
|
+
export declare const ListAssetPropertiesFilter: {
|
|
6357
|
+
readonly ALL: "ALL";
|
|
6358
|
+
readonly BASE: "BASE";
|
|
6359
|
+
};
|
|
6360
|
+
/**
|
|
6361
|
+
* @public
|
|
6362
|
+
*/
|
|
6363
|
+
export type ListAssetPropertiesFilter = (typeof ListAssetPropertiesFilter)[keyof typeof ListAssetPropertiesFilter];
|
|
6364
|
+
/**
|
|
6365
|
+
* @public
|
|
6366
|
+
*/
|
|
6367
|
+
export interface ListAssetPropertiesRequest {
|
|
6368
|
+
/**
|
|
6369
|
+
* @public
|
|
6370
|
+
* <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6371
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6372
|
+
*/
|
|
6373
|
+
assetId: string | undefined;
|
|
6374
|
+
/**
|
|
6375
|
+
* @public
|
|
6376
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
6377
|
+
*/
|
|
6378
|
+
nextToken?: string;
|
|
6379
|
+
/**
|
|
6380
|
+
* @public
|
|
6381
|
+
* <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
|
|
6382
|
+
*/
|
|
6383
|
+
maxResults?: number;
|
|
6384
|
+
/**
|
|
6385
|
+
* @public
|
|
6386
|
+
* <p> Filters the requested list of asset properties. You can choose one of the following
|
|
5207
6387
|
* options:</p>
|
|
5208
6388
|
* <ul>
|
|
5209
6389
|
* <li>
|
|
@@ -5254,7 +6434,8 @@ export type TraversalType = (typeof TraversalType)[keyof typeof TraversalType];
|
|
|
5254
6434
|
export interface ListAssetRelationshipsRequest {
|
|
5255
6435
|
/**
|
|
5256
6436
|
* @public
|
|
5257
|
-
* <p>The ID of the asset
|
|
6437
|
+
* <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6438
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5258
6439
|
*/
|
|
5259
6440
|
assetId: string | undefined;
|
|
5260
6441
|
/**
|
|
@@ -5327,7 +6508,8 @@ export interface ListAssetsRequest {
|
|
|
5327
6508
|
/**
|
|
5328
6509
|
* @public
|
|
5329
6510
|
* <p>The ID of the asset model by which to filter the list of assets. This parameter is
|
|
5330
|
-
* required if you choose <code>ALL</code> for <code>filter</code
|
|
6511
|
+
* required if you choose <code>ALL</code> for <code>filter</code>. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6512
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5331
6513
|
*/
|
|
5332
6514
|
assetModelId?: string;
|
|
5333
6515
|
/**
|
|
@@ -5384,12 +6566,14 @@ export type TraversalDirection = (typeof TraversalDirection)[keyof typeof Traver
|
|
|
5384
6566
|
export interface ListAssociatedAssetsRequest {
|
|
5385
6567
|
/**
|
|
5386
6568
|
* @public
|
|
5387
|
-
* <p>The ID of the asset to query
|
|
6569
|
+
* <p>The ID of the asset to query. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6570
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5388
6571
|
*/
|
|
5389
6572
|
assetId: string | undefined;
|
|
5390
6573
|
/**
|
|
5391
6574
|
* @public
|
|
5392
|
-
* <p>The ID of the hierarchy by which child assets are associated to the asset.
|
|
6575
|
+
* <p>The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6576
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) To find a
|
|
5393
6577
|
* hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This
|
|
5394
6578
|
* parameter is required if you choose <code>CHILD</code> for
|
|
5395
6579
|
* <code>traversalDirection</code>.</p>
|
|
@@ -5481,7 +6665,7 @@ export interface ListBulkImportJobsRequest {
|
|
|
5481
6665
|
}
|
|
5482
6666
|
/**
|
|
5483
6667
|
* @public
|
|
5484
|
-
* <p>Contains
|
|
6668
|
+
* <p>Contains the job summary information.</p>
|
|
5485
6669
|
*/
|
|
5486
6670
|
export interface JobSummary {
|
|
5487
6671
|
/**
|
|
@@ -5496,7 +6680,7 @@ export interface JobSummary {
|
|
|
5496
6680
|
name: string | undefined;
|
|
5497
6681
|
/**
|
|
5498
6682
|
* @public
|
|
5499
|
-
* <p>The status of the bulk import job can be one of following values
|
|
6683
|
+
* <p>The status of the bulk import job can be one of following values:</p>
|
|
5500
6684
|
* <ul>
|
|
5501
6685
|
* <li>
|
|
5502
6686
|
* <p>
|
|
@@ -5543,6 +6727,64 @@ export interface ListBulkImportJobsResponse {
|
|
|
5543
6727
|
*/
|
|
5544
6728
|
nextToken?: string;
|
|
5545
6729
|
}
|
|
6730
|
+
/**
|
|
6731
|
+
* @public
|
|
6732
|
+
*/
|
|
6733
|
+
export interface ListCompositionRelationshipsRequest {
|
|
6734
|
+
/**
|
|
6735
|
+
* @public
|
|
6736
|
+
* <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
6737
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6738
|
+
*/
|
|
6739
|
+
assetModelId: string | undefined;
|
|
6740
|
+
/**
|
|
6741
|
+
* @public
|
|
6742
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
6743
|
+
*/
|
|
6744
|
+
nextToken?: string;
|
|
6745
|
+
/**
|
|
6746
|
+
* @public
|
|
6747
|
+
* <p>The maximum number of results to return for each paginated request.</p>
|
|
6748
|
+
* <p>Default: 50</p>
|
|
6749
|
+
*/
|
|
6750
|
+
maxResults?: number;
|
|
6751
|
+
}
|
|
6752
|
+
/**
|
|
6753
|
+
* @public
|
|
6754
|
+
* <p>Contains a summary of the components of the composite model.</p>
|
|
6755
|
+
*/
|
|
6756
|
+
export interface CompositionRelationshipSummary {
|
|
6757
|
+
/**
|
|
6758
|
+
* @public
|
|
6759
|
+
* <p>The ID of the asset model, in UUID format.</p>
|
|
6760
|
+
*/
|
|
6761
|
+
assetModelId: string | undefined;
|
|
6762
|
+
/**
|
|
6763
|
+
* @public
|
|
6764
|
+
* <p>The ID of a composite model on this asset model.</p>
|
|
6765
|
+
*/
|
|
6766
|
+
assetModelCompositeModelId: string | undefined;
|
|
6767
|
+
/**
|
|
6768
|
+
* @public
|
|
6769
|
+
* <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
|
|
6770
|
+
*/
|
|
6771
|
+
assetModelCompositeModelType: string | undefined;
|
|
6772
|
+
}
|
|
6773
|
+
/**
|
|
6774
|
+
* @public
|
|
6775
|
+
*/
|
|
6776
|
+
export interface ListCompositionRelationshipsResponse {
|
|
6777
|
+
/**
|
|
6778
|
+
* @public
|
|
6779
|
+
* <p>A list that summarizes each composition relationship.</p>
|
|
6780
|
+
*/
|
|
6781
|
+
compositionRelationshipSummaries: CompositionRelationshipSummary[] | undefined;
|
|
6782
|
+
/**
|
|
6783
|
+
* @public
|
|
6784
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
6785
|
+
*/
|
|
6786
|
+
nextToken?: string;
|
|
6787
|
+
}
|
|
5546
6788
|
/**
|
|
5547
6789
|
* @public
|
|
5548
6790
|
*/
|
|
@@ -5925,7 +7167,8 @@ export interface ListTimeSeriesRequest {
|
|
|
5925
7167
|
maxResults?: number;
|
|
5926
7168
|
/**
|
|
5927
7169
|
* @public
|
|
5928
|
-
* <p>The ID of the asset in which the asset property was created
|
|
7170
|
+
* <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
|
|
7171
|
+
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
5929
7172
|
*/
|
|
5930
7173
|
assetId?: string;
|
|
5931
7174
|
/**
|
|
@@ -5964,7 +7207,7 @@ export interface TimeSeriesSummary {
|
|
|
5964
7207
|
assetId?: string;
|
|
5965
7208
|
/**
|
|
5966
7209
|
* @public
|
|
5967
|
-
* <p>The ID of the asset property.</p>
|
|
7210
|
+
* <p>The ID of the asset property, in UUID format.</p>
|
|
5968
7211
|
*/
|
|
5969
7212
|
propertyId?: string;
|
|
5970
7213
|
/**
|
|
@@ -6026,642 +7269,3 @@ export interface ListTimeSeriesResponse {
|
|
|
6026
7269
|
*/
|
|
6027
7270
|
nextToken?: string;
|
|
6028
7271
|
}
|
|
6029
|
-
/**
|
|
6030
|
-
* @public
|
|
6031
|
-
*/
|
|
6032
|
-
export interface PutDefaultEncryptionConfigurationRequest {
|
|
6033
|
-
/**
|
|
6034
|
-
* @public
|
|
6035
|
-
* <p>The type of encryption used for the encryption configuration.</p>
|
|
6036
|
-
*/
|
|
6037
|
-
encryptionType: EncryptionType | undefined;
|
|
6038
|
-
/**
|
|
6039
|
-
* @public
|
|
6040
|
-
* <p>The Key ID of the customer managed key used for KMS encryption. This is required if you
|
|
6041
|
-
* use <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
6042
|
-
*/
|
|
6043
|
-
kmsKeyId?: string;
|
|
6044
|
-
}
|
|
6045
|
-
/**
|
|
6046
|
-
* @public
|
|
6047
|
-
*/
|
|
6048
|
-
export interface PutDefaultEncryptionConfigurationResponse {
|
|
6049
|
-
/**
|
|
6050
|
-
* @public
|
|
6051
|
-
* <p>The type of encryption used for the encryption configuration.</p>
|
|
6052
|
-
*/
|
|
6053
|
-
encryptionType: EncryptionType | undefined;
|
|
6054
|
-
/**
|
|
6055
|
-
* @public
|
|
6056
|
-
* <p>The Key ARN of the KMS key used for KMS encryption if you use
|
|
6057
|
-
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
6058
|
-
*/
|
|
6059
|
-
kmsKeyArn?: string;
|
|
6060
|
-
/**
|
|
6061
|
-
* @public
|
|
6062
|
-
* <p>The status of the account configuration. This contains the
|
|
6063
|
-
* <code>ConfigurationState</code>. If there is an error, it also contains the
|
|
6064
|
-
* <code>ErrorDetails</code>.</p>
|
|
6065
|
-
*/
|
|
6066
|
-
configurationStatus: ConfigurationStatus | undefined;
|
|
6067
|
-
}
|
|
6068
|
-
/**
|
|
6069
|
-
* @public
|
|
6070
|
-
*/
|
|
6071
|
-
export interface PutLoggingOptionsRequest {
|
|
6072
|
-
/**
|
|
6073
|
-
* @public
|
|
6074
|
-
* <p>The logging options to set.</p>
|
|
6075
|
-
*/
|
|
6076
|
-
loggingOptions: LoggingOptions | undefined;
|
|
6077
|
-
}
|
|
6078
|
-
/**
|
|
6079
|
-
* @public
|
|
6080
|
-
*/
|
|
6081
|
-
export interface PutLoggingOptionsResponse {
|
|
6082
|
-
}
|
|
6083
|
-
/**
|
|
6084
|
-
* @public
|
|
6085
|
-
*/
|
|
6086
|
-
export interface PutStorageConfigurationRequest {
|
|
6087
|
-
/**
|
|
6088
|
-
* @public
|
|
6089
|
-
* <p>The storage tier that you specified for your data.
|
|
6090
|
-
* The <code>storageType</code> parameter can be one of the following values:</p>
|
|
6091
|
-
* <ul>
|
|
6092
|
-
* <li>
|
|
6093
|
-
* <p>
|
|
6094
|
-
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier.
|
|
6095
|
-
* The hot tier is a service-managed database.</p>
|
|
6096
|
-
* </li>
|
|
6097
|
-
* <li>
|
|
6098
|
-
* <p>
|
|
6099
|
-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier.
|
|
6100
|
-
* The cold tier is a customer-managed Amazon S3 bucket.</p>
|
|
6101
|
-
* </li>
|
|
6102
|
-
* </ul>
|
|
6103
|
-
*/
|
|
6104
|
-
storageType: StorageType | undefined;
|
|
6105
|
-
/**
|
|
6106
|
-
* @public
|
|
6107
|
-
* <p>Identifies a storage destination. If you specified <code>MULTI_LAYER_STORAGE</code> for the storage type,
|
|
6108
|
-
* you must specify a <code>MultiLayerStorage</code> object.</p>
|
|
6109
|
-
*/
|
|
6110
|
-
multiLayerStorage?: MultiLayerStorage;
|
|
6111
|
-
/**
|
|
6112
|
-
* @public
|
|
6113
|
-
* <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
|
|
6114
|
-
* The <code>disassociatedDataStorage</code> can be one of the following values:</p>
|
|
6115
|
-
* <ul>
|
|
6116
|
-
* <li>
|
|
6117
|
-
* <p>
|
|
6118
|
-
* <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
|
|
6119
|
-
* <important>
|
|
6120
|
-
* <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
|
|
6121
|
-
* </important>
|
|
6122
|
-
* </li>
|
|
6123
|
-
* <li>
|
|
6124
|
-
* <p>
|
|
6125
|
-
* <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
|
|
6126
|
-
* </li>
|
|
6127
|
-
* </ul>
|
|
6128
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
|
|
6129
|
-
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6130
|
-
*/
|
|
6131
|
-
disassociatedDataStorage?: DisassociatedDataStorageState;
|
|
6132
|
-
/**
|
|
6133
|
-
* @public
|
|
6134
|
-
* <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
6135
|
-
*/
|
|
6136
|
-
retentionPeriod?: RetentionPeriod;
|
|
6137
|
-
}
|
|
6138
|
-
/**
|
|
6139
|
-
* @public
|
|
6140
|
-
*/
|
|
6141
|
-
export interface PutStorageConfigurationResponse {
|
|
6142
|
-
/**
|
|
6143
|
-
* @public
|
|
6144
|
-
* <p>The storage tier that you specified for your data.
|
|
6145
|
-
* The <code>storageType</code> parameter can be one of the following values:</p>
|
|
6146
|
-
* <ul>
|
|
6147
|
-
* <li>
|
|
6148
|
-
* <p>
|
|
6149
|
-
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier.
|
|
6150
|
-
* The hot tier is a service-managed database.</p>
|
|
6151
|
-
* </li>
|
|
6152
|
-
* <li>
|
|
6153
|
-
* <p>
|
|
6154
|
-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier.
|
|
6155
|
-
* The cold tier is a customer-managed Amazon S3 bucket.</p>
|
|
6156
|
-
* </li>
|
|
6157
|
-
* </ul>
|
|
6158
|
-
*/
|
|
6159
|
-
storageType: StorageType | undefined;
|
|
6160
|
-
/**
|
|
6161
|
-
* @public
|
|
6162
|
-
* <p>Contains information about the storage destination.</p>
|
|
6163
|
-
*/
|
|
6164
|
-
multiLayerStorage?: MultiLayerStorage;
|
|
6165
|
-
/**
|
|
6166
|
-
* @public
|
|
6167
|
-
* <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
|
|
6168
|
-
* The <code>disassociatedDataStorage</code> can be one of the following values:</p>
|
|
6169
|
-
* <ul>
|
|
6170
|
-
* <li>
|
|
6171
|
-
* <p>
|
|
6172
|
-
* <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
|
|
6173
|
-
* <important>
|
|
6174
|
-
* <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
|
|
6175
|
-
* </important>
|
|
6176
|
-
* </li>
|
|
6177
|
-
* <li>
|
|
6178
|
-
* <p>
|
|
6179
|
-
* <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
|
|
6180
|
-
* </li>
|
|
6181
|
-
* </ul>
|
|
6182
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
|
|
6183
|
-
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6184
|
-
*/
|
|
6185
|
-
disassociatedDataStorage?: DisassociatedDataStorageState;
|
|
6186
|
-
/**
|
|
6187
|
-
* @public
|
|
6188
|
-
* <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
6189
|
-
*/
|
|
6190
|
-
retentionPeriod?: RetentionPeriod;
|
|
6191
|
-
/**
|
|
6192
|
-
* @public
|
|
6193
|
-
* <p>Contains current status information for the configuration.</p>
|
|
6194
|
-
*/
|
|
6195
|
-
configurationStatus: ConfigurationStatus | undefined;
|
|
6196
|
-
}
|
|
6197
|
-
/**
|
|
6198
|
-
* @public
|
|
6199
|
-
*/
|
|
6200
|
-
export interface TagResourceRequest {
|
|
6201
|
-
/**
|
|
6202
|
-
* @public
|
|
6203
|
-
* <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>
|
|
6204
|
-
*/
|
|
6205
|
-
resourceArn: string | undefined;
|
|
6206
|
-
/**
|
|
6207
|
-
* @public
|
|
6208
|
-
* <p>A list of key-value pairs that contain metadata for the resource. For more information,
|
|
6209
|
-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise
|
|
6210
|
-
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6211
|
-
*/
|
|
6212
|
-
tags: Record<string, string> | undefined;
|
|
6213
|
-
}
|
|
6214
|
-
/**
|
|
6215
|
-
* @public
|
|
6216
|
-
*/
|
|
6217
|
-
export interface TagResourceResponse {
|
|
6218
|
-
}
|
|
6219
|
-
/**
|
|
6220
|
-
* @public
|
|
6221
|
-
* <p>You've reached the limit for the number of tags allowed for a resource. For more
|
|
6222
|
-
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions">Tag naming limits and
|
|
6223
|
-
* requirements</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
6224
|
-
*/
|
|
6225
|
-
export declare class TooManyTagsException extends __BaseException {
|
|
6226
|
-
readonly name: "TooManyTagsException";
|
|
6227
|
-
readonly $fault: "client";
|
|
6228
|
-
/**
|
|
6229
|
-
* @public
|
|
6230
|
-
* <p>The name of the resource with too many tags.</p>
|
|
6231
|
-
*/
|
|
6232
|
-
resourceName?: string;
|
|
6233
|
-
/**
|
|
6234
|
-
* @internal
|
|
6235
|
-
*/
|
|
6236
|
-
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
6237
|
-
}
|
|
6238
|
-
/**
|
|
6239
|
-
* @public
|
|
6240
|
-
*/
|
|
6241
|
-
export interface UntagResourceRequest {
|
|
6242
|
-
/**
|
|
6243
|
-
* @public
|
|
6244
|
-
* <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>
|
|
6245
|
-
*/
|
|
6246
|
-
resourceArn: string | undefined;
|
|
6247
|
-
/**
|
|
6248
|
-
* @public
|
|
6249
|
-
* <p>A list of keys for tags to remove from the resource.</p>
|
|
6250
|
-
*/
|
|
6251
|
-
tagKeys: string[] | undefined;
|
|
6252
|
-
}
|
|
6253
|
-
/**
|
|
6254
|
-
* @public
|
|
6255
|
-
*/
|
|
6256
|
-
export interface UntagResourceResponse {
|
|
6257
|
-
}
|
|
6258
|
-
/**
|
|
6259
|
-
* @public
|
|
6260
|
-
*/
|
|
6261
|
-
export interface UpdateAccessPolicyRequest {
|
|
6262
|
-
/**
|
|
6263
|
-
* @public
|
|
6264
|
-
* <p>The ID of the access policy.</p>
|
|
6265
|
-
*/
|
|
6266
|
-
accessPolicyId: string | undefined;
|
|
6267
|
-
/**
|
|
6268
|
-
* @public
|
|
6269
|
-
* <p>The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.</p>
|
|
6270
|
-
*/
|
|
6271
|
-
accessPolicyIdentity: Identity | undefined;
|
|
6272
|
-
/**
|
|
6273
|
-
* @public
|
|
6274
|
-
* <p>The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.</p>
|
|
6275
|
-
*/
|
|
6276
|
-
accessPolicyResource: Resource | undefined;
|
|
6277
|
-
/**
|
|
6278
|
-
* @public
|
|
6279
|
-
* <p>The permission level for this access policy. Note that a project <code>ADMINISTRATOR</code> is also known as a project owner.</p>
|
|
6280
|
-
*/
|
|
6281
|
-
accessPolicyPermission: Permission | undefined;
|
|
6282
|
-
/**
|
|
6283
|
-
* @public
|
|
6284
|
-
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
6285
|
-
*/
|
|
6286
|
-
clientToken?: string;
|
|
6287
|
-
}
|
|
6288
|
-
/**
|
|
6289
|
-
* @public
|
|
6290
|
-
*/
|
|
6291
|
-
export interface UpdateAccessPolicyResponse {
|
|
6292
|
-
}
|
|
6293
|
-
/**
|
|
6294
|
-
* @public
|
|
6295
|
-
*/
|
|
6296
|
-
export interface UpdateAssetRequest {
|
|
6297
|
-
/**
|
|
6298
|
-
* @public
|
|
6299
|
-
* <p>The ID of the asset to update.</p>
|
|
6300
|
-
*/
|
|
6301
|
-
assetId: string | undefined;
|
|
6302
|
-
/**
|
|
6303
|
-
* @public
|
|
6304
|
-
* <p>A friendly name for the asset.</p>
|
|
6305
|
-
*/
|
|
6306
|
-
assetName: string | undefined;
|
|
6307
|
-
/**
|
|
6308
|
-
* @public
|
|
6309
|
-
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
6310
|
-
*/
|
|
6311
|
-
clientToken?: string;
|
|
6312
|
-
/**
|
|
6313
|
-
* @public
|
|
6314
|
-
* <p>A description for the asset.</p>
|
|
6315
|
-
*/
|
|
6316
|
-
assetDescription?: string;
|
|
6317
|
-
}
|
|
6318
|
-
/**
|
|
6319
|
-
* @public
|
|
6320
|
-
*/
|
|
6321
|
-
export interface UpdateAssetResponse {
|
|
6322
|
-
/**
|
|
6323
|
-
* @public
|
|
6324
|
-
* <p>The status of the asset, which contains a state (<code>UPDATING</code> after successfully
|
|
6325
|
-
* calling this operation) and any error message.</p>
|
|
6326
|
-
*/
|
|
6327
|
-
assetStatus: AssetStatus | undefined;
|
|
6328
|
-
}
|
|
6329
|
-
/**
|
|
6330
|
-
* @public
|
|
6331
|
-
*/
|
|
6332
|
-
export interface UpdateAssetModelRequest {
|
|
6333
|
-
/**
|
|
6334
|
-
* @public
|
|
6335
|
-
* <p>The ID of the asset model to update.</p>
|
|
6336
|
-
*/
|
|
6337
|
-
assetModelId: string | undefined;
|
|
6338
|
-
/**
|
|
6339
|
-
* @public
|
|
6340
|
-
* <p>A unique, friendly name for the asset model.</p>
|
|
6341
|
-
*/
|
|
6342
|
-
assetModelName: string | undefined;
|
|
6343
|
-
/**
|
|
6344
|
-
* @public
|
|
6345
|
-
* <p>A description for the asset model.</p>
|
|
6346
|
-
*/
|
|
6347
|
-
assetModelDescription?: string;
|
|
6348
|
-
/**
|
|
6349
|
-
* @public
|
|
6350
|
-
* <p>The updated property definitions of the asset model. For more information, see
|
|
6351
|
-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html">Asset properties</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6352
|
-
* <p>You can specify up to 200 properties per asset model. For more
|
|
6353
|
-
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6354
|
-
*/
|
|
6355
|
-
assetModelProperties?: AssetModelProperty[];
|
|
6356
|
-
/**
|
|
6357
|
-
* @public
|
|
6358
|
-
* <p>The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset
|
|
6359
|
-
* model whose assets can be children of any other assets created from this asset model. For more
|
|
6360
|
-
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6361
|
-
* <p>You can specify up to 10 hierarchies per asset model. For more
|
|
6362
|
-
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6363
|
-
*/
|
|
6364
|
-
assetModelHierarchies?: AssetModelHierarchy[];
|
|
6365
|
-
/**
|
|
6366
|
-
* @public
|
|
6367
|
-
* <p>The composite asset models that are part of this asset model.
|
|
6368
|
-
* Composite asset models are asset models that contain specific properties. Each composite model
|
|
6369
|
-
* has a type that defines the properties that the composite model supports. Use composite asset
|
|
6370
|
-
* models to define alarms on this asset model.</p>
|
|
6371
|
-
*/
|
|
6372
|
-
assetModelCompositeModels?: AssetModelCompositeModel[];
|
|
6373
|
-
/**
|
|
6374
|
-
* @public
|
|
6375
|
-
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
6376
|
-
*/
|
|
6377
|
-
clientToken?: string;
|
|
6378
|
-
}
|
|
6379
|
-
/**
|
|
6380
|
-
* @public
|
|
6381
|
-
*/
|
|
6382
|
-
export interface UpdateAssetModelResponse {
|
|
6383
|
-
/**
|
|
6384
|
-
* @public
|
|
6385
|
-
* <p>The status of the asset model, which contains a state (<code>UPDATING</code> after
|
|
6386
|
-
* successfully calling this operation) and any error message.</p>
|
|
6387
|
-
*/
|
|
6388
|
-
assetModelStatus: AssetModelStatus | undefined;
|
|
6389
|
-
}
|
|
6390
|
-
/**
|
|
6391
|
-
* @public
|
|
6392
|
-
*/
|
|
6393
|
-
export interface UpdateAssetPropertyRequest {
|
|
6394
|
-
/**
|
|
6395
|
-
* @public
|
|
6396
|
-
* <p>The ID of the asset to be updated.</p>
|
|
6397
|
-
*/
|
|
6398
|
-
assetId: string | undefined;
|
|
6399
|
-
/**
|
|
6400
|
-
* @public
|
|
6401
|
-
* <p>The ID of the asset property to be updated.</p>
|
|
6402
|
-
*/
|
|
6403
|
-
propertyId: string | undefined;
|
|
6404
|
-
/**
|
|
6405
|
-
* @public
|
|
6406
|
-
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
6407
|
-
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
6408
|
-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
|
|
6409
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
6410
|
-
* <p>If you omit this parameter, the alias is removed from the property.</p>
|
|
6411
|
-
*/
|
|
6412
|
-
propertyAlias?: string;
|
|
6413
|
-
/**
|
|
6414
|
-
* @public
|
|
6415
|
-
* <p>The MQTT notification state (enabled or disabled) for this asset property.
|
|
6416
|
-
* When the notification state is enabled, IoT SiteWise publishes property value
|
|
6417
|
-
* 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>
|
|
6418
|
-
* <p>If you omit this parameter, the notification state is set to <code>DISABLED</code>.</p>
|
|
6419
|
-
*/
|
|
6420
|
-
propertyNotificationState?: PropertyNotificationState;
|
|
6421
|
-
/**
|
|
6422
|
-
* @public
|
|
6423
|
-
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
6424
|
-
*/
|
|
6425
|
-
clientToken?: string;
|
|
6426
|
-
/**
|
|
6427
|
-
* @public
|
|
6428
|
-
* <p>The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a
|
|
6429
|
-
* value for this parameter, the service uses the value of the <code>assetModelProperty</code> in
|
|
6430
|
-
* the asset model.</p>
|
|
6431
|
-
*/
|
|
6432
|
-
propertyUnit?: string;
|
|
6433
|
-
}
|
|
6434
|
-
/**
|
|
6435
|
-
* @public
|
|
6436
|
-
*/
|
|
6437
|
-
export interface UpdateDashboardRequest {
|
|
6438
|
-
/**
|
|
6439
|
-
* @public
|
|
6440
|
-
* <p>The ID of the dashboard to update.</p>
|
|
6441
|
-
*/
|
|
6442
|
-
dashboardId: string | undefined;
|
|
6443
|
-
/**
|
|
6444
|
-
* @public
|
|
6445
|
-
* <p>A new friendly name for the dashboard.</p>
|
|
6446
|
-
*/
|
|
6447
|
-
dashboardName: string | undefined;
|
|
6448
|
-
/**
|
|
6449
|
-
* @public
|
|
6450
|
-
* <p>A new description for the dashboard.</p>
|
|
6451
|
-
*/
|
|
6452
|
-
dashboardDescription?: string;
|
|
6453
|
-
/**
|
|
6454
|
-
* @public
|
|
6455
|
-
* <p>The new dashboard definition, as specified in a JSON literal. For detailed information,
|
|
6456
|
-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6457
|
-
*/
|
|
6458
|
-
dashboardDefinition: string | undefined;
|
|
6459
|
-
/**
|
|
6460
|
-
* @public
|
|
6461
|
-
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
6462
|
-
*/
|
|
6463
|
-
clientToken?: string;
|
|
6464
|
-
}
|
|
6465
|
-
/**
|
|
6466
|
-
* @public
|
|
6467
|
-
*/
|
|
6468
|
-
export interface UpdateDashboardResponse {
|
|
6469
|
-
}
|
|
6470
|
-
/**
|
|
6471
|
-
* @public
|
|
6472
|
-
*/
|
|
6473
|
-
export interface UpdateGatewayRequest {
|
|
6474
|
-
/**
|
|
6475
|
-
* @public
|
|
6476
|
-
* <p>The ID of the gateway to update.</p>
|
|
6477
|
-
*/
|
|
6478
|
-
gatewayId: string | undefined;
|
|
6479
|
-
/**
|
|
6480
|
-
* @public
|
|
6481
|
-
* <p>A unique, friendly name for the gateway.</p>
|
|
6482
|
-
*/
|
|
6483
|
-
gatewayName: string | undefined;
|
|
6484
|
-
}
|
|
6485
|
-
/**
|
|
6486
|
-
* @public
|
|
6487
|
-
*/
|
|
6488
|
-
export interface UpdateGatewayCapabilityConfigurationRequest {
|
|
6489
|
-
/**
|
|
6490
|
-
* @public
|
|
6491
|
-
* <p>The ID of the gateway to be updated.</p>
|
|
6492
|
-
*/
|
|
6493
|
-
gatewayId: string | undefined;
|
|
6494
|
-
/**
|
|
6495
|
-
* @public
|
|
6496
|
-
* <p>The namespace of the gateway capability configuration to be updated.
|
|
6497
|
-
* For example, if you configure OPC-UA
|
|
6498
|
-
* sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace
|
|
6499
|
-
* <code>iotsitewise:opcuacollector:version</code>, where <code>version</code> is a number such as
|
|
6500
|
-
* <code>1</code>.</p>
|
|
6501
|
-
*/
|
|
6502
|
-
capabilityNamespace: string | undefined;
|
|
6503
|
-
/**
|
|
6504
|
-
* @public
|
|
6505
|
-
* <p>The JSON document that defines the configuration for the gateway capability. For more
|
|
6506
|
-
* information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli">Configuring data sources (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
6507
|
-
*/
|
|
6508
|
-
capabilityConfiguration: string | undefined;
|
|
6509
|
-
}
|
|
6510
|
-
/**
|
|
6511
|
-
* @public
|
|
6512
|
-
*/
|
|
6513
|
-
export interface UpdateGatewayCapabilityConfigurationResponse {
|
|
6514
|
-
/**
|
|
6515
|
-
* @public
|
|
6516
|
-
* <p>The namespace of the gateway capability.</p>
|
|
6517
|
-
*/
|
|
6518
|
-
capabilityNamespace: string | undefined;
|
|
6519
|
-
/**
|
|
6520
|
-
* @public
|
|
6521
|
-
* <p>The synchronization status of the capability configuration. The sync status can be one of the following:</p>
|
|
6522
|
-
* <ul>
|
|
6523
|
-
* <li>
|
|
6524
|
-
* <p>
|
|
6525
|
-
* <code>IN_SYNC</code> – The gateway is running the capability configuration.</p>
|
|
6526
|
-
* </li>
|
|
6527
|
-
* <li>
|
|
6528
|
-
* <p>
|
|
6529
|
-
* <code>OUT_OF_SYNC</code> – The gateway hasn't received the capability configuration.</p>
|
|
6530
|
-
* </li>
|
|
6531
|
-
* <li>
|
|
6532
|
-
* <p>
|
|
6533
|
-
* <code>SYNC_FAILED</code> – The gateway rejected the capability configuration.</p>
|
|
6534
|
-
* </li>
|
|
6535
|
-
* </ul>
|
|
6536
|
-
* <p>After you update a capability configuration, its sync status is <code>OUT_OF_SYNC</code>
|
|
6537
|
-
* until the gateway receives and applies or rejects the updated configuration.</p>
|
|
6538
|
-
*/
|
|
6539
|
-
capabilitySyncStatus: CapabilitySyncStatus | undefined;
|
|
6540
|
-
}
|
|
6541
|
-
/**
|
|
6542
|
-
* @public
|
|
6543
|
-
* <p>Contains an image that is one of the following:</p>
|
|
6544
|
-
* <ul>
|
|
6545
|
-
* <li>
|
|
6546
|
-
* <p>An image file. Choose this option to upload a new image.</p>
|
|
6547
|
-
* </li>
|
|
6548
|
-
* <li>
|
|
6549
|
-
* <p>The ID of an existing image. Choose this option to keep an existing image.</p>
|
|
6550
|
-
* </li>
|
|
6551
|
-
* </ul>
|
|
6552
|
-
*/
|
|
6553
|
-
export interface Image {
|
|
6554
|
-
/**
|
|
6555
|
-
* @public
|
|
6556
|
-
* <p>The ID of an existing image. Specify this parameter to keep an existing image.</p>
|
|
6557
|
-
*/
|
|
6558
|
-
id?: string;
|
|
6559
|
-
/**
|
|
6560
|
-
* @public
|
|
6561
|
-
* <p>Contains an image file.</p>
|
|
6562
|
-
*/
|
|
6563
|
-
file?: ImageFile;
|
|
6564
|
-
}
|
|
6565
|
-
/**
|
|
6566
|
-
* @public
|
|
6567
|
-
*/
|
|
6568
|
-
export interface UpdatePortalRequest {
|
|
6569
|
-
/**
|
|
6570
|
-
* @public
|
|
6571
|
-
* <p>The ID of the portal to update.</p>
|
|
6572
|
-
*/
|
|
6573
|
-
portalId: string | undefined;
|
|
6574
|
-
/**
|
|
6575
|
-
* @public
|
|
6576
|
-
* <p>A new friendly name for the portal.</p>
|
|
6577
|
-
*/
|
|
6578
|
-
portalName: string | undefined;
|
|
6579
|
-
/**
|
|
6580
|
-
* @public
|
|
6581
|
-
* <p>A new description for the portal.</p>
|
|
6582
|
-
*/
|
|
6583
|
-
portalDescription?: string;
|
|
6584
|
-
/**
|
|
6585
|
-
* @public
|
|
6586
|
-
* <p>The Amazon Web Services administrator's contact email address.</p>
|
|
6587
|
-
*/
|
|
6588
|
-
portalContactEmail: string | undefined;
|
|
6589
|
-
/**
|
|
6590
|
-
* @public
|
|
6591
|
-
* <p>Contains an image that is one of the following:</p>
|
|
6592
|
-
* <ul>
|
|
6593
|
-
* <li>
|
|
6594
|
-
* <p>An image file. Choose this option to upload a new image.</p>
|
|
6595
|
-
* </li>
|
|
6596
|
-
* <li>
|
|
6597
|
-
* <p>The ID of an existing image. Choose this option to keep an existing image.</p>
|
|
6598
|
-
* </li>
|
|
6599
|
-
* </ul>
|
|
6600
|
-
*/
|
|
6601
|
-
portalLogoImage?: Image;
|
|
6602
|
-
/**
|
|
6603
|
-
* @public
|
|
6604
|
-
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of a service role that allows the portal's users to access your IoT SiteWise
|
|
6605
|
-
* resources on your behalf. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html">Using service roles for IoT SiteWise Monitor</a> in the
|
|
6606
|
-
* <i>IoT SiteWise User Guide</i>.</p>
|
|
6607
|
-
*/
|
|
6608
|
-
roleArn: string | undefined;
|
|
6609
|
-
/**
|
|
6610
|
-
* @public
|
|
6611
|
-
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
6612
|
-
*/
|
|
6613
|
-
clientToken?: string;
|
|
6614
|
-
/**
|
|
6615
|
-
* @public
|
|
6616
|
-
* <p>The email address that sends alarm notifications.</p>
|
|
6617
|
-
*/
|
|
6618
|
-
notificationSenderEmail?: string;
|
|
6619
|
-
/**
|
|
6620
|
-
* @public
|
|
6621
|
-
* <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
|
|
6622
|
-
* You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
|
|
6623
|
-
* 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>
|
|
6624
|
-
*/
|
|
6625
|
-
alarms?: Alarms;
|
|
6626
|
-
}
|
|
6627
|
-
/**
|
|
6628
|
-
* @public
|
|
6629
|
-
*/
|
|
6630
|
-
export interface UpdatePortalResponse {
|
|
6631
|
-
/**
|
|
6632
|
-
* @public
|
|
6633
|
-
* <p>The status of the portal, which contains a state (<code>UPDATING</code> after successfully
|
|
6634
|
-
* calling this operation) and any error message.</p>
|
|
6635
|
-
*/
|
|
6636
|
-
portalStatus: PortalStatus | undefined;
|
|
6637
|
-
}
|
|
6638
|
-
/**
|
|
6639
|
-
* @public
|
|
6640
|
-
*/
|
|
6641
|
-
export interface UpdateProjectRequest {
|
|
6642
|
-
/**
|
|
6643
|
-
* @public
|
|
6644
|
-
* <p>The ID of the project to update.</p>
|
|
6645
|
-
*/
|
|
6646
|
-
projectId: string | undefined;
|
|
6647
|
-
/**
|
|
6648
|
-
* @public
|
|
6649
|
-
* <p>A new friendly name for the project.</p>
|
|
6650
|
-
*/
|
|
6651
|
-
projectName: string | undefined;
|
|
6652
|
-
/**
|
|
6653
|
-
* @public
|
|
6654
|
-
* <p>A new description for the project.</p>
|
|
6655
|
-
*/
|
|
6656
|
-
projectDescription?: string;
|
|
6657
|
-
/**
|
|
6658
|
-
* @public
|
|
6659
|
-
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
|
|
6660
|
-
*/
|
|
6661
|
-
clientToken?: string;
|
|
6662
|
-
}
|
|
6663
|
-
/**
|
|
6664
|
-
* @public
|
|
6665
|
-
*/
|
|
6666
|
-
export interface UpdateProjectResponse {
|
|
6667
|
-
}
|