@aws-sdk/client-iotsitewise 3.934.0 → 3.935.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.
Files changed (59) hide show
  1. package/dist-cjs/index.js +290 -290
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +278 -0
  4. package/dist-es/models/errors.js +183 -0
  5. package/dist-es/models/models_0.js +1 -387
  6. package/dist-es/models/models_1.js +1 -75
  7. package/dist-es/schemas/schemas_0.js +1 -1
  8. package/dist-types/commands/InvokeAssistantCommand.d.ts +1 -2
  9. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
  10. package/dist-types/commands/ListActionsCommand.d.ts +1 -1
  11. package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  12. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  13. package/dist-types/commands/ListAssetModelsCommand.d.ts +1 -1
  14. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +1 -1
  15. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  16. package/dist-types/commands/ListAssetsCommand.d.ts +1 -1
  17. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +1 -1
  19. package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  20. package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
  21. package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
  22. package/dist-types/commands/ListComputationModelsCommand.d.ts +1 -1
  23. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  24. package/dist-types/commands/ListDatasetsCommand.d.ts +1 -1
  25. package/dist-types/commands/ListExecutionsCommand.d.ts +1 -1
  26. package/dist-types/commands/ListGatewaysCommand.d.ts +1 -1
  27. package/dist-types/index.d.ts +4 -1
  28. package/dist-types/models/enums.d.ts +718 -0
  29. package/dist-types/models/errors.d.ts +216 -0
  30. package/dist-types/models/models_0.d.ts +1544 -767
  31. package/dist-types/models/models_1.d.ts +2 -1712
  32. package/dist-types/ts3.4/commands/InvokeAssistantCommand.d.ts +4 -2
  33. package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +1 -1
  34. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
  35. package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/ListAssetModelsCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +1 -1
  39. package/dist-types/ts3.4/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/ListAssetsCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/ListAssociatedAssetsCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/ListBulkImportJobsCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/ListComputationModelsCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/ListGatewaysCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/index.d.ts +4 -1
  52. package/dist-types/ts3.4/models/enums.d.ts +367 -0
  53. package/dist-types/ts3.4/models/errors.d.ts +107 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +502 -392
  55. package/dist-types/ts3.4/models/models_1.d.ts +13 -562
  56. package/package.json +12 -12
  57. package/dist-es/models/index.js +0 -2
  58. package/dist-types/models/index.d.ts +0 -2
  59. package/dist-types/ts3.4/models/index.d.ts +0 -2
@@ -1,17 +1,5 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
3
- /**
4
- * <p>Access is denied.</p>
5
- * @public
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
- }
1
+ import { AggregateType, AssetErrorCode, AssetModelState, AssetModelType, AssetModelVersionType, AssetRelationshipType, AssetState, AuthMode, BatchEntryCompletionStatus, BatchGetAssetPropertyAggregatesErrorCode, BatchGetAssetPropertyValueErrorCode, BatchGetAssetPropertyValueHistoryErrorCode, BatchPutAssetPropertyValueErrorCode, CapabilitySyncStatus, ColumnName, ComputationModelState, ComputationModelType, ComputeLocation, ConfigurationState, CoreDeviceOperatingSystem, DatasetSourceFormat, DatasetSourceType, DatasetState, DetailedErrorCode, DisassociatedDataStorageState, EncryptionType, ErrorCode, ExecutionState, ForwardingConfigState, IdentityType, ImageFileType, JobStatus, ListAssetModelPropertiesFilter, ListAssetPropertiesFilter, ListAssetsFilter, ListBulkImportJobsFilter, LoggingLevel, MonitorErrorCode, Permission, PortalState, PortalType, PropertyDataType, PropertyNotificationState, Quality, RawValueType, ResolveToResourceType, ResourceType, ScalarType, StorageType, TargetResourceType, TimeOrdering, TraversalDirection, TraversalType, WarmTierState } from "./enums";
2
+ import { AccessDeniedException, ConflictingOperationException, InternalFailureException, InvalidRequestException, LimitExceededException, ResourceNotFoundException, ThrottlingException } from "./errors";
15
3
  /**
16
4
  * <p>Contains information for a group identity in an access policy.</p>
17
5
  * @public
@@ -94,18 +82,6 @@ export interface Identity {
94
82
  */
95
83
  iamRole?: IAMRoleIdentity | undefined;
96
84
  }
97
- /**
98
- * @public
99
- * @enum
100
- */
101
- export declare const Permission: {
102
- readonly ADMINISTRATOR: "ADMINISTRATOR";
103
- readonly VIEWER: "VIEWER";
104
- };
105
- /**
106
- * @public
107
- */
108
- export type Permission = (typeof Permission)[keyof typeof Permission];
109
85
  /**
110
86
  * <p>Identifies an IoT SiteWise Monitor portal.</p>
111
87
  * @public
@@ -269,19 +245,6 @@ export interface ActionSummary {
269
245
  */
270
246
  resolveTo?: ResolveTo | undefined;
271
247
  }
272
- /**
273
- * @public
274
- * @enum
275
- */
276
- export declare const Quality: {
277
- readonly BAD: "BAD";
278
- readonly GOOD: "GOOD";
279
- readonly UNCERTAIN: "UNCERTAIN";
280
- };
281
- /**
282
- * @public
283
- */
284
- export type Quality = (typeof Quality)[keyof typeof Quality];
285
248
  /**
286
249
  * <p>Contains the (pre-calculated) aggregate values for an asset property.</p>
287
250
  * @public
@@ -340,22 +303,6 @@ export interface AggregatedValue {
340
303
  */
341
304
  value: Aggregates | undefined;
342
305
  }
343
- /**
344
- * @public
345
- * @enum
346
- */
347
- export declare const AggregateType: {
348
- readonly AVERAGE: "AVERAGE";
349
- readonly COUNT: "COUNT";
350
- readonly MAXIMUM: "MAXIMUM";
351
- readonly MINIMUM: "MINIMUM";
352
- readonly STANDARD_DEVIATION: "STANDARD_DEVIATION";
353
- readonly SUM: "SUM";
354
- };
355
- /**
356
- * @public
357
- */
358
- export type AggregateType = (typeof AggregateType)[keyof typeof AggregateType];
359
306
  /**
360
307
  * <p>Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
361
308
  * You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range.
@@ -390,33 +337,6 @@ export interface AssetBindingValueFilter {
390
337
  */
391
338
  assetId: string | undefined;
392
339
  }
393
- /**
394
- * @public
395
- * @enum
396
- */
397
- export declare const PropertyDataType: {
398
- readonly BOOLEAN: "BOOLEAN";
399
- readonly DOUBLE: "DOUBLE";
400
- readonly INTEGER: "INTEGER";
401
- readonly STRING: "STRING";
402
- readonly STRUCT: "STRUCT";
403
- };
404
- /**
405
- * @public
406
- */
407
- export type PropertyDataType = (typeof PropertyDataType)[keyof typeof PropertyDataType];
408
- /**
409
- * @public
410
- * @enum
411
- */
412
- export declare const PropertyNotificationState: {
413
- readonly DISABLED: "DISABLED";
414
- readonly ENABLED: "ENABLED";
415
- };
416
- /**
417
- * @public
418
- */
419
- export type PropertyNotificationState = (typeof PropertyNotificationState)[keyof typeof PropertyNotificationState];
420
340
  /**
421
341
  * <p>Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value
422
342
  * 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>
@@ -611,17 +531,6 @@ export interface AssetCompositeModelSummary {
611
531
  */
612
532
  path: AssetCompositeModelPathSegment[] | undefined;
613
533
  }
614
- /**
615
- * @public
616
- * @enum
617
- */
618
- export declare const AssetErrorCode: {
619
- readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
620
- };
621
- /**
622
- * @public
623
- */
624
- export type AssetErrorCode = (typeof AssetErrorCode)[keyof typeof AssetErrorCode];
625
534
  /**
626
535
  * <p>Contains error details for the requested associate project asset action.</p>
627
536
  * @public
@@ -729,18 +638,6 @@ export interface Attribute {
729
638
  */
730
639
  defaultValue?: string | undefined;
731
640
  }
732
- /**
733
- * @public
734
- * @enum
735
- */
736
- export declare const ForwardingConfigState: {
737
- readonly DISABLED: "DISABLED";
738
- readonly ENABLED: "ENABLED";
739
- };
740
- /**
741
- * @public
742
- */
743
- export type ForwardingConfigState = (typeof ForwardingConfigState)[keyof typeof ForwardingConfigState];
744
641
  /**
745
642
  * <p>The forwarding configuration for a given property.</p>
746
643
  * @public
@@ -779,18 +676,6 @@ export interface Measurement {
779
676
  */
780
677
  processingConfig?: MeasurementProcessingConfig | undefined;
781
678
  }
782
- /**
783
- * @public
784
- * @enum
785
- */
786
- export declare const ComputeLocation: {
787
- readonly CLOUD: "CLOUD";
788
- readonly EDGE: "EDGE";
789
- };
790
- /**
791
- * @public
792
- */
793
- export type ComputeLocation = (typeof ComputeLocation)[keyof typeof ComputeLocation];
794
679
  /**
795
680
  * <p>The processing configuration for the given metric property.
796
681
  * You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud.
@@ -1518,46 +1403,6 @@ export interface AssetModelPropertySummary {
1518
1403
  */
1519
1404
  interfaceSummaries?: InterfaceSummary[] | undefined;
1520
1405
  }
1521
- /**
1522
- * @public
1523
- * @enum
1524
- */
1525
- export declare const AssetModelState: {
1526
- readonly ACTIVE: "ACTIVE";
1527
- readonly CREATING: "CREATING";
1528
- readonly DELETING: "DELETING";
1529
- readonly FAILED: "FAILED";
1530
- readonly PROPAGATING: "PROPAGATING";
1531
- readonly UPDATING: "UPDATING";
1532
- };
1533
- /**
1534
- * @public
1535
- */
1536
- export type AssetModelState = (typeof AssetModelState)[keyof typeof AssetModelState];
1537
- /**
1538
- * @public
1539
- * @enum
1540
- */
1541
- export declare const ErrorCode: {
1542
- readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
1543
- readonly VALIDATION_ERROR: "VALIDATION_ERROR";
1544
- };
1545
- /**
1546
- * @public
1547
- */
1548
- export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
1549
- /**
1550
- * @public
1551
- * @enum
1552
- */
1553
- export declare const DetailedErrorCode: {
1554
- readonly INCOMPATIBLE_COMPUTE_LOCATION: "INCOMPATIBLE_COMPUTE_LOCATION";
1555
- readonly INCOMPATIBLE_FORWARDING_CONFIGURATION: "INCOMPATIBLE_FORWARDING_CONFIGURATION";
1556
- };
1557
- /**
1558
- * @public
1559
- */
1560
- export type DetailedErrorCode = (typeof DetailedErrorCode)[keyof typeof DetailedErrorCode];
1561
1406
  /**
1562
1407
  * <p>Contains detailed error information. </p>
1563
1408
  * @public
@@ -1612,19 +1457,6 @@ export interface AssetModelStatus {
1612
1457
  */
1613
1458
  error?: ErrorDetails | undefined;
1614
1459
  }
1615
- /**
1616
- * @public
1617
- * @enum
1618
- */
1619
- export declare const AssetModelType: {
1620
- readonly ASSET_MODEL: "ASSET_MODEL";
1621
- readonly COMPONENT_MODEL: "COMPONENT_MODEL";
1622
- readonly INTERFACE: "INTERFACE";
1623
- };
1624
- /**
1625
- * @public
1626
- */
1627
- export type AssetModelType = (typeof AssetModelType)[keyof typeof AssetModelType];
1628
1460
  /**
1629
1461
  * <p>Contains a summary of an asset model.</p>
1630
1462
  * @public
@@ -1696,18 +1528,6 @@ export interface AssetModelSummary {
1696
1528
  */
1697
1529
  version?: string | undefined;
1698
1530
  }
