@aws-sdk/client-iotsitewise 3.321.1 → 3.326.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 (74) hide show
  1. package/dist-types/commands/AssociateAssetsCommand.d.ts +4 -0
  2. package/dist-types/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +4 -0
  3. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +12 -0
  4. package/dist-types/commands/BatchDisassociateProjectAssetsCommand.d.ts +12 -0
  5. package/dist-types/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +42 -0
  6. package/dist-types/commands/BatchGetAssetPropertyValueCommand.d.ts +41 -0
  7. package/dist-types/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +43 -0
  8. package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +22 -0
  9. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +7 -0
  10. package/dist-types/commands/CreateAssetCommand.d.ts +20 -0
  11. package/dist-types/commands/CreateAssetModelCommand.d.ts +20 -0
  12. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +8 -0
  13. package/dist-types/commands/CreateDashboardCommand.d.ts +7 -0
  14. package/dist-types/commands/CreateGatewayCommand.d.ts +7 -0
  15. package/dist-types/commands/CreatePortalCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateProjectCommand.d.ts +7 -0
  17. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteAssetCommand.d.ts +18 -0
  19. package/dist-types/commands/DeleteAssetModelCommand.d.ts +18 -0
  20. package/dist-types/commands/DeleteDashboardCommand.d.ts +4 -0
  21. package/dist-types/commands/DeleteGatewayCommand.d.ts +4 -0
  22. package/dist-types/commands/DeletePortalCommand.d.ts +12 -0
  23. package/dist-types/commands/DeleteProjectCommand.d.ts +4 -0
  24. package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +4 -0
  25. package/dist-types/commands/DescribeAccessPolicyCommand.d.ts +32 -0
  26. package/dist-types/commands/DescribeAssetCommand.d.ts +67 -0
  27. package/dist-types/commands/DescribeAssetModelCommand.d.ts +159 -0
  28. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +137 -0
  29. package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +31 -0
  30. package/dist-types/commands/DescribeDashboardCommand.d.ts +13 -0
  31. package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +14 -0
  32. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +9 -0
  33. package/dist-types/commands/DescribeGatewayCommand.d.ts +24 -0
  34. package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +8 -0
  35. package/dist-types/commands/DescribePortalCommand.d.ts +32 -0
  36. package/dist-types/commands/DescribeProjectCommand.d.ts +12 -0
  37. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +25 -0
  38. package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +14 -0
  39. package/dist-types/commands/DisassociateAssetsCommand.d.ts +4 -0
  40. package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +4 -0
  41. package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +20 -0
  42. package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +18 -0
  43. package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +21 -0
  44. package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +20 -0
  45. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +36 -0
  46. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +67 -0
  47. package/dist-types/commands/ListAssetModelsCommand.d.ts +29 -0
  48. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +18 -0
  49. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +15 -0
  50. package/dist-types/commands/ListAssetsCommand.d.ts +36 -0
  51. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +36 -0
  52. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +13 -0
  53. package/dist-types/commands/ListDashboardsCommand.d.ts +15 -0
  54. package/dist-types/commands/ListGatewaysCommand.d.ts +28 -0
  55. package/dist-types/commands/ListPortalsCommand.d.ts +24 -0
  56. package/dist-types/commands/ListProjectAssetsCommand.d.ts +9 -0
  57. package/dist-types/commands/ListProjectsCommand.d.ts +15 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  59. package/dist-types/commands/ListTimeSeriesCommand.d.ts +19 -0
  60. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +14 -0
  61. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +4 -0
  62. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +24 -0
  63. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  64. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  65. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +4 -0
  66. package/dist-types/commands/UpdateAssetCommand.d.ts +18 -0
  67. package/dist-types/commands/UpdateAssetModelCommand.d.ts +18 -0
  68. package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +4 -0
  69. package/dist-types/commands/UpdateDashboardCommand.d.ts +4 -0
  70. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +7 -0
  71. package/dist-types/commands/UpdateGatewayCommand.d.ts +4 -0
  72. package/dist-types/commands/UpdatePortalCommand.d.ts +12 -0
  73. package/dist-types/commands/UpdateProjectCommand.d.ts +4 -0
  74. package/package.json +16 -16
