@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
package/dist-types/commands/DeletePortalCommand.d.ts CHANGED
@@ -32,6 +32,16 @@ export interface DeletePortalCommandOutput extends DeletePortalResponse, __Metad
32
32
  * };
33
33
  * const command = new DeletePortalCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeletePortalResponse
36
+ * // portalStatus: { // PortalStatus
37
+ * // state: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "FAILED", // required
38
+ * // error: { // MonitorErrorDetails
39
+ * // code: "INTERNAL_FAILURE" || "VALIDATION_ERROR" || "LIMIT_EXCEEDED",
40
+ * // message: "STRING_VALUE",
41
+ * // },
42
+ * // },
43
+ * // };
44
+ *
35
45
  * ```
36
46
  *
37
47
  * @param DeletePortalCommandInput - {@link DeletePortalCommandInput}
@@ -60,6 +70,8 @@ export interface DeletePortalCommandOutput extends DeletePortalResponse, __Metad
60
70
  * on.</p>
61
71
  * <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
72
  *
73
+ * @throws {@link IoTSiteWiseServiceException}
74
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
63
75
  *
64
76
  */
65
77
  export declare class DeletePortalCommand extends $Command<DeletePortalCommandInput, DeletePortalCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DeleteProjectCommand.d.ts CHANGED
@@ -32,6 +32,8 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
32
32
  * };
33
33
  * const command = new DeleteProjectCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteProjectCommandInput - {@link DeleteProjectCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
56
58
  * on.</p>
57
59
  * <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>
58
60
  *
61
+ * @throws {@link IoTSiteWiseServiceException}
62
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
59
63
  *
60
64
  */
61
65
  export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DeleteTimeSeriesCommand.d.ts CHANGED
@@ -55,6 +55,8 @@ export interface DeleteTimeSeriesCommandOutput extends __MetadataBearer {
55
55
  * };
56
56
  * const command = new DeleteTimeSeriesCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // {};
59
+ *
58
60
  * ```
59
61
  *
60
62
  * @param DeleteTimeSeriesCommandInput - {@link DeleteTimeSeriesCommandInput}
@@ -83,6 +85,8 @@ export interface DeleteTimeSeriesCommandOutput extends __MetadataBearer {
83
85
  * on.</p>
84
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>
85
87
  *
88
+ * @throws {@link IoTSiteWiseServiceException}
89
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
86
90
  *
87
91
  */
88
92
  export declare class DeleteTimeSeriesCommand extends $Command<DeleteTimeSeriesCommandInput, DeleteTimeSeriesCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeAccessPolicyCommand.d.ts CHANGED
@@ -32,6 +32,36 @@ export interface DescribeAccessPolicyCommandOutput extends DescribeAccessPolicyR
32
32
  * };
33
33
  * const command = new DescribeAccessPolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeAccessPolicyResponse
36
+ * // accessPolicyId: "STRING_VALUE", // required
37
+ * // accessPolicyArn: "STRING_VALUE", // required
38
+ * // accessPolicyIdentity: { // Identity
39
+ * // user: { // UserIdentity
40
+ * // id: "STRING_VALUE", // required
41
+ * // },
42
+ * // group: { // GroupIdentity
43
+ * // id: "STRING_VALUE", // required
44
+ * // },
45
+ * // iamUser: { // IAMUserIdentity
46
+ * // arn: "STRING_VALUE", // required
47
+ * // },
48
+ * // iamRole: { // IAMRoleIdentity
49
+ * // arn: "STRING_VALUE", // required
50
+ * // },
51
+ * // },
52
+ * // accessPolicyResource: { // Resource
53
+ * // portal: { // PortalResource
54
+ * // id: "STRING_VALUE", // required
55
+ * // },
56
+ * // project: { // ProjectResource
57
+ * // id: "STRING_VALUE", // required
58
+ * // },
59
+ * // },
60
+ * // accessPolicyPermission: "ADMINISTRATOR" || "VIEWER", // required
61
+ * // accessPolicyCreationDate: new Date("TIMESTAMP"), // required
62
+ * // accessPolicyLastUpdateDate: new Date("TIMESTAMP"), // required
63
+ * // };
64
+ *
35
65
  * ```
36
66
  *
37
67
  * @param DescribeAccessPolicyCommandInput - {@link DescribeAccessPolicyCommandInput}
@@ -56,6 +86,8 @@ export interface DescribeAccessPolicyCommandOutput extends DescribeAccessPolicyR
56
86
  * on.</p>
57
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>
58
88
  *
89
+ * @throws {@link IoTSiteWiseServiceException}
90
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
59
91
  *
60
92
  */
61
93
  export declare class DescribeAccessPolicyCommand extends $Command<DescribeAccessPolicyCommandInput, DescribeAccessPolicyCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeAssetCommand.d.ts CHANGED
@@ -32,6 +32,71 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
32
32
  * };
33
33
  * const command = new DescribeAssetCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeAssetResponse
36
+ * // assetId: "STRING_VALUE", // required
37
+ * // assetArn: "STRING_VALUE", // required
38
+ * // assetName: "STRING_VALUE", // required
39
+ * // assetModelId: "STRING_VALUE", // required
40
+ * // assetProperties: [ // AssetProperties // required
41
+ * // { // AssetProperty
42
+ * // id: "STRING_VALUE", // required
43
+ * // name: "STRING_VALUE", // required
44
+ * // alias: "STRING_VALUE",
45
+ * // notification: { // PropertyNotification
46
+ * // topic: "STRING_VALUE", // required
47
+ * // state: "ENABLED" || "DISABLED", // required
48
+ * // },
49
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
50
+ * // dataTypeSpec: "STRING_VALUE",
51
+ * // unit: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // assetHierarchies: [ // AssetHierarchies // required
55
+ * // { // AssetHierarchy
56
+ * // id: "STRING_VALUE",
57
+ * // name: "STRING_VALUE", // required
58
+ * // },
59
+ * // ],
60
+ * // assetCompositeModels: [ // AssetCompositeModels
61
+ * // { // AssetCompositeModel
62
+ * // name: "STRING_VALUE", // required
63
+ * // description: "STRING_VALUE",
64
+ * // type: "STRING_VALUE", // required
65
+ * // properties: [ // required
66
+ * // {
67
+ * // id: "STRING_VALUE", // required
68
+ * // name: "STRING_VALUE", // required
69
+ * // alias: "STRING_VALUE",
70
+ * // notification: {
71
+ * // topic: "STRING_VALUE", // required
72
+ * // state: "ENABLED" || "DISABLED", // required
73
+ * // },
74
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
75
+ * // dataTypeSpec: "STRING_VALUE",
76
+ * // unit: "STRING_VALUE",
77
+ * // },
78
+ * // ],
79
+ * // id: "STRING_VALUE",
80
+ * // },
81
+ * // ],
82
+ * // assetCreationDate: new Date("TIMESTAMP"), // required
83
+ * // assetLastUpdateDate: new Date("TIMESTAMP"), // required
84
+ * // assetStatus: { // AssetStatus
85
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
86
+ * // error: { // ErrorDetails
87
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
88
+ * // message: "STRING_VALUE", // required
89
+ * // details: [ // DetailedErrors
90
+ * // { // DetailedError
91
+ * // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
92
+ * // message: "STRING_VALUE", // required
93
+ * // },
94
+ * // ],
95
+ * // },
96
+ * // },
97
+ * // assetDescription: "STRING_VALUE",
98
+ * // };
99
+ *
35
100
  * ```
36
101
  *
37
102
  * @param DescribeAssetCommandInput - {@link DescribeAssetCommandInput}
@@ -56,6 +121,8 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
56
121
  * on.</p>
57
122
  * <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>
58
123
  *
124
+ * @throws {@link IoTSiteWiseServiceException}
125
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
59
126
  *
60
127
  */
61
128
  export declare class DescribeAssetCommand extends $Command<DescribeAssetCommandInput, DescribeAssetCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeAssetModelCommand.d.ts CHANGED
@@ -32,6 +32,163 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
32
32
  * };
33
33
  * const command = new DescribeAssetModelCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeAssetModelResponse
36
+ * // assetModelId: "STRING_VALUE", // required
37
+ * // assetModelArn: "STRING_VALUE", // required
38
+ * // assetModelName: "STRING_VALUE", // required
39
+ * // assetModelDescription: "STRING_VALUE", // required
40
+ * // assetModelProperties: [ // AssetModelProperties // required
41
+ * // { // AssetModelProperty
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
+ * // },
99
+ * // ],
100
+ * // assetModelHierarchies: [ // AssetModelHierarchies // required
101
+ * // { // AssetModelHierarchy
102
+ * // id: "STRING_VALUE",
103
+ * // name: "STRING_VALUE", // required
104
+ * // childAssetModelId: "STRING_VALUE", // required
105
+ * // },
106
+ * // ],
107
+ * // assetModelCompositeModels: [ // AssetModelCompositeModels
108
+ * // { // AssetModelCompositeModel
109
+ * // name: "STRING_VALUE", // required
110
+ * // description: "STRING_VALUE",
111
+ * // type: "STRING_VALUE", // required
112
+ * // properties: [
113
+ * // {
114
+ * // id: "STRING_VALUE",
115
+ * // name: "STRING_VALUE", // required
116
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
117
+ * // dataTypeSpec: "STRING_VALUE",
118
+ * // unit: "STRING_VALUE",
119
+ * // type: {
120
+ * // attribute: {
121
+ * // defaultValue: "STRING_VALUE",
122
+ * // },
123
+ * // measurement: {
124
+ * // processingConfig: {
125
+ * // forwardingConfig: {
126
+ * // state: "DISABLED" || "ENABLED", // required
127
+ * // },
128
+ * // },
129
+ * // },
130
+ * // transform: {
131
+ * // expression: "STRING_VALUE", // required
132
+ * // variables: [ // required
133
+ * // {
134
+ * // name: "STRING_VALUE", // required
135
+ * // value: {
136
+ * // propertyId: "STRING_VALUE", // required
137
+ * // hierarchyId: "STRING_VALUE",
138
+ * // },
139
+ * // },
140
+ * // ],
141
+ * // processingConfig: {
142
+ * // computeLocation: "EDGE" || "CLOUD", // required
143
+ * // forwardingConfig: {
144
+ * // state: "DISABLED" || "ENABLED", // required
145
+ * // },
146
+ * // },
147
+ * // },
148
+ * // metric: {
149
+ * // expression: "STRING_VALUE", // required
150
+ * // variables: [ // required
151
+ * // {
152
+ * // name: "STRING_VALUE", // required
153
+ * // value: {
154
+ * // propertyId: "STRING_VALUE", // required
155
+ * // hierarchyId: "STRING_VALUE",
156
+ * // },
157
+ * // },
158
+ * // ],
159
+ * // window: {
160
+ * // tumbling: {
161
+ * // interval: "STRING_VALUE", // required
162
+ * // offset: "STRING_VALUE",
163
+ * // },
164
+ * // },
165
+ * // processingConfig: {
166
+ * // computeLocation: "EDGE" || "CLOUD", // required
167
+ * // },
168
+ * // },
169
+ * // },
170
+ * // },
171
+ * // ],
172
+ * // id: "STRING_VALUE",
173
+ * // },
174
+ * // ],
175
+ * // assetModelCreationDate: new Date("TIMESTAMP"), // required
176
+ * // assetModelLastUpdateDate: new Date("TIMESTAMP"), // required
177
+ * // assetModelStatus: { // AssetModelStatus
178
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "PROPAGATING" || "DELETING" || "FAILED", // required
179
+ * // error: { // ErrorDetails
180
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
181
+ * // message: "STRING_VALUE", // required
182
+ * // details: [ // DetailedErrors
183
+ * // { // DetailedError
184
+ * // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
185
+ * // message: "STRING_VALUE", // required
186
+ * // },
187
+ * // ],
188
+ * // },
189
+ * // },
190
+ * // };
191
+ *
35
192
  * ```
36
193
  *
37
194
  * @param DescribeAssetModelCommandInput - {@link DescribeAssetModelCommandInput}
@@ -56,6 +213,8 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
56
213
  * on.</p>
57
214
  * <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>
58
215
  *
216
+ * @throws {@link IoTSiteWiseServiceException}
217
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
59
218
  *
60
219
  */
61
220
  export declare class DescribeAssetModelCommand extends $Command<DescribeAssetModelCommandInput, DescribeAssetModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeAssetPropertyCommand.d.ts CHANGED
@@ -39,6 +39,141 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
39
39
  * };
40
40
  * const command = new DescribeAssetPropertyCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // DescribeAssetPropertyResponse
43
+ * // assetId: "STRING_VALUE", // required
44
+ * // assetName: "STRING_VALUE", // required
45
+ * // assetModelId: "STRING_VALUE", // required
46
+ * // assetProperty: { // Property
47
+ * // id: "STRING_VALUE", // required
48
+ * // name: "STRING_VALUE", // required
49
+ * // alias: "STRING_VALUE",
50
+ * // notification: { // PropertyNotification
51
+ * // topic: "STRING_VALUE", // required
52
+ * // state: "ENABLED" || "DISABLED", // required
53
+ * // },
54
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
55
+ * // unit: "STRING_VALUE",
56
+ * // type: { // PropertyType
57
+ * // attribute: { // Attribute
58
+ * // defaultValue: "STRING_VALUE",
59
+ * // },
60
+ * // measurement: { // Measurement
61
+ * // processingConfig: { // MeasurementProcessingConfig
62
+ * // forwardingConfig: { // ForwardingConfig
63
+ * // state: "DISABLED" || "ENABLED", // required
64
+ * // },
65
+ * // },
66
+ * // },
67
+ * // transform: { // Transform
68
+ * // expression: "STRING_VALUE", // required
69
+ * // variables: [ // ExpressionVariables // required
70
+ * // { // ExpressionVariable
71
+ * // name: "STRING_VALUE", // required
72
+ * // value: { // VariableValue
73
+ * // propertyId: "STRING_VALUE", // required
74
+ * // hierarchyId: "STRING_VALUE",
75
+ * // },
76
+ * // },
77
+ * // ],
78
+ * // processingConfig: { // TransformProcessingConfig
79
+ * // computeLocation: "EDGE" || "CLOUD", // required
80
+ * // forwardingConfig: {
81
+ * // state: "DISABLED" || "ENABLED", // required
82
+ * // },
83
+ * // },
84
+ * // },
85
+ * // metric: { // Metric
86
+ * // expression: "STRING_VALUE", // required
87
+ * // variables: [ // required
88
+ * // {
89
+ * // name: "STRING_VALUE", // required
90
+ * // value: {
91
+ * // propertyId: "STRING_VALUE", // required
92
+ * // hierarchyId: "STRING_VALUE",
93
+ * // },
94
+ * // },
95
+ * // ],
96
+ * // window: { // MetricWindow
97
+ * // tumbling: { // TumblingWindow
98
+ * // interval: "STRING_VALUE", // required
99
+ * // offset: "STRING_VALUE",
100
+ * // },
101
+ * // },
102
+ * // processingConfig: { // MetricProcessingConfig
103
+ * // computeLocation: "EDGE" || "CLOUD", // required
104
+ * // },
105
+ * // },
106
+ * // },
107
+ * // },
108
+ * // compositeModel: { // CompositeModelProperty
109
+ * // name: "STRING_VALUE", // required
110
+ * // type: "STRING_VALUE", // required
111
+ * // assetProperty: {
112
+ * // id: "STRING_VALUE", // required
113
+ * // name: "STRING_VALUE", // required
114
+ * // alias: "STRING_VALUE",
115
+ * // notification: {
116
+ * // topic: "STRING_VALUE", // required
117
+ * // state: "ENABLED" || "DISABLED", // required
118
+ * // },
119
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
120
+ * // unit: "STRING_VALUE",
121
+ * // type: {
122
+ * // attribute: {
123
+ * // defaultValue: "STRING_VALUE",
124
+ * // },
125
+ * // measurement: {
126
+ * // processingConfig: {
127
+ * // forwardingConfig: {
128
+ * // state: "DISABLED" || "ENABLED", // required
129
+ * // },
130
+ * // },
131
+ * // },
132
+ * // transform: {
133
+ * // expression: "STRING_VALUE", // required
134
+ * // variables: [ // required
135
+ * // {
136
+ * // name: "STRING_VALUE", // required
137
+ * // value: {
138
+ * // propertyId: "STRING_VALUE", // required
139
+ * // hierarchyId: "STRING_VALUE",
140
+ * // },
141
+ * // },
142
+ * // ],
143
+ * // processingConfig: {
144
+ * // computeLocation: "EDGE" || "CLOUD", // required
145
+ * // forwardingConfig: {
146
+ * // state: "DISABLED" || "ENABLED", // required
147
+ * // },
148
+ * // },
149
+ * // },
150
+ * // metric: {
151
+ * // expression: "STRING_VALUE", // required
152
+ * // variables: [ // required
153
+ * // {
154
+ * // name: "STRING_VALUE", // required
155
+ * // value: {
156
+ * // propertyId: "STRING_VALUE", // required
157
+ * // hierarchyId: "STRING_VALUE",
158
+ * // },
159
+ * // },
160
+ * // ],
161
+ * // window: {
162
+ * // tumbling: {
163
+ * // interval: "STRING_VALUE", // required
164
+ * // offset: "STRING_VALUE",
165
+ * // },
166
+ * // },
167
+ * // processingConfig: {
168
+ * // computeLocation: "EDGE" || "CLOUD", // required
169
+ * // },
170
+ * // },
171
+ * // },
172
+ * // },
173
+ * // id: "STRING_VALUE",
174
+ * // },
175
+ * // };
176
+ *
42
177
  * ```