1699
- /**
1700
- * @public
1701
- * @enum
1702
- */
1703
- export declare const AssetModelVersionType: {
1704
- readonly ACTIVE: "ACTIVE";
1705
- readonly LATEST: "LATEST";
1706
- };
1707
- /**
1708
- * @public
1709
- */
1710
- export type AssetModelVersionType = (typeof AssetModelVersionType)[keyof typeof AssetModelVersionType];
1711
1531
  /**
1712
1532
  * <p>Represents a data binding value referencing a specific asset property. It's used to bind
1713
1533
  * computation model variables to actual asset property values for processing.</p>
@@ -1809,21 +1629,6 @@ export interface TimeInNanos {
1809
1629
  */
1810
1630
  offsetInNanos?: number | undefined;
1811
1631
  }
1812
- /**
1813
- * @public
1814
- * @enum
1815
- */
1816
- export declare const RawValueType: {
1817
- readonly BOOLEAN: "B";
1818
- readonly DOUBLE: "D";
1819
- readonly INTEGER: "I";
1820
- readonly STRING: "S";
1821
- readonly UNKNOWN: "U";
1822
- };
1823
- /**
1824
- * @public
1825
- */
1826
- export type RawValueType = (typeof RawValueType)[keyof typeof RawValueType];
1827
1632
  /**
1828
1633
  * <p>The value type of null asset property data with BAD and UNCERTAIN qualities.</p>
1829
1634
  * @public
@@ -1889,17 +1694,6 @@ export interface AssetPropertyValue {
1889
1694
  */
1890
1695
  quality?: Quality | undefined;
1891
1696
  }
1892
- /**
1893
- * @public
1894
- * @enum
1895
- */
1896
- export declare const AssetRelationshipType: {
1897
- readonly HIERARCHY: "HIERARCHY";
1898
- };
1899
- /**
1900
- * @public
1901
- */
1902
- export type AssetRelationshipType = (typeof AssetRelationshipType)[keyof typeof AssetRelationshipType];
1903
1697
  /**
1904
1698
  * <p>Contains information about assets that are related to one another.</p>
1905
1699
  * @public
@@ -1927,21 +1721,6 @@ export interface AssetRelationshipSummary {
1927
1721
  */
1928
1722
  relationshipType: AssetRelationshipType | undefined;
1929
1723
  }
1930
- /**
1931
- * @public
1932
- * @enum
1933
- */
1934
- export declare const AssetState: {
1935
- readonly ACTIVE: "ACTIVE";
1936
- readonly CREATING: "CREATING";
1937
- readonly DELETING: "DELETING";
1938
- readonly FAILED: "FAILED";
1939
- readonly UPDATING: "UPDATING";
1940
- };
1941
- /**
1942
- * @public
1943
- */
1944
- export type AssetState = (typeof AssetState)[keyof typeof AssetState];
1945
1724
  /**
1946
1725
  * <p>Contains information about the current status of an asset. For more information, see
1947
1726
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html">Asset and model
@@ -2049,118 +1828,6 @@ export interface AssociateAssetsRequest {
2049
1828
  */
2050
1829
  clientToken?: string | undefined;
2051
1830
  }
2052
- /**
2053
- * <p>Your request has conflicting operations. This can occur if you're trying to perform more
2054
- * than one operation on the same resource at the same time.</p>
2055
- * @public
2056
- */
2057
- export declare class ConflictingOperationException extends __BaseException {
2058
- readonly name: "ConflictingOperationException";
2059
- readonly $fault: "client";
2060
- /**
2061
- * <p>The ID of the resource that conflicts with this operation.</p>
2062
- * @public
2063
- */
2064
- resourceId: string | undefined;
2065
- /**
2066
- * <p>The ARN of the resource that conflicts with this operation.</p>
2067
- * @public
2068
- */
2069
- resourceArn: string | undefined;
2070
- /**
2071
- * @internal
2072
- */
2073
- constructor(opts: __ExceptionOptionType<ConflictingOperationException, __BaseException>);
2074
- }
2075
- /**
2076
- * <p>IoT SiteWise can't process your request right now. Try again later.</p>
2077
- * @public
2078
- */
2079
- export declare class InternalFailureException extends __BaseException {
2080
- readonly name: "InternalFailureException";
2081
- readonly $fault: "server";
2082
- /**
2083
- * @internal
2084
- */
2085
- constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
2086
- }
2087
- /**
2088
- * <p>The request isn't valid. This can occur if your request contains malformed JSON or
2089
- * unsupported characters. Check your request and try again.</p>
2090
- * @public
2091
- */
2092
- export declare class InvalidRequestException extends __BaseException {
2093
- readonly name: "InvalidRequestException";
2094
- readonly $fault: "client";
2095
- /**
2096
- * @internal
2097
- */
2098
- constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
2099
- }
2100
- /**
2101
- * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
2102
- * associate more than the allowed number of child assets or attempting to create more than the
2103
- * allowed number of properties for an asset model.</p>
2104
- * <p>For more 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>
2105
- * @public
2106
- */
2107
- export declare class LimitExceededException extends __BaseException {
2108
- readonly name: "LimitExceededException";
2109
- readonly $fault: "client";
2110
- /**
2111
- * @internal
2112
- */
2113
- constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
2114
- }
2115
- /**
2116
- * <p>The resource already exists.</p>
2117
- * @public
2118
- */
2119
- export declare class ResourceAlreadyExistsException extends __BaseException {
2120
- readonly name: "ResourceAlreadyExistsException";
2121
- readonly $fault: "client";
2122
- /**
2123
- * <p>The ID of the resource that already exists.</p>
2124
- * @public
2125
- */
2126
- resourceId: string | undefined;
2127
- /**
2128
- * <p>The ARN of the resource that already exists.</p>
2129
- * @public
2130
- */
2131
- resourceArn: string | undefined;
2132
- /**
2133
- * @internal
2134
- */
2135
- constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
2136
- }
2137
- /**
2138
- * <p>The requested resource can't be found.</p>
2139
- * @public
2140
- */
2141
- export declare class ResourceNotFoundException extends __BaseException {
2142
- readonly name: "ResourceNotFoundException";
2143
- readonly $fault: "client";
2144
- /**
2145
- * @internal
2146
- */
2147
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
2148
- }
2149
- /**
2150
- * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
2151
- * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
2152
- * on.</p>
2153
- * <p>For more 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>
2154
- * @public
2155
- */
2156
- export declare class ThrottlingException extends __BaseException {
2157
- readonly name: "ThrottlingException";
2158
- readonly $fault: "client";
2159
- /**
2160
- * @internal
2161
- */
2162
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
2163
- }
2164
1831
  /**
2165
1832
  * <p>Contains a summary of an associated asset.</p>
2166
1833
  * @public
@@ -2247,18 +1914,6 @@ export interface AssociateTimeSeriesToAssetPropertyRequest {
2247
1914
  */
2248
1915
  clientToken?: string | undefined;
2249
1916
  }
2250
- /**
2251
- * @public
2252
- * @enum
2253
- */
2254
- export declare const AuthMode: {
2255
- readonly IAM: "IAM";
2256
- readonly SSO: "SSO";
2257
- };
2258
- /**
2259
- * @public
2260
- */
2261
- export type AuthMode = (typeof AuthMode)[keyof typeof AuthMode];
2262
1917
  /**
2263
1918
  * @public
2264
1919
  */
@@ -2319,18 +1974,6 @@ export interface BatchDisassociateProjectAssetsResponse {
2319
1974
  */
2320
1975
  errors?: AssetErrorDetails[] | undefined;
2321
1976
  }
2322
- /**
2323
- * @public
2324
- * @enum
2325
- */
2326
- export declare const TimeOrdering: {
2327
- readonly ASCENDING: "ASCENDING";
2328
- readonly DESCENDING: "DESCENDING";
2329
- };
2330
- /**
2331
- * @public
2332
- */
2333
- export type TimeOrdering = (typeof TimeOrdering)[keyof typeof TimeOrdering];
2334
1977
  /**
2335
1978
  * <p>Contains information for an asset property aggregate entry that is associated with the
2336
1979
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
@@ -2434,19 +2077,6 @@ export interface BatchGetAssetPropertyAggregatesRequest {
2434
2077
  */
2435
2078
  maxResults?: number | undefined;
2436
2079
  }
2437
- /**
2438
- * @public
2439
- * @enum
2440
- */
2441
- export declare const BatchGetAssetPropertyAggregatesErrorCode: {
2442
- readonly AccessDeniedException: "AccessDeniedException";
2443
- readonly InvalidRequestException: "InvalidRequestException";
2444
- readonly ResourceNotFoundException: "ResourceNotFoundException";
2445
- };
2446
- /**
2447
- * @public
2448
- */
2449
- export type BatchGetAssetPropertyAggregatesErrorCode = (typeof BatchGetAssetPropertyAggregatesErrorCode)[keyof typeof BatchGetAssetPropertyAggregatesErrorCode];
2450
2080
  /**
2451
2081
  * <p>Contains error information for an asset property aggregate entry that is associated with
2452
2082
  * the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
@@ -2469,18 +2099,6 @@ export interface BatchGetAssetPropertyAggregatesErrorEntry {
2469
2099
  */
2470
2100
  entryId: string | undefined;
2471
2101
  }
2472
- /**
2473
- * @public
2474
- * @enum
2475
- */
2476
- export declare const BatchEntryCompletionStatus: {
2477
- readonly ERROR: "ERROR";
2478
- readonly SUCCESS: "SUCCESS";
2479
- };
2480
- /**
2481
- * @public
2482
- */
2483
- export type BatchEntryCompletionStatus = (typeof BatchEntryCompletionStatus)[keyof typeof BatchEntryCompletionStatus];
2484
2102
  /**
2485
2103
  * <p>Contains the error code and the timestamp for an asset property aggregate entry that is
2486
2104
  * associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
@@ -2565,18 +2183,6 @@ export interface BatchGetAssetPropertyAggregatesResponse {
2565
2183
  */
2566
2184
  nextToken?: string | undefined;
2567
2185
  }
2568
- /**
2569
- * <p>The requested service is unavailable.</p>
2570
- * @public
2571
- */
2572
- export declare class ServiceUnavailableException extends __BaseException {
2573
- readonly name: "ServiceUnavailableException";
2574
- readonly $fault: "server";
2575
- /**
2576
- * @internal
2577
- */
2578
- constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
2579
- }
2580
2186
  /**
2581
2187
  * <p>Contains information for an asset property value entry that is associated with the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
2582
2188
  * <p>To identify an asset property, you must specify one of the following:</p>
@@ -2632,19 +2238,6 @@ export interface BatchGetAssetPropertyValueRequest {
2632
2238
  */
2633
2239
  nextToken?: string | undefined;
2634
2240
  }
2635
- /**
2636
- * @public
2637
- * @enum
2638
- */
2639
- export declare const BatchGetAssetPropertyValueErrorCode: {
2640
- readonly AccessDeniedException: "AccessDeniedException";
2641
- readonly InvalidRequestException: "InvalidRequestException";
2642
- readonly ResourceNotFoundException: "ResourceNotFoundException";
2643
- };
2644
- /**
2645
- * @public
2646
- */
2647
- export type BatchGetAssetPropertyValueErrorCode = (typeof BatchGetAssetPropertyValueErrorCode)[keyof typeof BatchGetAssetPropertyValueErrorCode];
2648
2241
  /**
2649
2242
  * <p>Contains error information for an asset property value entry that is associated with the
2650
2243
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
@@ -2842,19 +2435,6 @@ export interface BatchGetAssetPropertyValueHistoryRequest {
2842
2435
  */
2843
2436
  maxResults?: number | undefined;
2844
2437
  }