@@ -31,6 +31,28 @@ export interface DescribeGatewayCommandOutput extends DescribeGatewayResponse, _
31
31
  * };
32
32
  * const command = new DescribeGatewayCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeGatewayResponse
35
+ * // gatewayId: "STRING_VALUE", // required
36
+ * // gatewayName: "STRING_VALUE", // required
37
+ * // gatewayArn: "STRING_VALUE", // required
38
+ * // gatewayPlatform: { // GatewayPlatform
39
+ * // greengrass: { // Greengrass
40
+ * // groupArn: "STRING_VALUE", // required
41
+ * // },
42
+ * // greengrassV2: { // GreengrassV2
43
+ * // coreDeviceThingName: "STRING_VALUE", // required
44
+ * // },
45
+ * // },
46
+ * // gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries // required
47
+ * // { // GatewayCapabilitySummary
48
+ * // capabilityNamespace: "STRING_VALUE", // required
49
+ * // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
50
+ * // },
51
+ * // ],
52
+ * // creationDate: new Date("TIMESTAMP"), // required
53
+ * // lastUpdateDate: new Date("TIMESTAMP"), // required
54
+ * // };
55
+ *
34
56
  * ```
35
57
  *
36
58
  * @param DescribeGatewayCommandInput - {@link DescribeGatewayCommandInput}
@@ -55,6 +77,8 @@ export interface DescribeGatewayCommandOutput extends DescribeGatewayResponse, _
55
77
  * on.</p>
56
78
  * <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>
57
79
  *
80
+ * @throws {@link IoTSiteWiseServiceException}
81
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
58
82
  *
59
83
  */
60
84
  export declare class DescribeGatewayCommand extends $Command<DescribeGatewayCommandInput, DescribeGatewayCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -29,6 +29,12 @@ export interface DescribeLoggingOptionsCommandOutput extends DescribeLoggingOpti
29
29
  * const input = {};
30
30
  * const command = new DescribeLoggingOptionsCommand(input);
31
31
  * const response = await client.send(command);
32
+ * // { // DescribeLoggingOptionsResponse
33
+ * // loggingOptions: { // LoggingOptions
34
+ * // level: "ERROR" || "INFO" || "OFF", // required
35
+ * // },
36
+ * // };
37
+ *
32
38
  * ```
33
39
  *
34
40
  * @param DescribeLoggingOptionsCommandInput - {@link DescribeLoggingOptionsCommandInput}
@@ -53,6 +59,8 @@ export interface DescribeLoggingOptionsCommandOutput extends DescribeLoggingOpti
53
59
  * on.</p>
54
60
  * <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>
55
61
  *
62
+ * @throws {@link IoTSiteWiseServiceException}
63
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
56
64
  *
57
65
  */
58
66
  export declare class DescribeLoggingOptionsCommand extends $Command<DescribeLoggingOptionsCommandInput, DescribeLoggingOptionsCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -31,6 +31,36 @@ export interface DescribePortalCommandOutput extends DescribePortalResponse, __M
31
31
  * };
32
32
  * const command = new DescribePortalCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribePortalResponse
35
+ * // portalId: "STRING_VALUE", // required
36
+ * // portalArn: "STRING_VALUE", // required
37
+ * // portalName: "STRING_VALUE", // required
38
+ * // portalDescription: "STRING_VALUE",
39
+ * // portalClientId: "STRING_VALUE", // required
40
+ * // portalStartUrl: "STRING_VALUE", // required
41
+ * // portalContactEmail: "STRING_VALUE", // required
42
+ * // portalStatus: { // PortalStatus
43
+ * // state: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "FAILED", // required
44
+ * // error: { // MonitorErrorDetails
45
+ * // code: "INTERNAL_FAILURE" || "VALIDATION_ERROR" || "LIMIT_EXCEEDED",
46
+ * // message: "STRING_VALUE",
47
+ * // },
48
+ * // },
49
+ * // portalCreationDate: new Date("TIMESTAMP"), // required
50
+ * // portalLastUpdateDate: new Date("TIMESTAMP"), // required
51
+ * // portalLogoImageLocation: { // ImageLocation
52
+ * // id: "STRING_VALUE", // required
53
+ * // url: "STRING_VALUE", // required
54
+ * // },
55
+ * // roleArn: "STRING_VALUE",
56
+ * // portalAuthMode: "IAM" || "SSO",
57
+ * // notificationSenderEmail: "STRING_VALUE",
58
+ * // alarms: { // Alarms
59
+ * // alarmRoleArn: "STRING_VALUE", // required
60
+ * // notificationLambdaArn: "STRING_VALUE",
61
+ * // },
62
+ * // };
63
+ *
34
64
  * ```
35
65
  *
36
66
  * @param DescribePortalCommandInput - {@link DescribePortalCommandInput}
@@ -55,6 +85,8 @@ export interface DescribePortalCommandOutput extends DescribePortalResponse, __M
55
85
  * on.</p>
56
86
  * <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>
57
87
  *
88
+ * @throws {@link IoTSiteWiseServiceException}
89
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
58
90
  *
59
91
  */
60
92
  export declare class DescribePortalCommand extends $Command<DescribePortalCommandInput, DescribePortalCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -31,6 +31,16 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _
31
31
  * };
32
32
  * const command = new DescribeProjectCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeProjectResponse
35
+ * // projectId: "STRING_VALUE", // required
36
+ * // projectArn: "STRING_VALUE", // required
37
+ * // projectName: "STRING_VALUE", // required
38
+ * // portalId: "STRING_VALUE", // required
39
+ * // projectDescription: "STRING_VALUE",
40
+ * // projectCreationDate: new Date("TIMESTAMP"), // required
41
+ * // projectLastUpdateDate: new Date("TIMESTAMP"), // required
42
+ * // };
43
+ *
34
44
  * ```
35
45
  *
36
46
  * @param DescribeProjectCommandInput - {@link DescribeProjectCommandInput}
@@ -55,6 +65,8 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _
55
65
  * on.</p>
56
66
  * <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>
57
67
  *
68
+ * @throws {@link IoTSiteWiseServiceException}
69
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
58
70
  *
59
71
  */
60
72
  export declare class DescribeProjectCommand extends $Command<DescribeProjectCommandInput, DescribeProjectCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -29,6 +29,29 @@ export interface DescribeStorageConfigurationCommandOutput extends DescribeStora
29
29
  * const input = {};
30
30
  * const command = new DescribeStorageConfigurationCommand(input);
31
31
  * const response = await client.send(command);
32
+ * // { // DescribeStorageConfigurationResponse
33
+ * // storageType: "SITEWISE_DEFAULT_STORAGE" || "MULTI_LAYER_STORAGE", // required
34
+ * // multiLayerStorage: { // MultiLayerStorage
35
+ * // customerManagedS3Storage: { // CustomerManagedS3Storage
36
+ * // s3ResourceArn: "STRING_VALUE", // required
37
+ * // roleArn: "STRING_VALUE", // required
38
+ * // },
39
+ * // },
40
+ * // disassociatedDataStorage: "ENABLED" || "DISABLED",
41
+ * // retentionPeriod: { // RetentionPeriod
42
+ * // numberOfDays: Number("int"),
43
+ * // unlimited: true || false,
44
+ * // },
45
+ * // configurationStatus: { // ConfigurationStatus
46
+ * // state: "ACTIVE" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED", // required
47
+ * // error: { // ConfigurationErrorDetails
48
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
49
+ * // message: "STRING_VALUE", // required
50
+ * // },
51
+ * // },
52
+ * // lastUpdateDate: new Date("TIMESTAMP"),
53
+ * // };
54
+ *
32
55
  * ```
33
56
  *
34
57
  * @param DescribeStorageConfigurationCommandInput - {@link DescribeStorageConfigurationCommandInput}
@@ -63,6 +86,8 @@ export interface DescribeStorageConfigurationCommandOutput extends DescribeStora
63
86
  * on.</p>
64
87
  * <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>
65
88
  *
89
+ * @throws {@link IoTSiteWiseServiceException}
90
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
66
91
  *
67
92
  */
68
93
  export declare class DescribeStorageConfigurationCommand extends $Command<DescribeStorageConfigurationCommandInput, DescribeStorageConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -52,6 +52,18 @@ export interface DescribeTimeSeriesCommandOutput extends DescribeTimeSeriesRespo
52
52
  * };
53
53
  * const command = new DescribeTimeSeriesCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // DescribeTimeSeriesResponse
56
+ * // assetId: "STRING_VALUE",
57
+ * // propertyId: "STRING_VALUE",
58
+ * // alias: "STRING_VALUE",
59
+ * // timeSeriesId: "STRING_VALUE", // required
60
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
61
+ * // dataTypeSpec: "STRING_VALUE",
62
+ * // timeSeriesCreationDate: new Date("TIMESTAMP"), // required
63
+ * // timeSeriesLastUpdateDate: new Date("TIMESTAMP"), // required
64
+ * // timeSeriesArn: "STRING_VALUE", // required
65
+ * // };
66
+ *
55
67
  * ```