43
178
  *
44
179
  * @param DescribeAssetPropertyCommandInput - {@link DescribeAssetPropertyCommandInput}
@@ -63,6 +198,8 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
63
198
  * on.</p>
64
199
  * <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
200
  *
201
+ * @throws {@link IoTSiteWiseServiceException}
202
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
66
203
  *
67
204
  */
68
205
  export declare class DescribeAssetPropertyCommand extends $Command<DescribeAssetPropertyCommandInput, DescribeAssetPropertyCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeBulkImportJobCommand.d.ts CHANGED
@@ -32,6 +32,35 @@ export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJo
32
32
  * };
33
33
  * const command = new DescribeBulkImportJobCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeBulkImportJobResponse
36
+ * // jobId: "STRING_VALUE", // required
37
+ * // jobName: "STRING_VALUE", // required
38
+ * // jobStatus: "PENDING" || "CANCELLED" || "RUNNING" || "COMPLETED" || "FAILED" || "COMPLETED_WITH_FAILURES", // required
39
+ * // jobRoleArn: "STRING_VALUE", // required
40
+ * // files: [ // Files // required
41
+ * // { // File
42
+ * // bucket: "STRING_VALUE", // required
43
+ * // key: "STRING_VALUE", // required
44
+ * // versionId: "STRING_VALUE",
45
+ * // },
46
+ * // ],
47
+ * // errorReportLocation: { // ErrorReportLocation
48
+ * // bucket: "STRING_VALUE", // required
49
+ * // prefix: "STRING_VALUE", // required
50
+ * // },
51
+ * // jobConfiguration: { // JobConfiguration
52
+ * // fileFormat: { // FileFormat
53
+ * // csv: { // Csv
54
+ * // columnNames: [ // ColumnNames
55
+ * // "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
56
+ * // ],
57
+ * // },
58
+ * // },
59
+ * // },
60
+ * // jobCreationDate: new Date("TIMESTAMP"), // required
61
+ * // jobLastUpdateDate: new Date("TIMESTAMP"), // required
62
+ * // };
63
+ *
35
64
  * ```
36
65
  *
37
66
  * @param DescribeBulkImportJobCommandInput - {@link DescribeBulkImportJobCommandInput}
@@ -56,6 +85,8 @@ export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJo
56
85
  * on.</p>
57
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>
58
87
  *
88
+ * @throws {@link IoTSiteWiseServiceException}
89
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
59
90
  *
60
91
  */
61
92
  export declare class DescribeBulkImportJobCommand extends $Command<DescribeBulkImportJobCommandInput, DescribeBulkImportJobCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeDashboardCommand.d.ts CHANGED
@@ -31,6 +31,17 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons
31
31
  * };
32
32
  * const command = new DescribeDashboardCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeDashboardResponse
35
+ * // dashboardId: "STRING_VALUE", // required
36
+ * // dashboardArn: "STRING_VALUE", // required
37
+ * // dashboardName: "STRING_VALUE", // required
38
+ * // projectId: "STRING_VALUE", // required
39
+ * // dashboardDescription: "STRING_VALUE",
40
+ * // dashboardDefinition: "STRING_VALUE", // required
41
+ * // dashboardCreationDate: new Date("TIMESTAMP"), // required
42
+ * // dashboardLastUpdateDate: new Date("TIMESTAMP"), // required
43
+ * // };
44
+ *
34
45
  * ```