2845
- /**
2846
- * @public
2847
- * @enum
2848
- */
2849
- export declare const BatchGetAssetPropertyValueHistoryErrorCode: {
2850
- readonly AccessDeniedException: "AccessDeniedException";
2851
- readonly InvalidRequestException: "InvalidRequestException";
2852
- readonly ResourceNotFoundException: "ResourceNotFoundException";
2853
- };
2854
- /**
2855
- * @public
2856
- */
2857
- export type BatchGetAssetPropertyValueHistoryErrorCode = (typeof BatchGetAssetPropertyValueHistoryErrorCode)[keyof typeof BatchGetAssetPropertyValueHistoryErrorCode];
2858
2438
  /**
2859
2439
  * <p>A list of the errors (if any) associated with the batch request. Each error entry
2860
2440
  * contains the <code>entryId</code> of the entry that failed.</p>
@@ -3015,25 +2595,6 @@ export interface BatchPutAssetPropertyValueRequest {
3015
2595
  */
3016
2596
  entries: PutAssetPropertyValueEntry[] | undefined;
3017
2597
  }
3018
- /**
3019
- * @public
3020
- * @enum
3021
- */
3022
- export declare const BatchPutAssetPropertyValueErrorCode: {
3023
- readonly AccessDeniedException: "AccessDeniedException";
3024
- readonly ConflictingOperationException: "ConflictingOperationException";
3025
- readonly InternalFailureException: "InternalFailureException";
3026
- readonly InvalidRequestException: "InvalidRequestException";
3027
- readonly LimitExceededException: "LimitExceededException";
3028
- readonly ResourceNotFoundException: "ResourceNotFoundException";
3029
- readonly ServiceUnavailableException: "ServiceUnavailableException";
3030
- readonly ThrottlingException: "ThrottlingException";
3031
- readonly TimestampOutOfRangeException: "TimestampOutOfRangeException";
3032
- };
3033
- /**
3034
- * @public
3035
- */
3036
- export type BatchPutAssetPropertyValueErrorCode = (typeof BatchPutAssetPropertyValueErrorCode)[keyof typeof BatchPutAssetPropertyValueErrorCode];
3037
2598
  /**
3038
2599
  * <p>Contains error information from updating a batch of asset property values.</p>
3039
2600
  * @public
@@ -3419,29 +2980,6 @@ export interface CreateAssetModelCompositeModelResponse {
3419
2980
  */
3420
2981
  assetModelStatus: AssetModelStatus | undefined;
3421
2982
  }
3422
- /**
3423
- * <p>The precondition in one or more of the request-header fields evaluated to
3424
- * <code>FALSE</code>.</p>
3425
- * @public
3426
- */
3427
- export declare class PreconditionFailedException extends __BaseException {
3428
- readonly name: "PreconditionFailedException";
3429
- readonly $fault: "client";
3430
- /**
3431
- * <p>The ID of the resource on which precondition failed with this operation.</p>
3432
- * @public
3433
- */
3434
- resourceId: string | undefined;
3435
- /**
3436
- * <p>The ARN of the resource on which precondition failed with this operation.</p>
3437
- * @public
3438
- */
3439
- resourceArn: string | undefined;
3440
- /**
3441
- * @internal
3442
- */
3443
- constructor(opts: __ExceptionOptionType<PreconditionFailedException, __BaseException>);
3444
- }
3445
2983
  /**
3446
2984
  * <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
3447
2985
  * @public
@@ -3485,24 +3023,6 @@ export interface File {
3485
3023
  */
3486
3024
  versionId?: string | undefined;
3487
3025
  }
3488
- /**
3489
- * @public
3490
- * @enum
3491
- */
3492
- export declare const ColumnName: {
3493
- readonly ALIAS: "ALIAS";
3494
- readonly ASSET_ID: "ASSET_ID";
3495
- readonly DATA_TYPE: "DATA_TYPE";
3496
- readonly PROPERTY_ID: "PROPERTY_ID";
3497
- readonly QUALITY: "QUALITY";
3498
- readonly TIMESTAMP_NANO_OFFSET: "TIMESTAMP_NANO_OFFSET";
3499
- readonly TIMESTAMP_SECONDS: "TIMESTAMP_SECONDS";
3500
- readonly VALUE: "VALUE";
3501
- };
3502
- /**
3503
- * @public
3504
- */
3505
- export type ColumnName = (typeof ColumnName)[keyof typeof ColumnName];
3506
3026
  /**
3507
3027
  * <p>A .CSV file.</p>
3508
3028
  * @public
@@ -3588,22 +3108,6 @@ export interface CreateBulkImportJobRequest {
3588
3108
  */
3589
3109
  deleteFilesAfterImport?: boolean | undefined;
3590
3110
  }
3591
- /**
3592
- * @public
3593
- * @enum
3594
- */
3595
- export declare const JobStatus: {
3596
- readonly CANCELLED: "CANCELLED";
3597
- readonly COMPLETED: "COMPLETED";
3598
- readonly COMPLETED_WITH_FAILURES: "COMPLETED_WITH_FAILURES";
3599
- readonly FAILED: "FAILED";
3600
- readonly PENDING: "PENDING";
3601
- readonly RUNNING: "RUNNING";
3602
- };
3603
- /**
3604
- * @public
3605
- */
3606
- export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
3607
3111
  /**
3608
3112
  * @public
3609
3113
  */
@@ -3681,21 +3185,6 @@ export interface ComputationModelConfiguration {
3681
3185
  */
3682
3186
  anomalyDetection?: ComputationModelAnomalyDetectionConfiguration | undefined;
3683
3187
  }
3684
- /**
3685
- * @public
3686
- * @enum
3687
- */
3688
- export declare const ComputationModelState: {
3689
- readonly ACTIVE: "ACTIVE";
3690
- readonly CREATING: "CREATING";
3691
- readonly DELETING: "DELETING";
3692
- readonly FAILED: "FAILED";
3693
- readonly UPDATING: "UPDATING";
3694
- };
3695
- /**
3696
- * @public
3697
- */
3698
- export type ComputationModelState = (typeof ComputationModelState)[keyof typeof ComputationModelState];
3699
3188
  /**
3700
3189
  * <p>Contains current status information for a computation model.</p>
3701
3190
  * @public
@@ -3830,28 +3319,6 @@ export interface SourceDetail {
3830
3319
  */
3831
3320
  kendra?: KendraSourceDetail | undefined;
3832
3321
  }
3833
- /**
3834
- * @public
3835
- * @enum
3836
- */
3837
- export declare const DatasetSourceFormat: {
3838
- readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
3839
- };
3840
- /**
3841
- * @public
3842
- */
3843
- export type DatasetSourceFormat = (typeof DatasetSourceFormat)[keyof typeof DatasetSourceFormat];
3844
- /**
3845
- * @public
3846
- * @enum
3847
- */
3848
- export declare const DatasetSourceType: {
3849
- readonly KENDRA: "KENDRA";
3850
- };
3851
- /**
3852
- * @public
3853
- */
3854
- export type DatasetSourceType = (typeof DatasetSourceType)[keyof typeof DatasetSourceType];
3855
3322
  /**
3856
3323
  * <p>The data source for the dataset.</p>
3857
3324
  * @public
@@ -3910,21 +3377,6 @@ export interface CreateDatasetRequest {
3910
3377
  */
3911
3378
  tags?: Record<string, string> | undefined;
3912
3379
  }
3913
- /**
3914
- * @public
3915
- * @enum
3916
- */
3917
- export declare const DatasetState: {
3918
- readonly ACTIVE: "ACTIVE";
3919
- readonly CREATING: "CREATING";
3920
- readonly DELETING: "DELETING";
3921
- readonly FAILED: "FAILED";
3922
- readonly UPDATING: "UPDATING";
3923
- };
3924
- /**
3925
- * @public
3926
- */
3927
- export type DatasetState = (typeof DatasetState)[keyof typeof DatasetState];
3928
3380
  /**
3929
3381
  * <p>The status of the dataset. This contains the state and any error messages. The state is
3930
3382
  * <code>ACTIVE</code> when ready to use.</p>
@@ -3981,19 +3433,6 @@ export interface Greengrass {
3981
3433
  */
3982
3434
  groupArn: string | undefined;
3983
3435
  }
3984
- /**
3985
- * @public
3986
- * @enum
3987
- */
3988
- export declare const CoreDeviceOperatingSystem: {
3989
- readonly LINUX_AARCH64: "LINUX_AARCH64";
3990
- readonly LINUX_AMD64: "LINUX_AMD64";
3991
- readonly WINDOWS_AMD64: "WINDOWS_AMD64";
3992
- };
3993
- /**
3994
- * @public
3995
- */
3996
- export type CoreDeviceOperatingSystem = (typeof CoreDeviceOperatingSystem)[keyof typeof CoreDeviceOperatingSystem];
3997
3436
  /**
3998
3437
  * <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2,
3999
3438
  * you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass
@@ -4114,17 +3553,6 @@ export interface CreateGatewayResponse {
4114
3553
  */
4115
3554
  gatewayArn: string | undefined;
4116
3555
  }
4117
- /**
4118
- * @public
4119
- * @enum
4120
- */
4121
- export declare const ImageFileType: {
4122
- readonly PNG: "PNG";
4123
- };
4124
- /**
4125
- * @public
4126
- */
4127
- export type ImageFileType = (typeof ImageFileType)[keyof typeof ImageFileType];
4128
3556
  /**
4129
3557
  * <p>Contains an image file.</p>
4130
3558
  * @public
@@ -4142,18 +3570,6 @@ export interface ImageFile {
4142
3570
  */
4143
3571
  type: ImageFileType | undefined;
4144
3572
  }
4145
- /**
4146
- * @public
4147
- * @enum
4148
- */
4149
- export declare const PortalType: {
4150
- readonly SITEWISE_PORTAL_V1: "SITEWISE_PORTAL_V1";
4151
- readonly SITEWISE_PORTAL_V2: "SITEWISE_PORTAL_V2";
4152
- };
4153
- /**
4154
- * @public
4155
- */
4156
- export type PortalType = (typeof PortalType)[keyof typeof PortalType];
4157
3573
  /**
4158
3574
  * <p>The configuration entry associated with the specific portal type. The <code>portalTypeConfiguration</code> is a map of the <code>portalTypeKey</code> to the
4159
3575
  * <code>PortalTypeEntry</code>.</p>
@@ -4262,19 +3678,6 @@ export interface CreatePortalRequest {
4262
3678
  */
4263
3679
  portalTypeConfiguration?: Record<string, PortalTypeEntry> | undefined;
4264
3680
  }
4265
- /**
4266
- * @public
4267
- * @enum
4268
- */
4269
- export declare const MonitorErrorCode: {
4270
- readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
4271
- readonly LIMIT_EXCEEDED: "LIMIT_EXCEEDED";
4272
- readonly VALIDATION_ERROR: "VALIDATION_ERROR";
4273
- };
4274
- /**
4275
- * @public
4276
- */
4277
- export type MonitorErrorCode = (typeof MonitorErrorCode)[keyof typeof MonitorErrorCode];
4278
3681
  /**
4279
3682
  * <p>Contains IoT SiteWise Monitor error details.</p>
4280
3683
  * @public
@@ -4291,22 +3694,6 @@ export interface MonitorErrorDetails {
4291
3694
  */
4292
3695
  message?: string | undefined;
4293
3696
  }
4294
- /**
4295
- * @public
4296
- * @enum
4297
- */
4298
- export declare const PortalState: {
4299
- readonly ACTIVE: "ACTIVE";
4300
- readonly CREATING: "CREATING";
4301
- readonly DELETING: "DELETING";
4302
- readonly FAILED: "FAILED";
4303
- readonly PENDING: "PENDING";
4304
- readonly UPDATING: "UPDATING";
4305
- };
4306
- /**
4307
- * @public
4308
- */
4309
- export type PortalState = (typeof PortalState)[keyof typeof PortalState];
4310
3697
  /**
4311
3698
  * <p>Contains information about the current status of a portal.</p>
4312
3699
  * @public
@@ -5627,17 +5014,6 @@ export interface DescribeComputationModelRequest {
5627
5014
  */
5628
5015
  computationModelVersion?: string | undefined;
5629
5016
  }