56
68
  *
57
69
  * @param DescribeTimeSeriesCommandInput - {@link DescribeTimeSeriesCommandInput}
@@ -76,6 +88,8 @@ export interface DescribeTimeSeriesCommandOutput extends DescribeTimeSeriesRespo
76
88
  * on.</p>
77
89
  * <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>
78
90
  *
91
+ * @throws {@link IoTSiteWiseServiceException}
92
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
79
93
  *
80
94
  */
81
95
  export declare class DescribeTimeSeriesCommand extends $Command<DescribeTimeSeriesCommandInput, DescribeTimeSeriesCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DisassociateAssetsCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new DisassociateAssetsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DisassociateAssetsCommandInput - {@link DisassociateAssetsCommandInput}
@@ -63,6 +65,8 @@ export interface DisassociateAssetsCommandOutput extends __MetadataBearer {
63
65
  * on.</p>
64
66
  * <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>
65
67
  *
68
+ * @throws {@link IoTSiteWiseServiceException}
69
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
66
70
  *
67
71
  */
68
72
  export declare class DisassociateAssetsCommand extends $Command<DisassociateAssetsCommandInput, DisassociateAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DisassociateTimeSeriesFromAssetPropertyCommandOutput extends __
34
34
  * };
35
35
  * const command = new DisassociateTimeSeriesFromAssetPropertyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DisassociateTimeSeriesFromAssetPropertyCommandInput - {@link DisassociateTimeSeriesFromAssetPropertyCommandInput}
@@ -62,6 +64,8 @@ export interface DisassociateTimeSeriesFromAssetPropertyCommandOutput extends __
62
64
  * on.</p>
63
65
  * <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>
64
66
  *
67
+ * @throws {@link IoTSiteWiseServiceException}
68
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
65
69
  *
66
70
  */
67
71
  export declare class DisassociateTimeSeriesFromAssetPropertyCommand extends $Command<DisassociateTimeSeriesFromAssetPropertyCommandInput, DisassociateTimeSeriesFromAssetPropertyCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -56,6 +56,24 @@ export interface GetAssetPropertyAggregatesCommandOutput extends GetAssetPropert
56
56
  * };
57
57
  * const command = new GetAssetPropertyAggregatesCommand(input);
58
58
  * const response = await client.send(command);