35
46
  *
36
47
  * @param DescribeDashboardCommandInput - {@link DescribeDashboardCommandInput}
@@ -55,6 +66,8 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons
55
66
  * on.</p>
56
67
  * <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
68
  *
69
+ * @throws {@link IoTSiteWiseServiceException}
70
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
58
71
  *
59
72
  */
60
73
  export declare class DescribeDashboardCommand extends $Command<DescribeDashboardCommandInput, DescribeDashboardCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts CHANGED
@@ -31,6 +31,18 @@ export interface DescribeDefaultEncryptionConfigurationCommandOutput extends Des
31
31
  * const input = {};
32
32
  * const command = new DescribeDefaultEncryptionConfigurationCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DescribeDefaultEncryptionConfigurationResponse
35
+ * // encryptionType: "SITEWISE_DEFAULT_ENCRYPTION" || "KMS_BASED_ENCRYPTION", // required
36
+ * // kmsKeyArn: "STRING_VALUE",
37
+ * // configurationStatus: { // ConfigurationStatus
38
+ * // state: "ACTIVE" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED", // required
39
+ * // error: { // ConfigurationErrorDetails
40
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
41
+ * // message: "STRING_VALUE", // required
42
+ * // },
43
+ * // },
44
+ * // };
45
+ *
34
46
  * ```
35
47
  *
36
48
  * @param DescribeDefaultEncryptionConfigurationCommandInput - {@link DescribeDefaultEncryptionConfigurationCommandInput}
@@ -52,6 +64,8 @@ export interface DescribeDefaultEncryptionConfigurationCommandOutput extends Des
52
64
  * on.</p>
53
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>
54
66
  *
67
+ * @throws {@link IoTSiteWiseServiceException}
68
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
55
69
  *
56
70
  */
57
71
  export declare class DescribeDefaultEncryptionConfigurationCommand extends $Command<DescribeDefaultEncryptionConfigurationCommandInput, DescribeDefaultEncryptionConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {
package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts CHANGED
@@ -36,6 +36,13 @@ export interface DescribeGatewayCapabilityConfigurationCommandOutput extends Des
36
36
  * };
37
37
  * const command = new DescribeGatewayCapabilityConfigurationCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeGatewayCapabilityConfigurationResponse
40
+ * // gatewayId: "STRING_VALUE", // required
41
+ * // capabilityNamespace: "STRING_VALUE", // required
42
+ * // capabilityConfiguration: "STRING_VALUE", // required
43
+ * // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
44
+ * // };
45
+ *
39
46
  * ```
40
47
  *
41
48
  * @param DescribeGatewayCapabilityConfigurationCommandInput - {@link DescribeGatewayCapabilityConfigurationCommandInput}
@@ -60,6 +67,8 @@ export interface DescribeGatewayCapabilityConfigurationCommandOutput extends Des
60
67
  * on.</p>
61
68
  * <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
69
  *
70
+ * @throws {@link IoTSiteWiseServiceException}
71
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
63
72
  *
64
73
  */
65
74
  export declare class DescribeGatewayCapabilityConfigurationCommand extends $Command<DescribeGatewayCapabilityConfigurationCommandInput, DescribeGatewayCapabilityConfigurationCommandOutput, IoTSiteWiseClientResolvedConfig> {