5630
- /**
5631
- * @public
5632
- * @enum
5633
- */
5634
- export declare const ResolveToResourceType: {
5635
- readonly ASSET: "ASSET";
5636
- };
5637
- /**
5638
- * @public
5639
- */
5640
- export type ResolveToResourceType = (typeof ResolveToResourceType)[keyof typeof ResolveToResourceType];
5641
5017
  /**
5642
5018
  * @public
5643
5019
  */
@@ -5821,19 +5197,6 @@ export interface ConfigurationErrorDetails {
5821
5197
  */
5822
5198
  message: string | undefined;
5823
5199
  }
5824
- /**
5825
- * @public
5826
- * @enum
5827
- */
5828
- export declare const ConfigurationState: {
5829
- readonly ACTIVE: "ACTIVE";
5830
- readonly UPDATE_FAILED: "UPDATE_FAILED";
5831
- readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
5832
- };
5833
- /**
5834
- * @public
5835
- */
5836
- export type ConfigurationState = (typeof ConfigurationState)[keyof typeof ConfigurationState];
5837
5200
  /**
5838
5201
  * <p>Contains current status information for the configuration.</p>
5839
5202
  * @public
@@ -5850,18 +5213,6 @@ export interface ConfigurationStatus {
5850
5213
  */
5851
5214
  error?: ConfigurationErrorDetails | undefined;
5852
5215
  }
5853
- /**
5854
- * @public
5855
- * @enum
5856
- */
5857
- export declare const EncryptionType: {
5858
- readonly KMS_BASED_ENCRYPTION: "KMS_BASED_ENCRYPTION";
5859
- readonly SITEWISE_DEFAULT_ENCRYPTION: "SITEWISE_DEFAULT_ENCRYPTION";
5860
- };
5861
- /**
5862
- * @public
5863
- */
5864
- export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
5865
5216
  /**
5866
5217
  * @public
5867
5218
  */
@@ -5895,19 +5246,6 @@ export interface DescribeExecutionRequest {
5895
5246
  */
5896
5247
  executionId: string | undefined;
5897
5248
  }
5898
- /**
5899
- * @public
5900
- * @enum
5901
- */
5902
- export declare const ExecutionState: {
5903
- readonly COMPLETED: "COMPLETED";
5904
- readonly FAILED: "FAILED";
5905
- readonly RUNNING: "RUNNING";
5906
- };
5907
- /**
5908
- * @public
5909
- */
5910
- export type ExecutionState = (typeof ExecutionState)[keyof typeof ExecutionState];
5911
5249
  /**
5912
5250
  * <p>The status of the execution.</p>
5913
5251
  * @public
@@ -6003,21 +5341,6 @@ export interface DescribeGatewayRequest {
6003
5341
  */
6004
5342
  gatewayId: string | undefined;
6005
5343
  }
6006
- /**
6007
- * @public
6008
- * @enum
6009
- */
6010
- export declare const CapabilitySyncStatus: {
6011
- readonly IN_SYNC: "IN_SYNC";
6012
- readonly NOT_APPLICABLE: "NOT_APPLICABLE";
6013
- readonly OUT_OF_SYNC: "OUT_OF_SYNC";
6014
- readonly SYNC_FAILED: "SYNC_FAILED";
6015
- readonly UNKNOWN: "UNKNOWN";
6016
- };
6017
- /**
6018
- * @public
6019
- */
6020
- export type CapabilitySyncStatus = (typeof CapabilitySyncStatus)[keyof typeof CapabilitySyncStatus];
6021
5344
  /**
6022
5345
  * <p>Contains a summary of a gateway capability configuration.</p>
6023
5346
  * @public
@@ -6181,19 +5504,6 @@ export interface DescribeGatewayCapabilityConfigurationResponse {
6181
5504
  */
6182
5505
  export interface DescribeLoggingOptionsRequest {
6183
5506
  }
6184
- /**
6185
- * @public
6186
- * @enum
6187
- */
6188
- export declare const LoggingLevel: {
6189
- readonly ERROR: "ERROR";
6190
- readonly INFO: "INFO";
6191
- readonly OFF: "OFF";
6192
- };
6193
- /**
6194
- * @public
6195
- */
6196
- export type LoggingLevel = (typeof LoggingLevel)[keyof typeof LoggingLevel];
6197
5507
  /**
6198
5508
  * <p>Contains logging options.</p>
6199
5509
  * @public
@@ -6398,18 +5708,6 @@ export interface DescribeProjectResponse {
6398
5708
  */
6399
5709
  export interface DescribeStorageConfigurationRequest {
6400
5710
  }
6401
- /**
6402
- * @public
6403
- * @enum
6404
- */
6405
- export declare const DisassociatedDataStorageState: {
6406
- readonly DISABLED: "DISABLED";
6407
- readonly ENABLED: "ENABLED";
6408
- };
6409
- /**
6410
- * @public
6411
- */
6412
- export type DisassociatedDataStorageState = (typeof DisassociatedDataStorageState)[keyof typeof DisassociatedDataStorageState];
6413
5711
  /**
6414
5712
  * <p>Contains information about a customer managed Amazon S3 bucket.</p>
6415
5713
  * @public
@@ -6463,30 +5761,6 @@ export interface RetentionPeriod {
6463
5761
  */
6464
5762
  unlimited?: boolean | undefined;
6465
5763
  }
6466
- /**
6467
- * @public
6468
- * @enum
6469
- */
6470
- export declare const StorageType: {
6471
- readonly MULTI_LAYER_STORAGE: "MULTI_LAYER_STORAGE";
6472
- readonly SITEWISE_DEFAULT_STORAGE: "SITEWISE_DEFAULT_STORAGE";
6473
- };
6474
- /**
6475
- * @public
6476
- */
6477
- export type StorageType = (typeof StorageType)[keyof typeof StorageType];
6478
- /**
6479
- * @public
6480
- * @enum
6481
- */
6482
- export declare const WarmTierState: {
6483
- readonly DISABLED: "DISABLED";
6484
- readonly ENABLED: "ENABLED";
6485
- };
6486
- /**
6487
- * @public
6488
- */
6489
- export type WarmTierState = (typeof WarmTierState)[keyof typeof WarmTierState];
6490
5764
  /**
6491
5765
  * <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>
6492
5766
  * @public
@@ -6798,21 +6072,6 @@ export interface ExecuteQueryRequest {
6798
6072
  */
6799
6073
  clientToken?: string | undefined;
6800
6074
  }
6801
- /**
6802
- * @public
6803
- * @enum
6804
- */
6805
- export declare const ScalarType: {
6806
- readonly BOOLEAN: "BOOLEAN";
6807
- readonly DOUBLE: "DOUBLE";
6808
- readonly INT: "INT";
6809
- readonly STRING: "STRING";
6810
- readonly TIMESTAMP: "TIMESTAMP";
6811
- };
6812
- /**
6813
- * @public
6814
- */
6815
- export type ScalarType = (typeof ScalarType)[keyof typeof ScalarType];
6816
6075
  /**
6817
6076
  * <p>The data type of the column.</p>
6818
6077
  * @public
@@ -6840,30 +6099,6 @@ export interface ColumnInfo {
6840
6099
  */
6841
6100
  type?: ColumnType | undefined;
6842
6101
  }
6843
- /**
6844
- * <p>The query timed out.</p>
6845
- * @public
6846
- */
6847
- export declare class QueryTimeoutException extends __BaseException {
6848
- readonly name: "QueryTimeoutException";
6849
- readonly $fault: "client";
6850
- /**
6851
- * @internal
6852
- */
6853
- constructor(opts: __ExceptionOptionType<QueryTimeoutException, __BaseException>);
6854
- }
6855
- /**
6856
- * <p>The validation failed for this query.</p>
6857
- * @public
6858
- */
6859
- export declare class ValidationException extends __BaseException {
6860
- readonly name: "ValidationException";
6861
- readonly $fault: "client";
6862
- /**
6863
- * @internal
6864
- */
6865
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
6866
- }
6867
6102
  /**
6868
6103
  * @public
6869
6104
  */
@@ -7268,3 +6503,1545 @@ export interface Location {
7268
6503
  */
7269
6504
  uri?: string | undefined;
7270
6505
  }