59
+ * // { // GetAssetPropertyAggregatesResponse
60
+ * // aggregatedValues: [ // AggregatedValues // required
61
+ * // { // AggregatedValue
62
+ * // timestamp: new Date("TIMESTAMP"), // required
63
+ * // quality: "GOOD" || "BAD" || "UNCERTAIN",
64
+ * // value: { // Aggregates
65
+ * // average: Number("double"),
66
+ * // count: Number("double"),
67
+ * // maximum: Number("double"),
68
+ * // minimum: Number("double"),
69
+ * // sum: Number("double"),
70
+ * // standardDeviation: Number("double"),
71
+ * // },
72
+ * // },
73
+ * // ],
74
+ * // nextToken: "STRING_VALUE",
75
+ * // };
76
+ *
59
77
  * ```
60
78
  *
61
79
  * @param GetAssetPropertyAggregatesCommandInput - {@link GetAssetPropertyAggregatesCommandInput}
@@ -83,6 +101,8 @@ export interface GetAssetPropertyAggregatesCommandOutput extends GetAssetPropert
83
101
  * on.</p>
84
102
  * <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>
85
103
  *
104
+ * @throws {@link IoTSiteWiseServiceException}
105
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
86
106
  *
87
107
  */
88
108
  export declare class GetAssetPropertyAggregatesCommand extends $Command<GetAssetPropertyAggregatesCommandInput, GetAssetPropertyAggregatesCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -44,6 +44,22 @@ export interface GetAssetPropertyValueCommandOutput extends GetAssetPropertyValu
44
44
  * };
45
45
  * const command = new GetAssetPropertyValueCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // GetAssetPropertyValueResponse
48
+ * // propertyValue: { // AssetPropertyValue
49
+ * // value: { // Variant
50
+ * // stringValue: "STRING_VALUE",
51
+ * // integerValue: Number("int"),
52
+ * // doubleValue: Number("double"),
53
+ * // booleanValue: true || false,
54
+ * // },
55
+ * // timestamp: { // TimeInNanos
56
+ * // timeInSeconds: Number("long"), // required
57
+ * // offsetInNanos: Number("int"),
58
+ * // },
59
+ * // quality: "GOOD" || "BAD" || "UNCERTAIN",
60
+ * // },
61
+ * // };
62
+ *
47
63
  * ```
48
64
  *
49
65
  * @param GetAssetPropertyValueCommandInput - {@link GetAssetPropertyValueCommandInput}
@@ -71,6 +87,8 @@ export interface GetAssetPropertyValueCommandOutput extends GetAssetPropertyValu
71
87
  * on.</p>
72
88
  * <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>
73
89
  *
90
+ * @throws {@link IoTSiteWiseServiceException}
91
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
74
92
  *
75
93
  */
76
94
  export declare class GetAssetPropertyValueCommand extends $Command<GetAssetPropertyValueCommandInput, GetAssetPropertyValueCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -52,6 +52,25 @@ export interface GetAssetPropertyValueHistoryCommandOutput extends GetAssetPrope
52
52
  * };
53
53
  * const command = new GetAssetPropertyValueHistoryCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // GetAssetPropertyValueHistoryResponse
56
+ * // assetPropertyValueHistory: [ // AssetPropertyValueHistory // required
57
+ * // { // AssetPropertyValue
58
+ * // value: { // Variant
59
+ * // stringValue: "STRING_VALUE",
60
+ * // integerValue: Number("int"),
61
+ * // doubleValue: Number("double"),
62
+ * // booleanValue: true || false,
63
+ * // },
64
+ * // timestamp: { // TimeInNanos
65
+ * // timeInSeconds: Number("long"), // required
66
+ * // offsetInNanos: Number("int"),
67
+ * // },
68
+ * // quality: "GOOD" || "BAD" || "UNCERTAIN",
69
+ * // },
70
+ * // ],
71
+ * // nextToken: "STRING_VALUE",
72
+ * // };
73
+ *
55
74
  * ```
56
75
  *
57
76
  * @param GetAssetPropertyValueHistoryCommandInput - {@link GetAssetPropertyValueHistoryCommandInput}
@@ -79,6 +98,8 @@ export interface GetAssetPropertyValueHistoryCommandOutput extends GetAssetPrope
79
98
  * on.</p>
80
99
  * <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>
81
100
  *
101
+ * @throws {@link IoTSiteWiseServiceException}
102
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
82
103
  *
83
104
  */
84
105
  export declare class GetAssetPropertyValueHistoryCommand extends $Command<GetAssetPropertyValueHistoryCommandInput, GetAssetPropertyValueHistoryCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -57,6 +57,24 @@ export interface GetInterpolatedAssetPropertyValuesCommandOutput extends GetInte
57
57
  * };
58
58
  * const command = new GetInterpolatedAssetPropertyValuesCommand(input);
59
59
  * const response = await client.send(command);
60
+ * // { // GetInterpolatedAssetPropertyValuesResponse
61
+ * // interpolatedAssetPropertyValues: [ // InterpolatedAssetPropertyValues // required
62
+ * // { // InterpolatedAssetPropertyValue
63
+ * // timestamp: { // TimeInNanos
64
+ * // timeInSeconds: Number("long"), // required
65
+ * // offsetInNanos: Number("int"),
66
+ * // },
67
+ * // value: { // Variant
68
+ * // stringValue: "STRING_VALUE",
69
+ * // integerValue: Number("int"),
70
+ * // doubleValue: Number("double"),
71
+ * // booleanValue: true || false,
72
+ * // },
73
+ * // },
74
+ * // ],
75
+ * // nextToken: "STRING_VALUE",
76
+ * // };
77
+ *
60
78
  * ```
61
79
  *
62
80
  * @param GetInterpolatedAssetPropertyValuesCommandInput - {@link GetInterpolatedAssetPropertyValuesCommandInput}
@@ -84,6 +102,8 @@ export interface GetInterpolatedAssetPropertyValuesCommandOutput extends GetInte
84
102
  * on.</p>
85
103
  * <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>
86
104
  *
105
+ * @throws {@link IoTSiteWiseServiceException}
106
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
87
107
  *
88
108
  */
89
109
  export declare class GetInterpolatedAssetPropertyValuesCommand extends $Command<GetInterpolatedAssetPropertyValuesCommandInput, GetInterpolatedAssetPropertyValuesCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -38,6 +38,40 @@ export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesRespo
38
38
  * };
39
39
  * const command = new ListAccessPoliciesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // ListAccessPoliciesResponse
42
+ * // accessPolicySummaries: [ // AccessPolicySummaries // required
43
+ * // { // AccessPolicySummary
44
+ * // id: "STRING_VALUE", // required
45
+ * // identity: { // Identity
46
+ * // user: { // UserIdentity
47
+ * // id: "STRING_VALUE", // required
48
+ * // },
49
+ * // group: { // GroupIdentity
50
+ * // id: "STRING_VALUE", // required
51
+ * // },
52
+ * // iamUser: { // IAMUserIdentity
53
+ * // arn: "STRING_VALUE", // required
54
+ * // },
55
+ * // iamRole: { // IAMRoleIdentity
56
+ * // arn: "STRING_VALUE", // required
57
+ * // },
58
+ * // },
59
+ * // resource: { // Resource
60
+ * // portal: { // PortalResource
61
+ * // id: "STRING_VALUE", // required
62
+ * // },
63
+ * // project: { // ProjectResource
64
+ * // id: "STRING_VALUE", // required
65
+ * // },
66
+ * // },
67
+ * // permission: "ADMINISTRATOR" || "VIEWER", // required
68
+ * // creationDate: new Date("TIMESTAMP"),
69
+ * // lastUpdateDate: new Date("TIMESTAMP"),
70
+ * // },
71
+ * // ],
72
+ * // nextToken: "STRING_VALUE",
73
+ * // };
74
+ *
41
75
  * ```
42
76
  *
43
77
  * @param ListAccessPoliciesCommandInput - {@link ListAccessPoliciesCommandInput}
@@ -59,6 +93,8 @@ export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesRespo
59
93
  * on.</p>
60
94
  * <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>
61
95
  *
96
+ * @throws {@link IoTSiteWiseServiceException}
97
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
62
98
  *
63
99
  */
64
100
  export declare class ListAccessPoliciesCommand extends $Command<ListAccessPoliciesCommandInput, ListAccessPoliciesCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -36,6 +36,71 @@ export interface ListAssetModelPropertiesCommandOutput extends ListAssetModelPro
36
36
  * };
37
37
  * const command = new ListAssetModelPropertiesCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListAssetModelPropertiesResponse
40
+ * // assetModelPropertySummaries: [ // AssetModelPropertySummaries // required
41
+ * // { // AssetModelPropertySummary
42
+ * // id: "STRING_VALUE",
43
+ * // name: "STRING_VALUE", // required
44
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
45
+ * // dataTypeSpec: "STRING_VALUE",
46
+ * // unit: "STRING_VALUE",
47
+ * // type: { // PropertyType
48
+ * // attribute: { // Attribute
49
+ * // defaultValue: "STRING_VALUE",
50
+ * // },
51
+ * // measurement: { // Measurement
52
+ * // processingConfig: { // MeasurementProcessingConfig
53
+ * // forwardingConfig: { // ForwardingConfig
54
+ * // state: "DISABLED" || "ENABLED", // required
55
+ * // },
56
+ * // },
57
+ * // },
58
+ * // transform: { // Transform
59
+ * // expression: "STRING_VALUE", // required
60
+ * // variables: [ // ExpressionVariables // required
61
+ * // { // ExpressionVariable
62
+ * // name: "STRING_VALUE", // required
63
+ * // value: { // VariableValue
64
+ * // propertyId: "STRING_VALUE", // required
65
+ * // hierarchyId: "STRING_VALUE",
66
+ * // },
67
+ * // },
68
+ * // ],
69
+ * // processingConfig: { // TransformProcessingConfig
70
+ * // computeLocation: "EDGE" || "CLOUD", // required
71
+ * // forwardingConfig: {
72
+ * // state: "DISABLED" || "ENABLED", // required
73
+ * // },
74
+ * // },
75
+ * // },
76
+ * // metric: { // Metric
77
+ * // expression: "STRING_VALUE", // required
78
+ * // variables: [ // required
79
+ * // {
80
+ * // name: "STRING_VALUE", // required
81
+ * // value: {
82
+ * // propertyId: "STRING_VALUE", // required
83
+ * // hierarchyId: "STRING_VALUE",
84
+ * // },
85
+ * // },
86
+ * // ],
87
+ * // window: { // MetricWindow
88
+ * // tumbling: { // TumblingWindow
89
+ * // interval: "STRING_VALUE", // required
90
+ * // offset: "STRING_VALUE",
91
+ * // },
92
+ * // },
93
+ * // processingConfig: { // MetricProcessingConfig
94
+ * // computeLocation: "EDGE" || "CLOUD", // required
95
+ * // },
96
+ * // },
97
+ * // },
98
+ * // assetModelCompositeModelId: "STRING_VALUE",
99
+ * // },
100
+ * // ],
101
+ * // nextToken: "STRING_VALUE",
102
+ * // };
103
+ *
39
104
  * ```