6506
+ /**
6507
+ * <p>The data source for the dataset.</p>
6508
+ * @public
6509
+ */
6510
+ export interface Source {
6511
+ /**
6512
+ * <p>Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index.</p>
6513
+ * @public
6514
+ */
6515
+ arn?: string | undefined;
6516
+ /**
6517
+ * <p>Contains the location information where the cited text is originally stored.
6518
+ * For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object.</p>
6519
+ * @public
6520
+ */
6521
+ location?: Location | undefined;
6522
+ }
6523
+ /**
6524
+ * <p>Contains information about the dataset use and it's source.</p>
6525
+ * @public
6526
+ */
6527
+ export interface DataSetReference {
6528
+ /**
6529
+ * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
6530
+ * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
6531
+ * @public
6532
+ */
6533
+ datasetArn?: string | undefined;
6534
+ /**
6535
+ * <p>The data source for the dataset.</p>
6536
+ * @public
6537
+ */
6538
+ source?: Source | undefined;
6539
+ }
6540
+ /**
6541
+ * <p>Contains the reference information.</p>
6542
+ * @public
6543
+ */
6544
+ export interface Reference {
6545
+ /**
6546
+ * <p>Contains the dataset reference information.</p>
6547
+ * @public
6548
+ */
6549
+ dataset?: DataSetReference | undefined;
6550
+ }
6551
+ /**
6552
+ * <p>Contains text content to which the SiteWise Assistant refers to, and generate the final response.
6553
+ * It also contains information about the source.</p>
6554
+ * @public
6555
+ */
6556
+ export interface Citation {
6557
+ /**
6558
+ * <p>Contains information about the data source.</p>
6559
+ * @public
6560
+ */
6561
+ reference?: Reference | undefined;
6562
+ /**
6563
+ * <p>Contains the cited text from the data source.</p>
6564
+ * @public
6565
+ */
6566
+ content?: Content | undefined;
6567
+ }
6568
+ /**
6569
+ * <p>This contains the SiteWise Assistant's response and the corresponding citation.</p>
6570
+ * @public
6571
+ */
6572
+ export interface InvocationOutput {
6573
+ /**
6574
+ * <p>The text message of the SiteWise Assistant's response.</p>
6575
+ * @public
6576
+ */
6577
+ message?: string | undefined;
6578
+ /**
6579
+ * <p>A list of citations, and related information for the SiteWise Assistant's response.</p>
6580
+ * @public
6581
+ */
6582
+ citations?: Citation[] | undefined;
6583
+ }
6584
+ /**
6585
+ * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
6586
+ * @public
6587
+ */
6588
+ export interface Trace {
6589
+ /**
6590
+ * <p>The cited text from the data source.</p>
6591
+ * @public
6592
+ */
6593
+ text?: string | undefined;
6594
+ }
6595
+ /**
6596
+ * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
6597
+ * @public
6598
+ */
6599
+ export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.ConflictingOperationExceptionMember | ResponseStream.InternalFailureExceptionMember | ResponseStream.InvalidRequestExceptionMember | ResponseStream.LimitExceededExceptionMember | ResponseStream.OutputMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.$UnknownMember;
6600
+ /**
6601
+ * @public
6602
+ */
6603
+ export declare namespace ResponseStream {
6604
+ /**
6605
+ * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
6606
+ * @public
6607
+ */
6608
+ interface TraceMember {
6609
+ trace: Trace;
6610
+ output?: never;
6611
+ accessDeniedException?: never;
6612
+ conflictingOperationException?: never;
6613
+ internalFailureException?: never;
6614
+ invalidRequestException?: never;
6615
+ limitExceededException?: never;
6616
+ resourceNotFoundException?: never;
6617
+ throttlingException?: never;
6618
+ $unknown?: never;
6619
+ }
6620
+ /**
6621
+ * <p>Contains the SiteWise Assistant's response.</p>
6622
+ * @public
6623
+ */
6624
+ interface OutputMember {
6625
+ trace?: never;
6626
+ output: InvocationOutput;
6627
+ accessDeniedException?: never;
6628
+ conflictingOperationException?: never;
6629
+ internalFailureException?: never;
6630
+ invalidRequestException?: never;
6631
+ limitExceededException?: never;
6632
+ resourceNotFoundException?: never;
6633
+ throttlingException?: never;
6634
+ $unknown?: never;
6635
+ }
6636
+ /**
6637
+ * <p>Access is denied.</p>
6638
+ * @public
6639
+ */
6640
+ interface AccessDeniedExceptionMember {
6641
+ trace?: never;
6642
+ output?: never;
6643
+ accessDeniedException: AccessDeniedException;
6644
+ conflictingOperationException?: never;
6645
+ internalFailureException?: never;
6646
+ invalidRequestException?: never;
6647
+ limitExceededException?: never;
6648
+ resourceNotFoundException?: never;
6649
+ throttlingException?: never;
6650
+ $unknown?: never;
6651
+ }
6652
+ /**
6653
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more
6654
+ * than one operation on the same resource at the same time.</p>
6655
+ * @public
6656
+ */
6657
+ interface ConflictingOperationExceptionMember {
6658
+ trace?: never;
6659
+ output?: never;
6660
+ accessDeniedException?: never;
6661
+ conflictingOperationException: ConflictingOperationException;
6662
+ internalFailureException?: never;
6663
+ invalidRequestException?: never;
6664
+ limitExceededException?: never;
6665
+ resourceNotFoundException?: never;
6666
+ throttlingException?: never;
6667
+ $unknown?: never;
6668
+ }
6669
+ /**
6670
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
6671
+ * @public
6672
+ */
6673
+ interface InternalFailureExceptionMember {
6674
+ trace?: never;
6675
+ output?: never;
6676
+ accessDeniedException?: never;
6677
+ conflictingOperationException?: never;
6678
+ internalFailureException: InternalFailureException;
6679
+ invalidRequestException?: never;
6680
+ limitExceededException?: never;
6681
+ resourceNotFoundException?: never;
6682
+ throttlingException?: never;
6683
+ $unknown?: never;
6684
+ }
6685
+ /**
6686
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
6687
+ * unsupported characters. Check your request and try again.</p>
6688
+ * @public
6689
+ */
6690
+ interface InvalidRequestExceptionMember {
6691
+ trace?: never;
6692
+ output?: never;
6693
+ accessDeniedException?: never;
6694
+ conflictingOperationException?: never;
6695
+ internalFailureException?: never;
6696
+ invalidRequestException: InvalidRequestException;
6697
+ limitExceededException?: never;
6698
+ resourceNotFoundException?: never;
6699
+ throttlingException?: never;
6700
+ $unknown?: never;
6701
+ }
6702
+ /**
6703
+ * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
6704
+ * associate more than the allowed number of child assets or attempting to create more than the
6705
+ * allowed number of properties for an asset model.</p>
6706
+ * <p>For more 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>
6707
+ * @public
6708
+ */
6709
+ interface LimitExceededExceptionMember {
6710
+ trace?: never;
6711
+ output?: never;
6712
+ accessDeniedException?: never;
6713
+ conflictingOperationException?: never;
6714
+ internalFailureException?: never;
6715
+ invalidRequestException?: never;
6716
+ limitExceededException: LimitExceededException;
6717
+ resourceNotFoundException?: never;
6718
+ throttlingException?: never;
6719
+ $unknown?: never;
6720
+ }
6721
+ /**
6722
+ * <p>The requested resource can't be found.</p>
6723
+ * @public
6724
+ */
6725
+ interface ResourceNotFoundExceptionMember {
6726
+ trace?: never;
6727
+ output?: never;
6728
+ accessDeniedException?: never;
6729
+ conflictingOperationException?: never;
6730
+ internalFailureException?: never;
6731
+ invalidRequestException?: never;
6732
+ limitExceededException?: never;
6733
+ resourceNotFoundException: ResourceNotFoundException;
6734
+ throttlingException?: never;
6735
+ $unknown?: never;
6736
+ }
6737
+ /**
6738
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
6739
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
6740
+ * on.</p>
6741
+ * <p>For more 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>
6742
+ * @public
6743
+ */
6744
+ interface ThrottlingExceptionMember {
6745
+ trace?: never;
6746
+ output?: never;
6747
+ accessDeniedException?: never;
6748
+ conflictingOperationException?: never;
6749
+ internalFailureException?: never;
6750
+ invalidRequestException?: never;
6751
+ limitExceededException?: never;
6752
+ resourceNotFoundException?: never;
6753
+ throttlingException: ThrottlingException;
6754
+ $unknown?: never;
6755
+ }
6756
+ /**
6757
+ * @public
6758
+ */
6759
+ interface $UnknownMember {
6760
+ trace?: never;
6761
+ output?: never;
6762
+ accessDeniedException?: never;
6763
+ conflictingOperationException?: never;
6764
+ internalFailureException?: never;
6765
+ invalidRequestException?: never;
6766
+ limitExceededException?: never;
6767
+ resourceNotFoundException?: never;
6768
+ throttlingException?: never;
6769
+ $unknown: [string, any];
6770
+ }
6771
+ /**
6772
+ * @deprecated unused in schema-serde mode.
6773
+ *
6774
+ */
6775
+ interface Visitor<T> {
6776
+ trace: (value: Trace) => T;
6777
+ output: (value: InvocationOutput) => T;
6778
+ accessDeniedException: (value: AccessDeniedException) => T;
6779
+ conflictingOperationException: (value: ConflictingOperationException) => T;
6780
+ internalFailureException: (value: InternalFailureException) => T;
6781
+ invalidRequestException: (value: InvalidRequestException) => T;
6782
+ limitExceededException: (value: LimitExceededException) => T;
6783
+ resourceNotFoundException: (value: ResourceNotFoundException) => T;
6784
+ throttlingException: (value: ThrottlingException) => T;
6785
+ _: (name: string, value: any) => T;
6786
+ }
6787
+ }
6788
+ /**
6789
+ * @public
6790
+ */
6791
+ export interface InvokeAssistantResponse {
6792
+ /**
6793
+ * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
6794
+ * @public
6795
+ */
6796
+ body: AsyncIterable<ResponseStream> | undefined;
6797
+ /**
6798
+ * <p>The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.</p>
6799
+ * @public
6800
+ */
6801
+ conversationId: string | undefined;
6802
+ }
6803
+ /**
6804
+ * @public
6805
+ */
6806
+ export interface ListAccessPoliciesRequest {
6807
+ /**
6808
+ * <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
6809
+ * if you specify <code>identityId</code>.</p>
6810
+ * @public
6811
+ */
6812
+ identityType?: IdentityType | undefined;
6813
+ /**
6814
+ * <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or
6815
+ * <code>GROUP</code> for <code>identityType</code>.</p>
6816
+ * @public
6817
+ */
6818
+ identityId?: string | undefined;
6819
+ /**
6820
+ * <p>The type of resource (portal or project). This parameter is required if you specify
6821
+ * <code>resourceId</code>.</p>
6822
+ * @public
6823
+ */
6824
+ resourceType?: ResourceType | undefined;
6825
+ /**
6826
+ * <p>The ID of the resource. This parameter is required if you specify
6827
+ * <code>resourceType</code>.</p>
6828
+ * @public
6829
+ */
6830
+ resourceId?: string | undefined;
6831
+ /**
6832
+ * <p>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the
6833
+ * <i>IAM User Guide</i>. This parameter is required if you specify
6834
+ * <code>IAM</code> for <code>identityType</code>.</p>
6835
+ * @public
6836
+ */
6837
+ iamArn?: string | undefined;
6838
+ /**
6839
+ * <p>The token to be used for the next set of paginated results.</p>
6840
+ * @public
6841
+ */
6842
+ nextToken?: string | undefined;
6843
+ /**
6844
+ * <p>The maximum number of results to return for each paginated request.</p>
6845
+ * <p>Default: 50</p>
6846
+ * @public
6847
+ */
6848
+ maxResults?: number | undefined;
6849
+ }
6850
+ /**
6851
+ * @public
6852
+ */
6853
+ export interface ListAccessPoliciesResponse {
6854
+ /**
6855
+ * <p>A list that summarizes each access policy.</p>
6856
+ * @public
6857
+ */
6858
+ accessPolicySummaries: AccessPolicySummary[] | undefined;
6859
+ /**
6860
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
6861
+ * @public
6862
+ */
6863
+ nextToken?: string | undefined;
6864
+ }
6865
+ /**
6866
+ * @public
6867
+ */
6868
+ export interface ListActionsRequest {
6869
+ /**
6870
+ * <p>The type of resource.</p>
6871
+ * @public
6872
+ */
6873
+ targetResourceType: TargetResourceType | undefined;
6874
+ /**
6875
+ * <p>The ID of the target resource.</p>
6876
+ * @public
6877
+ */
6878
+ targetResourceId: string | undefined;
6879
+ /**
6880
+ * <p>The token to be used for the next set of paginated results.</p>
6881
+ * @public
6882
+ */
6883
+ nextToken?: string | undefined;
6884
+ /**
6885
+ * <p>The maximum number of results to return for each paginated request.</p>
6886
+ * @public
6887
+ */
6888
+ maxResults?: number | undefined;
6889
+ /**
6890
+ * <p>The type of the resolved resource.</p>
6891
+ * @public
6892
+ */
6893
+ resolveToResourceType?: ResolveToResourceType | undefined;
6894
+ /**
6895
+ * <p>The ID of the resolved resource.</p>
6896
+ * @public
6897
+ */
6898
+ resolveToResourceId?: string | undefined;
6899
+ }
6900
+ /**
6901
+ * @public
6902
+ */
6903
+ export interface ListActionsResponse {
6904
+ /**
6905
+ * <p>A list that summarizes the actions associated with the specified asset.</p>
6906
+ * @public
6907
+ */
6908
+ actionSummaries: ActionSummary[] | undefined;
6909
+ /**
6910
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
6911
+ * @public
6912
+ */
6913
+ nextToken: string | undefined;
6914
+ }
6915
+ /**
6916
+ * @public
6917
+ */
6918
+ export interface ListAssetModelCompositeModelsRequest {
6919
+ /**
6920
+ * <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.
6921
+ * 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>
6922
+ * @public
6923
+ */
6924
+ assetModelId: string | undefined;
6925
+ /**
6926
+ * <p>The token to be used for the next set of paginated results.</p>
6927
+ * @public
6928
+ */
6929
+ nextToken?: string | undefined;
6930
+ /**
6931
+ * <p>The maximum number of results to return for each paginated request.</p>
6932
+ * <p>Default: 50</p>
6933
+ * @public
6934
+ */
6935
+ maxResults?: number | undefined;
6936
+ /**
6937
+ * <p>The version alias that specifies the latest or active version of the asset model.
6938
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
6939
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
6940
+ * @public
6941
+ */
6942
+ assetModelVersion?: string | undefined;
6943
+ }
6944
+ /**
6945
+ * @public
6946
+ */
6947
+ export interface ListAssetModelCompositeModelsResponse {
6948
+ /**
6949
+ * <p>A list that summarizes each composite model.</p>
6950
+ * @public
6951
+ */
6952
+ assetModelCompositeModelSummaries: AssetModelCompositeModelSummary[] | undefined;
6953
+ /**
6954
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
6955
+ * @public
6956
+ */
6957
+ nextToken?: string | undefined;
6958
+ }
6959
+ /**
6960
+ * @public
6961
+ */
6962
+ export interface ListAssetModelPropertiesRequest {
6963
+ /**
6964
+ * <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.
6965
+ * 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>
6966
+ * @public
6967
+ */
6968
+ assetModelId: string | undefined;
6969
+ /**
6970
+ * <p>The token to be used for the next set of paginated results.</p>
6971
+ * @public
6972
+ */
6973
+ nextToken?: string | undefined;
6974
+ /**
6975
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
6976
+ * @public
6977
+ */
6978
+ maxResults?: number | undefined;
6979
+ /**
6980
+ * <p> Filters the requested list of asset model properties. You can choose one of the following
6981
+ * options:</p>
6982
+ * <ul>
6983
+ * <li>
6984
+ * <p>
6985
+ * <code>ALL</code> – The list includes all asset model properties for a given asset
6986
+ * model ID. </p>
6987
+ * </li>
6988
+ * <li>
6989
+ * <p>
6990
+ * <code>BASE</code> – The list includes only base asset model properties for a given
6991
+ * asset model ID. </p>
6992
+ * </li>
6993
+ * </ul>
6994
+ * <p>Default: <code>BASE</code>
6995
+ * </p>
6996
+ * @public
6997
+ */
6998
+ filter?: ListAssetModelPropertiesFilter | undefined;
6999
+ /**
7000
+ * <p>The version alias that specifies the latest or active version of the asset model.
7001
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
7002
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
7003
+ * @public
7004
+ */
7005
+ assetModelVersion?: string | undefined;
7006
+ }
7007
+ /**
7008
+ * @public
7009
+ */
7010
+ export interface ListAssetModelPropertiesResponse {
7011
+ /**
7012
+ * <p>A list that summarizes the properties associated with the specified asset model.</p>
7013
+ * @public
7014
+ */
7015
+ assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
7016
+ /**
7017
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7018
+ * @public
7019
+ */
7020
+ nextToken?: string | undefined;
7021
+ }
7022
+ /**
7023
+ * @public
7024
+ */
7025
+ export interface ListAssetModelsRequest {
7026
+ /**
7027
+ * <p>The type of asset model. If you don't provide an <code>assetModelTypes</code>, all types
7028
+ * of asset models are returned.</p>
7029
+ * <ul>
7030
+ * <li>
7031
+ * <p>
7032
+ * <b>ASSET_MODEL</b> – An asset model that you can use
7033
+ * to create assets. Can't be included as a component in another asset model.</p>
7034
+ * </li>
7035
+ * <li>
7036
+ * <p>
7037
+ * <b>COMPONENT_MODEL</b> – A reusable component that
7038
+ * you can include in the composite models of other asset models. You can't create
7039
+ * assets directly from this type of asset model. </p>
7040
+ * </li>
7041
+ * <li>
7042
+ * <p>
7043
+ * <b>INTERFACE</b> – An interface is a type of model
7044
+ * that defines a standard structure that can be applied to different asset models.</p>
7045
+ * </li>
7046
+ * </ul>
7047
+ * @public
7048
+ */
7049
+ assetModelTypes?: AssetModelType[] | undefined;
7050
+ /**
7051
+ * <p>The token to be used for the next set of paginated results.</p>
7052
+ * @public
7053
+ */
7054
+ nextToken?: string | undefined;
7055
+ /**
7056
+ * <p>The maximum number of results to return for each paginated request.</p>
7057
+ * <p>Default: 50</p>
7058
+ * @public
7059
+ */
7060
+ maxResults?: number | undefined;
7061
+ /**
7062
+ * <p>The version alias that specifies the latest or active version of the asset model.
7063
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
7064
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
7065
+ * @public
7066
+ */
7067
+ assetModelVersion?: string | undefined;
7068
+ }
7069
+ /**
7070
+ * @public
7071
+ */
7072
+ export interface ListAssetModelsResponse {
7073
+ /**
7074
+ * <p>A list that summarizes each asset model.</p>
7075
+ * @public
7076
+ */
7077
+ assetModelSummaries: AssetModelSummary[] | undefined;
7078
+ /**
7079
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7080
+ * @public
7081
+ */
7082
+ nextToken?: string | undefined;
7083
+ }
7084
+ /**
7085
+ * @public
7086
+ */
7087
+ export interface ListAssetPropertiesRequest {
7088
+ /**
7089
+ * <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.
7090
+ * 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>
7091
+ * @public
7092
+ */
7093
+ assetId: string | undefined;
7094
+ /**
7095
+ * <p>The token to be used for the next set of paginated results.</p>
7096
+ * @public
7097
+ */
7098
+ nextToken?: string | undefined;
7099
+ /**
7100
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
7101
+ * @public
7102
+ */
7103
+ maxResults?: number | undefined;
7104
+ /**
7105
+ * <p> Filters the requested list of asset properties. You can choose one of the following
7106
+ * options:</p>
7107
+ * <ul>
7108
+ * <li>
7109
+ * <p>
7110
+ * <code>ALL</code> – The list includes all asset properties for a given asset model ID.
7111
+ * </p>
7112
+ * </li>
7113
+ * <li>
7114
+ * <p>
7115
+ * <code>BASE</code> – The list includes only base asset properties for a given asset
7116
+ * model ID. </p>
7117
+ * </li>
7118
+ * </ul>
7119
+ * <p>Default: <code>BASE</code>
7120
+ * </p>
7121
+ * @public
7122
+ */
7123
+ filter?: ListAssetPropertiesFilter | undefined;
7124
+ }
7125
+ /**
7126
+ * @public
7127
+ */
7128
+ export interface ListAssetPropertiesResponse {
7129
+ /**
7130
+ * <p>A list that summarizes the properties associated with the specified asset.</p>
7131
+ * @public
7132
+ */
7133
+ assetPropertySummaries: AssetPropertySummary[] | undefined;
7134
+ /**
7135
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7136
+ * @public
7137
+ */
7138
+ nextToken?: string | undefined;
7139
+ }
7140
+ /**
7141
+ * @public
7142
+ */
7143
+ export interface ListAssetRelationshipsRequest {
7144
+ /**
7145
+ * <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.
7146
+ * 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>
7147
+ * @public
7148
+ */
7149
+ assetId: string | undefined;
7150
+ /**
7151
+ * <p>The type of traversal to use to identify asset relationships. Choose the following
7152
+ * option:</p>
7153
+ * <ul>
7154
+ * <li>
7155
+ * <p>
7156
+ * <code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root
7157
+ * asset. The asset that you specify in <code>assetId</code> is the first result in the list
7158
+ * of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p>
7159
+ * </li>
7160
+ * </ul>
7161
+ * @public
7162
+ */
7163
+ traversalType: TraversalType | undefined;
7164
+ /**
7165
+ * <p>The token to be used for the next set of paginated results.</p>
7166
+ * @public
7167
+ */
7168
+ nextToken?: string | undefined;
7169
+ /**
7170
+ * <p>The maximum number of results to return for each paginated request.</p>
7171
+ * @public
7172
+ */
7173
+ maxResults?: number | undefined;
7174
+ }
7175
+ /**
7176
+ * @public
7177
+ */
7178
+ export interface ListAssetRelationshipsResponse {
7179
+ /**
7180
+ * <p>A list that summarizes each asset relationship.</p>
7181
+ * @public
7182
+ */
7183
+ assetRelationshipSummaries: AssetRelationshipSummary[] | undefined;
7184
+ /**
7185
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7186
+ * @public
7187
+ */
7188
+ nextToken?: string | undefined;
7189
+ }
7190
+ /**
7191
+ * @public
7192
+ */
7193
+ export interface ListAssetsRequest {
7194
+ /**
7195
+ * <p>The token to be used for the next set of paginated results.</p>
7196
+ * @public
7197
+ */
7198
+ nextToken?: string | undefined;
7199
+ /**
7200
+ * <p>The maximum number of results to return for each paginated request.</p>
7201
+ * <p>Default: 50</p>
7202
+ * @public
7203
+ */
7204
+ maxResults?: number | undefined;
7205
+ /**
7206
+ * <p>The ID of the asset model by which to filter the list of assets. This parameter is
7207
+ * 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.
7208
+ * 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>
7209
+ * @public
7210
+ */
7211
+ assetModelId?: string | undefined;
7212
+ /**
7213
+ * <p>The filter for the requested list of assets. Choose one of the following options:</p>
7214
+ * <ul>
7215
+ * <li>
7216
+ * <p>
7217
+ * <code>ALL</code> – The list includes all assets for a given asset model ID. The
7218
+ * <code>assetModelId</code> parameter is required if you filter by
7219
+ * <code>ALL</code>.</p>
7220
+ * </li>
7221
+ * <li>
7222
+ * <p>
7223
+ * <code>TOP_LEVEL</code> – The list includes only top-level assets in the asset
7224
+ * hierarchy tree.</p>
7225
+ * </li>
7226
+ * </ul>
7227
+ * <p>Default: <code>ALL</code>
7228
+ * </p>
7229
+ * @public
7230
+ */
7231
+ filter?: ListAssetsFilter | undefined;
7232
+ }
7233
+ /**
7234
+ * @public
7235
+ */
7236
+ export interface ListAssetsResponse {
7237
+ /**
7238
+ * <p>A list that summarizes each asset.</p>
7239
+ * @public
7240
+ */
7241
+ assetSummaries: AssetSummary[] | undefined;
7242
+ /**
7243
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7244
+ * @public
7245
+ */
7246
+ nextToken?: string | undefined;
7247
+ }
7248
+ /**
7249
+ * @public
7250
+ */
7251
+ export interface ListAssociatedAssetsRequest {
7252
+ /**
7253
+ * <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.
7254
+ * 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>
7255
+ * @public
7256
+ */
7257
+ assetId: string | undefined;
7258
+ /**
7259
+ * <p>(Optional) If you don't provide a <code>hierarchyId</code>, all the immediate assets in
7260
+ * the <code>traversalDirection</code> will be returned. </p>
7261
+ * <p> The ID of the hierarchy by which child assets are associated to the asset.
7262
+ * (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
7263
+ * 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>
7264
+ * <p>For more 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>
7265
+ * @public
7266
+ */
7267
+ hierarchyId?: string | undefined;
7268
+ /**
7269
+ * <p>The direction to list associated assets. Choose one of the following options:</p>
7270
+ * <ul>
7271
+ * <li>
7272
+ * <p>
7273
+ * <code>CHILD</code> – The list includes all child assets associated to the
7274
+ * asset.</p>
7275
+ * </li>
7276
+ * <li>
7277
+ * <p>
7278
+ * <code>PARENT</code> – The list includes the asset's parent asset.</p>
7279
+ * </li>
7280
+ * </ul>
7281
+ * <p>Default: <code>CHILD</code>
7282
+ * </p>
7283
+ * @public
7284
+ */
7285
+ traversalDirection?: TraversalDirection | undefined;
7286
+ /**
7287
+ * <p>The token to be used for the next set of paginated results.</p>
7288
+ * @public
7289
+ */
7290
+ nextToken?: string | undefined;
7291
+ /**
7292
+ * <p>The maximum number of results to return for each paginated request.</p>
7293
+ * <p>Default: 50</p>
7294
+ * @public
7295
+ */
7296
+ maxResults?: number | undefined;
7297
+ }
7298
+ /**
7299
+ * @public
7300
+ */
7301
+ export interface ListAssociatedAssetsResponse {
7302
+ /**
7303
+ * <p>A list that summarizes the associated assets.</p>
7304
+ * @public
7305
+ */
7306
+ assetSummaries: AssociatedAssetsSummary[] | undefined;
7307
+ /**
7308
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7309
+ * @public
7310
+ */
7311
+ nextToken?: string | undefined;
7312
+ }
7313
+ /**
7314
+ * @public
7315
+ */
7316
+ export interface ListBulkImportJobsRequest {
7317
+ /**
7318
+ * <p>The token to be used for the next set of paginated results.</p>
7319
+ * @public
7320
+ */
7321
+ nextToken?: string | undefined;
7322
+ /**
7323
+ * <p>The maximum number of results to return for each paginated request.</p>
7324
+ * @public
7325
+ */
7326
+ maxResults?: number | undefined;
7327
+ /**
7328
+ * <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
7329
+ * @public
7330
+ */
7331
+ filter?: ListBulkImportJobsFilter | undefined;
7332
+ }
7333
+ /**
7334
+ * <p>Contains the job summary information.</p>
7335
+ * @public
7336
+ */
7337
+ export interface JobSummary {
7338
+ /**
7339
+ * <p>The ID of the job.</p>
7340
+ * @public
7341
+ */
7342
+ id: string | undefined;
7343
+ /**
7344
+ * <p>The unique name that helps identify the job request.</p>
7345
+ * @public
7346
+ */
7347
+ name: string | undefined;
7348
+ /**
7349
+ * <p>The status of the bulk import job can be one of following values:</p>
7350
+ * <ul>
7351
+ * <li>
7352
+ * <p>
7353
+ * <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p>
7354
+ * </li>
7355
+ * <li>
7356
+ * <p>
7357
+ * <code>CANCELLED</code> – The bulk import job has been canceled.</p>
7358
+ * </li>
7359
+ * <li>
7360
+ * <p>
7361
+ * <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p>
7362
+ * </li>
7363
+ * <li>
7364
+ * <p>
7365
+ * <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p>
7366
+ * </li>
7367
+ * <li>
7368
+ * <p>
7369
+ * <code>FAILED</code> – IoT SiteWise couldn't process your request to import data from Amazon S3.
7370
+ * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
7371
+ * </li>
7372
+ * <li>
7373
+ * <p>
7374
+ * <code>COMPLETED_WITH_FAILURES</code> – IoT SiteWise completed your request to import data from Amazon S3 with errors.
7375
+ * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
7376
+ * </li>
7377
+ * </ul>
7378
+ * @public
7379
+ */
7380
+ status: JobStatus | undefined;
7381
+ }
7382
+ /**
7383
+ * @public
7384
+ */
7385
+ export interface ListBulkImportJobsResponse {
7386
+ /**
7387
+ * <p>One or more job summaries to list.</p>
7388
+ * @public
7389
+ */
7390
+ jobSummaries: JobSummary[] | undefined;
7391
+ /**
7392
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7393
+ * @public
7394
+ */
7395
+ nextToken?: string | undefined;
7396
+ }
7397
+ /**
7398
+ * @public
7399
+ */
7400
+ export interface ListCompositionRelationshipsRequest {
7401
+ /**
7402
+ * <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.
7403
+ * 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>
7404
+ * @public
7405
+ */
7406
+ assetModelId: string | undefined;
7407
+ /**
7408
+ * <p>The token to be used for the next set of paginated results.</p>
7409
+ * @public
7410
+ */
7411
+ nextToken?: string | undefined;
7412
+ /**
7413
+ * <p>The maximum number of results to return for each paginated request.</p>
7414
+ * <p>Default: 50</p>
7415
+ * @public
7416
+ */
7417
+ maxResults?: number | undefined;
7418
+ }
7419
+ /**
7420
+ * <p>Contains a summary of the components of the composite model.</p>
7421
+ * @public
7422
+ */
7423
+ export interface CompositionRelationshipSummary {
7424
+ /**
7425
+ * <p>The ID of the asset model, in UUID format.</p>
7426
+ * @public
7427
+ */
7428
+ assetModelId: string | undefined;
7429
+ /**
7430
+ * <p>The ID of a composite model on this asset model.</p>
7431
+ * @public
7432
+ */
7433
+ assetModelCompositeModelId: string | undefined;
7434
+ /**
7435
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
7436
+ * <code> AWS/L4E_ANOMALY</code>.</p>
7437
+ * @public
7438
+ */
7439
+ assetModelCompositeModelType: string | undefined;
7440
+ }
7441
+ /**
7442
+ * @public
7443
+ */
7444
+ export interface ListCompositionRelationshipsResponse {
7445
+ /**
7446
+ * <p>A list that summarizes each composition relationship.</p>
7447
+ * @public
7448
+ */
7449
+ compositionRelationshipSummaries: CompositionRelationshipSummary[] | undefined;
7450
+ /**
7451
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7452
+ * @public
7453
+ */
7454
+ nextToken?: string | undefined;
7455
+ }
7456
+ /**
7457
+ * <p>A filter used to match specific data binding values based on criteria. This filter allows
7458
+ * searching for data bindings by asset, asset model, asset property, or asset model
7459
+ * property.</p>
7460
+ * @public
7461
+ */
7462
+ export interface DataBindingValueFilter {
7463
+ /**
7464
+ * <p>Filter criteria for matching data bindings based on a specific asset. Used to list all
7465
+ * data bindings referencing a particular asset or its properties.</p>
7466
+ * @public
7467
+ */
7468
+ asset?: AssetBindingValueFilter | undefined;
7469
+ /**
7470
+ * <p>Filter criteria for matching data bindings based on a specific asset model. Used to list
7471
+ * all data bindings referencing a particular asset model or its properties.</p>
7472
+ * @public
7473
+ */
7474
+ assetModel?: AssetModelBindingValueFilter | undefined;
7475
+ /**
7476
+ * <p>Filter criteria for matching data bindings based on a specific asset property. Used to
7477
+ * list all data bindings referencing a particular property of an asset.</p>
7478
+ * @public
7479
+ */
7480
+ assetProperty?: AssetPropertyBindingValueFilter | undefined;
7481
+ /**
7482
+ * <p>Filter criteria for matching data bindings based on a specific asset model property. Used
7483
+ * to list all data bindings referencing a particular property of an asset model.</p>
7484
+ * @public
7485
+ */
7486
+ assetModelProperty?: AssetModelPropertyBindingValueFilter | undefined;
7487
+ }
7488
+ /**
7489
+ * @public
7490
+ */
7491
+ export interface ListComputationModelDataBindingUsagesRequest {
7492
+ /**
7493
+ * <p>A filter used to limit the returned data binding usages based on specific data binding
7494
+ * values. You can filter by asset, asset model, asset property, or asset model property to find
7495
+ * all computation models using these specific data sources.</p>
7496
+ * @public
7497
+ */
7498
+ dataBindingValueFilter: DataBindingValueFilter | undefined;
7499
+ /**
7500
+ * <p>The token used for the next set of paginated results.</p>
7501
+ * @public
7502
+ */
7503
+ nextToken?: string | undefined;
7504
+ /**
7505
+ * <p>The maximum number of results returned for each paginated request.</p>
7506
+ * @public
7507
+ */
7508
+ maxResults?: number | undefined;
7509
+ }
7510
+ /**
7511
+ * <p>Represents a value used in a data binding. It can be an asset property or an asset model
7512
+ * property.</p>
7513
+ * @public
7514
+ */
7515
+ export interface DataBindingValue {
7516
+ /**
7517
+ * <p>Contains information about an <code>assetModelProperty</code> binding value.</p>
7518
+ * @public
7519
+ */
7520
+ assetModelProperty?: AssetModelPropertyBindingValue | undefined;
7521
+ /**
7522
+ * <p>The asset property value used in the data binding.</p>
7523
+ * @public
7524
+ */
7525
+ assetProperty?: AssetPropertyBindingValue | undefined;
7526
+ }
7527
+ /**
7528
+ * <p>Represents a data binding that matches the specified filter criteria.</p>
7529
+ * @public
7530
+ */
7531
+ export interface MatchedDataBinding {
7532
+ /**
7533
+ * <p>The value of the matched data binding.</p>
7534
+ * @public
7535
+ */
7536
+ value: DataBindingValue | undefined;
7537
+ }
7538
+ /**
7539
+ * <p>A summary of how a specific data binding is used across computation models. This tracks
7540
+ * dependencies between data sources and computation models, allowing you to understand the
7541
+ * impact of changes to data sources.</p>
7542
+ * @public
7543
+ */
7544
+ export interface ComputationModelDataBindingUsageSummary {
7545
+ /**
7546
+ * <p>The list of computation model IDs that use this data binding. This allows identification
7547
+ * of all computation models affected by changes to the referenced data source.</p>
7548
+ * @public
7549
+ */
7550
+ computationModelIds: string[] | undefined;
7551
+ /**
7552
+ * <p>The data binding matched by the filter criteria. Contains details about specific data
7553
+ * binding values used by the computation models.</p>
7554
+ * @public
7555
+ */
7556
+ matchedDataBinding: MatchedDataBinding | undefined;
7557
+ }
7558
+ /**
7559
+ * @public
7560
+ */
7561
+ export interface ListComputationModelDataBindingUsagesResponse {
7562
+ /**
7563
+ * <p>A list of summaries describing the data binding usages across computation models. Each
7564
+ * summary includes the computation model IDs and the matched data binding details.</p>
7565
+ * @public
7566
+ */
7567
+ dataBindingUsageSummaries: ComputationModelDataBindingUsageSummary[] | undefined;
7568
+ /**
7569
+ * <p>The token for the next set of paginated results, or null if there are no additional
7570
+ * results.</p>
7571
+ * @public
7572
+ */
7573
+ nextToken?: string | undefined;
7574
+ }
7575
+ /**
7576
+ * @public
7577
+ */
7578
+ export interface ListComputationModelResolveToResourcesRequest {
7579
+ /**
7580
+ * <p>The ID of the computation model for which to list resolved resources.</p>
7581
+ * @public
7582
+ */
7583
+ computationModelId: string | undefined;
7584
+ /**
7585
+ * <p>The token used for the next set of paginated results.</p>
7586
+ * @public
7587
+ */
7588
+ nextToken?: string | undefined;
7589
+ /**
7590
+ * <p>The maximum number of results returned for each paginated request.</p>
7591
+ * @public
7592
+ */
7593
+ maxResults?: number | undefined;
7594
+ }
7595
+ /**
7596
+ * <p>A summary of the resource that a computation model resolves to.</p>
7597
+ * @public
7598
+ */
7599
+ export interface ComputationModelResolveToResourceSummary {
7600
+ /**
7601
+ * <p>The detailed resource this execution summary resolves to.</p>
7602
+ * @public
7603
+ */
7604
+ resolveTo?: ResolveTo | undefined;
7605
+ }
7606
+ /**
7607
+ * @public
7608
+ */
7609
+ export interface ListComputationModelResolveToResourcesResponse {
7610
+ /**
7611
+ * <p>A list of summaries describing the distinct resources that this computation model resolves
7612
+ * to when actions were executed.</p>
7613
+ * @public
7614
+ */
7615
+ computationModelResolveToResourceSummaries: ComputationModelResolveToResourceSummary[] | undefined;
7616
+ /**
7617
+ * <p>The token for the next set of paginated results, or null if there are no additional
7618
+ * results.</p>
7619
+ * @public
7620
+ */
7621
+ nextToken?: string | undefined;
7622
+ }
7623
+ /**
7624
+ * @public
7625
+ */
7626
+ export interface ListComputationModelsRequest {
7627
+ /**
7628
+ * <p>The type of computation model. If a <code>computationModelType</code> is not provided, all
7629
+ * types of computation models are returned.</p>
7630
+ * @public
7631
+ */
7632
+ computationModelType?: ComputationModelType | undefined;
7633
+ /**
7634
+ * <p>The token to be used for the next set of paginated results.</p>
7635
+ * @public
7636
+ */
7637
+ nextToken?: string | undefined;
7638
+ /**
7639
+ * <p>The maximum number of results to return for each paginated request.</p>
7640
+ * @public
7641
+ */
7642
+ maxResults?: number | undefined;
7643
+ }
7644
+ /**
7645
+ * <p>Contains a summary of a computation model.</p>
7646
+ * @public
7647
+ */
7648
+ export interface ComputationModelSummary {
7649
+ /**
7650
+ * <p>The ID of the computation model.</p>
7651
+ * @public
7652
+ */
7653
+ id: string | undefined;
7654
+ /**
7655
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the computation model, which has the following format.</p>
7656
+ * <p>
7657
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:computation-model/$\{ComputationModelId\}</code>
7658
+ * </p>
7659
+ * @public
7660
+ */
7661
+ arn: string | undefined;
7662
+ /**
7663
+ * <p>The name of the computation model.</p>
7664
+ * @public
7665
+ */
7666
+ name: string | undefined;
7667
+ /**
7668
+ * <p>The description of the computation model.</p>
7669
+ * @public
7670
+ */
7671
+ description?: string | undefined;
7672
+ /**
7673
+ * <p>The type of the computation model.</p>
7674
+ * @public
7675
+ */
7676
+ type: ComputationModelType | undefined;
7677
+ /**
7678
+ * <p>The model creation date, in Unix epoch time.</p>
7679
+ * @public
7680
+ */
7681
+ creationDate: Date | undefined;
7682
+ /**
7683
+ * <p>The time the model was last updated, in Unix epoch time.</p>
7684
+ * @public
7685
+ */
7686
+ lastUpdateDate: Date | undefined;
7687
+ /**
7688
+ * <p>The current status of the computation model.</p>
7689
+ * @public
7690
+ */
7691
+ status: ComputationModelStatus | undefined;
7692
+ /**
7693
+ * <p>The version of the computation model.</p>
7694
+ * @public
7695
+ */
7696
+ version: string | undefined;
7697
+ }
7698
+ /**
7699
+ * @public
7700
+ */
7701
+ export interface ListComputationModelsResponse {
7702
+ /**
7703
+ * <p>A list summarizing each computation model.</p>
7704
+ * @public
7705
+ */
7706
+ computationModelSummaries: ComputationModelSummary[] | undefined;
7707
+ /**
7708
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7709
+ * @public
7710
+ */
7711
+ nextToken?: string | undefined;
7712
+ }
7713
+ /**
7714
+ * @public
7715
+ */
7716
+ export interface ListDashboardsRequest {
7717
+ /**
7718
+ * <p>The ID of the project.</p>
7719
+ * @public
7720
+ */
7721
+ projectId: string | undefined;
7722
+ /**
7723
+ * <p>The token to be used for the next set of paginated results.</p>
7724
+ * @public
7725
+ */
7726
+ nextToken?: string | undefined;
7727
+ /**
7728
+ * <p>The maximum number of results to return for each paginated request.</p>
7729
+ * <p>Default: 50</p>
7730
+ * @public
7731
+ */
7732
+ maxResults?: number | undefined;
7733
+ }
7734
+ /**
7735
+ * <p>Contains a dashboard summary.</p>
7736
+ * @public
7737
+ */
7738
+ export interface DashboardSummary {
7739
+ /**
7740
+ * <p>The ID of the dashboard.</p>
7741
+ * @public
7742
+ */
7743
+ id: string | undefined;
7744
+ /**
7745
+ * <p>The name of the dashboard</p>
7746
+ * @public
7747
+ */
7748
+ name: string | undefined;
7749
+ /**
7750
+ * <p>The dashboard's description.</p>
7751
+ * @public
7752
+ */
7753
+ description?: string | undefined;
7754
+ /**
7755
+ * <p>The date the dashboard was created, in Unix epoch time.</p>
7756
+ * @public
7757
+ */
7758
+ creationDate?: Date | undefined;
7759
+ /**
7760
+ * <p>The date the dashboard was last updated, in Unix epoch time.</p>
7761
+ * @public
7762
+ */
7763
+ lastUpdateDate?: Date | undefined;
7764
+ }
7765
+ /**
7766
+ * @public
7767
+ */
7768
+ export interface ListDashboardsResponse {
7769
+ /**
7770
+ * <p>A list that summarizes each dashboard in the project.</p>
7771
+ * @public
7772
+ */
7773
+ dashboardSummaries: DashboardSummary[] | undefined;
7774
+ /**
7775
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7776
+ * @public
7777
+ */
7778
+ nextToken?: string | undefined;
7779
+ }
7780
+ /**
7781
+ * @public
7782
+ */
7783
+ export interface ListDatasetsRequest {
7784
+ /**
7785
+ * <p>The type of data source for the dataset.</p>
7786
+ * @public
7787
+ */
7788
+ sourceType: DatasetSourceType | undefined;
7789
+ /**
7790
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7791
+ * @public
7792
+ */
7793
+ nextToken?: string | undefined;
7794
+ /**
7795
+ * <p>The maximum number of results to return for each paginated request.</p>
7796
+ * @public
7797
+ */
7798
+ maxResults?: number | undefined;
7799
+ }
7800
+ /**
7801
+ * <p>The summary details for the dataset.</p>
7802
+ * @public
7803
+ */
7804
+ export interface DatasetSummary {
7805
+ /**
7806
+ * <p>The ID of the dataset.</p>
7807
+ * @public
7808
+ */
7809
+ id: string | undefined;
7810
+ /**
7811
+ * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
7812
+ * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
7813
+ * @public
7814
+ */
7815
+ arn: string | undefined;
7816
+ /**
7817
+ * <p>The name of the dataset.</p>
7818
+ * @public
7819
+ */
7820
+ name: string | undefined;
7821
+ /**
7822
+ * <p>A description about the dataset, and its functionality.</p>
7823
+ * @public
7824
+ */
7825
+ description: string | undefined;
7826
+ /**
7827
+ * <p>The dataset creation date, in Unix epoch time.</p>
7828
+ * @public
7829
+ */
7830
+ creationDate: Date | undefined;
7831
+ /**
7832
+ * <p>The date the dataset was last updated, in Unix epoch time.</p>
7833
+ * @public
7834
+ */
7835
+ lastUpdateDate: Date | undefined;
7836
+ /**
7837
+ * <p>The status of the dataset. This contains the state and any error messages. The state is
7838
+ * <code>ACTIVE</code> when ready to use.</p>
7839
+ * @public
7840
+ */
7841
+ status: DatasetStatus | undefined;
7842
+ }
7843
+ /**
7844
+ * @public
7845
+ */
7846
+ export interface ListDatasetsResponse {
7847
+ /**
7848
+ * <p>A list that summarizes the dataset response.</p>
7849
+ * @public
7850
+ */
7851
+ datasetSummaries: DatasetSummary[] | undefined;
7852
+ /**
7853
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7854
+ * @public
7855
+ */
7856
+ nextToken?: string | undefined;
7857
+ }
7858
+ /**
7859
+ * @public
7860
+ */
7861
+ export interface ListExecutionsRequest {
7862
+ /**
7863
+ * <p>The type of the target resource.</p>
7864
+ * @public
7865
+ */
7866
+ targetResourceType: TargetResourceType | undefined;
7867
+ /**
7868
+ * <p>The ID of the target resource.</p>
7869
+ * @public
7870
+ */
7871
+ targetResourceId: string | undefined;
7872
+ /**
7873
+ * <p>The type of the resolved resource.</p>
7874
+ * @public
7875
+ */
7876
+ resolveToResourceType?: ResolveToResourceType | undefined;
7877
+ /**
7878
+ * <p>The ID of the resolved resource.</p>
7879
+ * @public
7880
+ */
7881
+ resolveToResourceId?: string | undefined;
7882
+ /**
7883
+ * <p>The token used for the next set of paginated results.</p>
7884
+ * @public
7885
+ */
7886
+ nextToken?: string | undefined;
7887
+ /**
7888
+ * <p>The maximum number of results returned for each paginated request.</p>
7889
+ * @public
7890
+ */
7891
+ maxResults?: number | undefined;
7892
+ /**
7893
+ * <p>The type of action exectued.</p>
7894
+ * @public
7895
+ */
7896
+ actionType?: string | undefined;
7897
+ }
7898
+ /**
7899
+ * <p>Contains the execution summary of the computation model.</p>
7900
+ * @public
7901
+ */
7902
+ export interface ExecutionSummary {
7903
+ /**
7904
+ * <p>The ID of the execution.</p>
7905
+ * @public
7906
+ */
7907
+ executionId: string | undefined;
7908
+ /**
7909
+ * <p>The type of action exectued.</p>
7910
+ * @public
7911
+ */
7912
+ actionType?: string | undefined;
7913
+ /**
7914
+ * <p>The resource the action will be taken on. This can include asset-based resources and
7915
+ * computation model resources.</p>
7916
+ * @public
7917
+ */
7918
+ targetResource: TargetResource | undefined;
7919
+ /**
7920
+ * <p>The version of the target resource.</p>
7921
+ * @public
7922
+ */
7923
+ targetResourceVersion: string | undefined;
7924
+ /**
7925
+ * <p>The detailed resource this execution resolves to.</p>
7926
+ * @public
7927
+ */
7928
+ resolveTo?: ResolveTo | undefined;
7929
+ /**
7930
+ * <p>The time the process started.</p>
7931
+ * @public
7932
+ */
7933
+ executionStartTime: Date | undefined;
7934
+ /**
7935
+ * <p>The time the process ended.</p>
7936
+ * @public
7937
+ */
7938
+ executionEndTime?: Date | undefined;
7939
+ /**
7940
+ * <p>The status of the execution process.</p>
7941
+ * @public
7942
+ */
7943
+ executionStatus: ExecutionStatus | undefined;
7944
+ /**
7945
+ * <p>The execution entity version associated with the summary.</p>
7946
+ * @public
7947
+ */
7948
+ executionEntityVersion?: string | undefined;
7949
+ }
7950
+ /**
7951
+ * @public
7952
+ */
7953
+ export interface ListExecutionsResponse {
7954
+ /**
7955
+ * <p>Contains the list of execution summaries of the computation models.</p>
7956
+ * @public
7957
+ */
7958
+ executionSummaries: ExecutionSummary[] | undefined;
7959
+ /**
7960
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
7961
+ * @public
7962
+ */
7963
+ nextToken?: string | undefined;
7964
+ }
7965
+ /**
7966
+ * @public
7967
+ */
7968
+ export interface ListGatewaysRequest {
7969
+ /**
7970
+ * <p>The token to be used for the next set of paginated results.</p>
7971
+ * @public
7972
+ */
7973
+ nextToken?: string | undefined;
7974
+ /**
7975
+ * <p>The maximum number of results to return for each paginated request.</p>
7976
+ * <p>Default: 50</p>
7977
+ * @public
7978
+ */
7979
+ maxResults?: number | undefined;
7980
+ }
7981
+ /**
7982
+ * <p>Contains a summary of a gateway.</p>
7983
+ * @public
7984
+ */
7985
+ export interface GatewaySummary {
7986
+ /**
7987
+ * <p>The ID of the gateway device.</p>
7988
+ * @public
7989
+ */
7990
+ gatewayId: string | undefined;
7991
+ /**
7992
+ * <p>The name of the gateway.</p>
7993
+ * @public
7994
+ */
7995
+ gatewayName: string | undefined;
7996
+ /**
7997
+ * <p>The gateway's platform configuration. You can only specify one platform type in a
7998
+ * gateway.</p>
7999
+ * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter
8000
+ * with a valid Greengrass group ARN.</p>
8001
+ * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid
8002
+ * core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must
8003
+ * also specify the <code>coreDeviceOperatingSystem</code>.</p>
8004
+ * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a
8005
+ * valid IoT Core thing name.</p>
8006
+ * @public
8007
+ */
8008
+ gatewayPlatform?: GatewayPlatform | undefined;
8009
+ /**
8010
+ * <p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3
8011
+ * gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>
8012
+ * @public
8013
+ */
8014
+ gatewayVersion?: string | undefined;
8015
+ /**
8016
+ * <p>A list of gateway capability summaries that each contain a namespace and status. Each
8017
+ * gateway capability defines data sources for the gateway. To retrieve a capability
8018
+ * configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
8019
+ * @public
8020
+ */
8021
+ gatewayCapabilitySummaries?: GatewayCapabilitySummary[] | undefined;
8022
+ /**
8023
+ * <p>The date the gateway was created, in Unix epoch time.</p>
8024
+ * @public
8025
+ */
8026
+ creationDate: Date | undefined;
8027
+ /**
8028
+ * <p>The date the gateway was last updated, in Unix epoch time.</p>
8029
+ * @public
8030
+ */
8031
+ lastUpdateDate: Date | undefined;
8032
+ }
8033
+ /**
8034
+ * @public
8035
+ */
8036
+ export interface ListGatewaysResponse {
8037
+ /**
8038
+ * <p>A list that summarizes each gateway.</p>
8039
+ * @public
8040
+ */
8041
+ gatewaySummaries: GatewaySummary[] | undefined;
8042
+ /**
8043
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
8044
+ * @public
8045
+ */
8046
+ nextToken?: string | undefined;
8047
+ }