40
105
  *
41
106
  * @param ListAssetModelPropertiesCommandInput - {@link ListAssetModelPropertiesCommandInput}
@@ -60,6 +125,8 @@ export interface ListAssetModelPropertiesCommandOutput extends ListAssetModelPro
60
125
  * on.</p>
61
126
  * <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>
62
127
  *
128
+ * @throws {@link IoTSiteWiseServiceException}
129
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
63
130
  *
64
131
  */
65
132
  export declare class ListAssetModelPropertiesCommand extends $Command<ListAssetModelPropertiesCommandInput, ListAssetModelPropertiesCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -32,6 +32,33 @@ export interface ListAssetModelsCommandOutput extends ListAssetModelsResponse, _
32
32
  * };
33
33
  * const command = new ListAssetModelsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListAssetModelsResponse
36
+ * // assetModelSummaries: [ // AssetModelSummaries // required
37
+ * // { // AssetModelSummary
38
+ * // id: "STRING_VALUE", // required
39
+ * // arn: "STRING_VALUE", // required
40
+ * // name: "STRING_VALUE", // required
41
+ * // description: "STRING_VALUE", // required
42
+ * // creationDate: new Date("TIMESTAMP"), // required
43
+ * // lastUpdateDate: new Date("TIMESTAMP"), // required
44
+ * // status: { // AssetModelStatus
45
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "PROPAGATING" || "DELETING" || "FAILED", // required
46
+ * // error: { // ErrorDetails
47
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
48
+ * // message: "STRING_VALUE", // required
49
+ * // details: [ // DetailedErrors
50
+ * // { // DetailedError
51
+ * // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
52
+ * // message: "STRING_VALUE", // required
53
+ * // },
54
+ * // ],
55
+ * // },
56
+ * // },
57
+ * // },
58
+ * // ],
59
+ * // nextToken: "STRING_VALUE",
60
+ * // };
61
+ *
35
62
  * ```
36
63
  *
37
64
  * @param ListAssetModelsCommandInput - {@link ListAssetModelsCommandInput}
@@ -53,6 +80,8 @@ export interface ListAssetModelsCommandOutput extends ListAssetModelsResponse, _
53
80
  * on.</p>
54
81
  * <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>
55
82
  *
83
+ * @throws {@link IoTSiteWiseServiceException}
84
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
56
85
  *
57
86
  */
58
87
  export declare class ListAssetModelsCommand extends $Command<ListAssetModelsCommandInput, ListAssetModelsCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -36,6 +36,22 @@ export interface ListAssetPropertiesCommandOutput extends ListAssetPropertiesRes
36
36
  * };
37
37
  * const command = new ListAssetPropertiesCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListAssetPropertiesResponse
40
+ * // assetPropertySummaries: [ // AssetPropertySummaries // required
41
+ * // { // AssetPropertySummary
42
+ * // id: "STRING_VALUE",
43
+ * // alias: "STRING_VALUE",
44
+ * // unit: "STRING_VALUE",
45
+ * // notification: { // PropertyNotification
46
+ * // topic: "STRING_VALUE", // required
47
+ * // state: "ENABLED" || "DISABLED", // required
48
+ * // },
49
+ * // assetCompositeModelId: "STRING_VALUE",
50
+ * // },
51
+ * // ],
52
+ * // nextToken: "STRING_VALUE",
53
+ * // };
54
+ *
39
55
  * ```
40
56
  *
41
57
  * @param ListAssetPropertiesCommandInput - {@link ListAssetPropertiesCommandInput}
@@ -60,6 +76,8 @@ export interface ListAssetPropertiesCommandOutput extends ListAssetPropertiesRes
60
76
  * on.</p>
61
77
  * <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>
62
78
  *
79
+ * @throws {@link IoTSiteWiseServiceException}
80
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
63
81
  *
64
82
  */
65
83
  export declare class ListAssetPropertiesCommand extends $Command<ListAssetPropertiesCommandInput, ListAssetPropertiesCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -36,6 +36,19 @@ export interface ListAssetRelationshipsCommandOutput extends ListAssetRelationsh
36
36
  * };
37
37
  * const command = new ListAssetRelationshipsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ListAssetRelationshipsResponse
40
+ * // assetRelationshipSummaries: [ // AssetRelationshipSummaries // required
41
+ * // { // AssetRelationshipSummary
42
+ * // hierarchyInfo: { // AssetHierarchyInfo
43
+ * // parentAssetId: "STRING_VALUE",
44
+ * // childAssetId: "STRING_VALUE",
45
+ * // },
46
+ * // relationshipType: "HIERARCHY", // required
47
+ * // },
48
+ * // ],
49
+ * // nextToken: "STRING_VALUE",
50
+ * // };
51
+ *
39
52
  * ```
40
53
  *
41
54
  * @param ListAssetRelationshipsCommandInput - {@link ListAssetRelationshipsCommandInput}
@@ -60,6 +73,8 @@ export interface ListAssetRelationshipsCommandOutput extends ListAssetRelationsh
60
73
  * on.</p>
61
74
  * <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>
62
75
  *
76
+ * @throws {@link IoTSiteWiseServiceException}
77
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
63
78
  *
64
79
  */
65
80
  export declare class ListAssetRelationshipsCommand extends $Command<ListAssetRelationshipsCommandInput, ListAssetRelationshipsCommandOutput, IoTSiteWiseClientResolvedConfig> {