@aws-sdk/client-iotsitewise 3.325.0 → 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 +3 -3
@@ -36,6 +36,8 @@ export interface AssociateAssetsCommandOutput extends __MetadataBearer {
36
36
  * };
37
37
  * const command = new AssociateAssetsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param AssociateAssetsCommandInput - {@link AssociateAssetsCommandInput}
@@ -73,6 +75,8 @@ export interface AssociateAssetsCommandOutput extends __MetadataBearer {
73
75
  * on.</p>
74
76
  * <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>
75
77
  *
78
+ * @throws {@link IoTSiteWiseServiceException}
79
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
76
80
  *
77
81
  */
78
82
  export declare class AssociateAssetsCommand extends $Command<AssociateAssetsCommandInput, AssociateAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface AssociateTimeSeriesToAssetPropertyCommandOutput extends __Metad
34
34
  * };
35
35
  * const command = new AssociateTimeSeriesToAssetPropertyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param AssociateTimeSeriesToAssetPropertyCommandInput - {@link AssociateTimeSeriesToAssetPropertyCommandInput}
@@ -62,6 +64,8 @@ export interface AssociateTimeSeriesToAssetPropertyCommandOutput extends __Metad
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 AssociateTimeSeriesToAssetPropertyCommand extends $Command<AssociateTimeSeriesToAssetPropertyCommandInput, AssociateTimeSeriesToAssetPropertyCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -35,6 +35,16 @@ export interface BatchAssociateProjectAssetsCommandOutput extends BatchAssociate
35
35
  * };
36
36
  * const command = new BatchAssociateProjectAssetsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // BatchAssociateProjectAssetsResponse
39
+ * // errors: [ // BatchAssociateProjectAssetsErrors
40
+ * // { // AssetErrorDetails
41
+ * // assetId: "STRING_VALUE", // required
42
+ * // code: "INTERNAL_FAILURE", // required
43
+ * // message: "STRING_VALUE", // required
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
38
48
  * ```
39
49
  *
40
50
  * @param BatchAssociateProjectAssetsCommandInput - {@link BatchAssociateProjectAssetsCommandInput}
@@ -65,6 +75,8 @@ export interface BatchAssociateProjectAssetsCommandOutput extends BatchAssociate
65
75
  * on.</p>
66
76
  * <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>
67
77
  *
78
+ * @throws {@link IoTSiteWiseServiceException}
79
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
68
80
  *
69
81
  */
70
82
  export declare class BatchAssociateProjectAssetsCommand extends $Command<BatchAssociateProjectAssetsCommandInput, BatchAssociateProjectAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -35,6 +35,16 @@ export interface BatchDisassociateProjectAssetsCommandOutput extends BatchDisass
35
35
  * };
36
36
  * const command = new BatchDisassociateProjectAssetsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // BatchDisassociateProjectAssetsResponse
39
+ * // errors: [ // BatchDisassociateProjectAssetsErrors
40
+ * // { // AssetErrorDetails
41
+ * // assetId: "STRING_VALUE", // required
42
+ * // code: "INTERNAL_FAILURE", // required
43
+ * // message: "STRING_VALUE", // required
44
+ * // },
45
+ * // ],
46
+ * // };
47
+ *
38
48
  * ```
39
49
  *
40
50
  * @param BatchDisassociateProjectAssetsCommandInput - {@link BatchDisassociateProjectAssetsCommandInput}
@@ -59,6 +69,8 @@ export interface BatchDisassociateProjectAssetsCommandOutput extends BatchDisass
59
69
  * on.</p>
60
70
  * <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
71
  *
72
+ * @throws {@link IoTSiteWiseServiceException}
73
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
62
74
  *
63
75
  */
64
76
  export declare class BatchDisassociateProjectAssetsCommand extends $Command<BatchDisassociateProjectAssetsCommandInput, BatchDisassociateProjectAssetsCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -52,6 +52,46 @@ export interface BatchGetAssetPropertyAggregatesCommandOutput extends BatchGetAs
52
52
  * };
53
53
  * const command = new BatchGetAssetPropertyAggregatesCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // BatchGetAssetPropertyAggregatesResponse
56
+ * // errorEntries: [ // BatchGetAssetPropertyAggregatesErrorEntries // required
57
+ * // { // BatchGetAssetPropertyAggregatesErrorEntry
58
+ * // errorCode: "ResourceNotFoundException" || "InvalidRequestException" || "AccessDeniedException", // required
59
+ * // errorMessage: "STRING_VALUE", // required
60
+ * // entryId: "STRING_VALUE", // required
61
+ * // },
62
+ * // ],
63
+ * // successEntries: [ // BatchGetAssetPropertyAggregatesSuccessEntries // required
64
+ * // { // BatchGetAssetPropertyAggregatesSuccessEntry
65
+ * // entryId: "STRING_VALUE", // required
66
+ * // aggregatedValues: [ // AggregatedValues // required
67
+ * // { // AggregatedValue
68
+ * // timestamp: new Date("TIMESTAMP"), // required
69
+ * // quality: "GOOD" || "BAD" || "UNCERTAIN",
70
+ * // value: { // Aggregates
71
+ * // average: Number("double"),
72
+ * // count: Number("double"),
73
+ * // maximum: Number("double"),
74
+ * // minimum: Number("double"),
75
+ * // sum: Number("double"),
76
+ * // standardDeviation: Number("double"),
77
+ * // },
78
+ * // },
79
+ * // ],
80
+ * // },
81
+ * // ],
82
+ * // skippedEntries: [ // BatchGetAssetPropertyAggregatesSkippedEntries // required
83
+ * // { // BatchGetAssetPropertyAggregatesSkippedEntry
84
+ * // entryId: "STRING_VALUE", // required
85
+ * // completionStatus: "SUCCESS" || "ERROR", // required
86
+ * // errorInfo: { // BatchGetAssetPropertyAggregatesErrorInfo
87
+ * // errorCode: "ResourceNotFoundException" || "InvalidRequestException" || "AccessDeniedException", // required
88
+ * // errorTimestamp: new Date("TIMESTAMP"), // required
89
+ * // },
90
+ * // },
91
+ * // ],
92
+ * // nextToken: "STRING_VALUE",
93
+ * // };
94
+ *
55
95
  * ```
56
96
  *
57
97
  * @param BatchGetAssetPropertyAggregatesCommandInput - {@link BatchGetAssetPropertyAggregatesCommandInput}
@@ -76,6 +116,8 @@ export interface BatchGetAssetPropertyAggregatesCommandOutput extends BatchGetAs
76
116
  * on.</p>
77
117
  * <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
118
  *
119
+ * @throws {@link IoTSiteWiseServiceException}
120
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
79
121
  *
80
122
  */
81
123
  export declare class BatchGetAssetPropertyAggregatesCommand extends $Command<BatchGetAssetPropertyAggregatesCommandInput, BatchGetAssetPropertyAggregatesCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -40,6 +40,45 @@ export interface BatchGetAssetPropertyValueCommandOutput extends BatchGetAssetPr
40
40
  * };
41
41
  * const command = new BatchGetAssetPropertyValueCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // BatchGetAssetPropertyValueResponse
44
+ * // errorEntries: [ // BatchGetAssetPropertyValueErrorEntries // required
45
+ * // { // BatchGetAssetPropertyValueErrorEntry
46
+ * // errorCode: "ResourceNotFoundException" || "InvalidRequestException" || "AccessDeniedException", // required
47
+ * // errorMessage: "STRING_VALUE", // required
48
+ * // entryId: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // successEntries: [ // BatchGetAssetPropertyValueSuccessEntries // required
52
+ * // { // BatchGetAssetPropertyValueSuccessEntry
53
+ * // entryId: "STRING_VALUE", // required
54
+ * // assetPropertyValue: { // AssetPropertyValue
55
+ * // value: { // Variant
56
+ * // stringValue: "STRING_VALUE",
57
+ * // integerValue: Number("int"),
58
+ * // doubleValue: Number("double"),
59
+ * // booleanValue: true || false,
60
+ * // },
61
+ * // timestamp: { // TimeInNanos
62
+ * // timeInSeconds: Number("long"), // required
63
+ * // offsetInNanos: Number("int"),
64
+ * // },
65
+ * // quality: "GOOD" || "BAD" || "UNCERTAIN",
66
+ * // },
67
+ * // },
68
+ * // ],
69
+ * // skippedEntries: [ // BatchGetAssetPropertyValueSkippedEntries // required
70
+ * // { // BatchGetAssetPropertyValueSkippedEntry
71
+ * // entryId: "STRING_VALUE", // required
72
+ * // completionStatus: "SUCCESS" || "ERROR", // required
73
+ * // errorInfo: { // BatchGetAssetPropertyValueErrorInfo
74
+ * // errorCode: "ResourceNotFoundException" || "InvalidRequestException" || "AccessDeniedException", // required
75
+ * // errorTimestamp: new Date("TIMESTAMP"), // required
76
+ * // },
77
+ * // },
78
+ * // ],
79
+ * // nextToken: "STRING_VALUE",
80
+ * // };
81
+ *
43
82
  * ```
44
83
  *
45
84
  * @param BatchGetAssetPropertyValueCommandInput - {@link BatchGetAssetPropertyValueCommandInput}
@@ -64,6 +103,8 @@ export interface BatchGetAssetPropertyValueCommandOutput extends BatchGetAssetPr
64
103
  * on.</p>
65
104
  * <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>
66
105
  *
106
+ * @throws {@link IoTSiteWiseServiceException}
107
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
67
108
  *
68
109
  */
69
110
  export declare class BatchGetAssetPropertyValueCommand extends $Command<BatchGetAssetPropertyValueCommandInput, BatchGetAssetPropertyValueCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -47,6 +47,47 @@ export interface BatchGetAssetPropertyValueHistoryCommandOutput extends BatchGet
47
47
  * };
48
48
  * const command = new BatchGetAssetPropertyValueHistoryCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // BatchGetAssetPropertyValueHistoryResponse
51
+ * // errorEntries: [ // BatchGetAssetPropertyValueHistoryErrorEntries // required
52
+ * // { // BatchGetAssetPropertyValueHistoryErrorEntry
53
+ * // errorCode: "ResourceNotFoundException" || "InvalidRequestException" || "AccessDeniedException", // required
54
+ * // errorMessage: "STRING_VALUE", // required
55
+ * // entryId: "STRING_VALUE", // required
56
+ * // },
57
+ * // ],
58
+ * // successEntries: [ // BatchGetAssetPropertyValueHistorySuccessEntries // required
59
+ * // { // BatchGetAssetPropertyValueHistorySuccessEntry
60
+ * // entryId: "STRING_VALUE", // required
61
+ * // assetPropertyValueHistory: [ // AssetPropertyValueHistory // required
62
+ * // { // AssetPropertyValue
63
+ * // value: { // Variant
64
+ * // stringValue: "STRING_VALUE",
65
+ * // integerValue: Number("int"),
66
+ * // doubleValue: Number("double"),
67
+ * // booleanValue: true || false,
68
+ * // },
69
+ * // timestamp: { // TimeInNanos
70
+ * // timeInSeconds: Number("long"), // required
71
+ * // offsetInNanos: Number("int"),
72
+ * // },
73
+ * // quality: "GOOD" || "BAD" || "UNCERTAIN",
74
+ * // },
75
+ * // ],
76
+ * // },
77
+ * // ],
78
+ * // skippedEntries: [ // BatchGetAssetPropertyValueHistorySkippedEntries // required
79
+ * // { // BatchGetAssetPropertyValueHistorySkippedEntry
80
+ * // entryId: "STRING_VALUE", // required
81
+ * // completionStatus: "SUCCESS" || "ERROR", // required
82
+ * // errorInfo: { // BatchGetAssetPropertyValueHistoryErrorInfo
83
+ * // errorCode: "ResourceNotFoundException" || "InvalidRequestException" || "AccessDeniedException", // required
84
+ * // errorTimestamp: new Date("TIMESTAMP"), // required
85
+ * // },
86
+ * // },
87
+ * // ],
88
+ * // nextToken: "STRING_VALUE",
89
+ * // };
90
+ *
50
91
  * ```
51
92
  *
52
93
  * @param BatchGetAssetPropertyValueHistoryCommandInput - {@link BatchGetAssetPropertyValueHistoryCommandInput}
@@ -71,6 +112,8 @@ export interface BatchGetAssetPropertyValueHistoryCommandOutput extends BatchGet
71
112
  * on.</p>
72
113
  * <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
114
  *
115
+ * @throws {@link IoTSiteWiseServiceException}
116
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
74
117
  *
75
118
  */
76
119
  export declare class BatchGetAssetPropertyValueHistoryCommand extends $Command<BatchGetAssetPropertyValueHistoryCommandInput, BatchGetAssetPropertyValueHistoryCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -77,6 +77,26 @@ export interface BatchPutAssetPropertyValueCommandOutput extends BatchPutAssetPr
77
77
  * };
78
78
  * const command = new BatchPutAssetPropertyValueCommand(input);
79
79
  * const response = await client.send(command);
80
+ * // { // BatchPutAssetPropertyValueResponse
81
+ * // errorEntries: [ // BatchPutAssetPropertyErrorEntries // required
82
+ * // { // BatchPutAssetPropertyErrorEntry
83
+ * // entryId: "STRING_VALUE", // required
84
+ * // errors: [ // BatchPutAssetPropertyErrors // required
85
+ * // { // BatchPutAssetPropertyError
86
+ * // errorCode: "ResourceNotFoundException" || "InvalidRequestException" || "InternalFailureException" || "ServiceUnavailableException" || "ThrottlingException" || "LimitExceededException" || "ConflictingOperationException" || "TimestampOutOfRangeException" || "AccessDeniedException", // required
87
+ * // errorMessage: "STRING_VALUE", // required
88
+ * // timestamps: [ // Timestamps // required
89
+ * // { // TimeInNanos
90
+ * // timeInSeconds: Number("long"), // required
91
+ * // offsetInNanos: Number("int"),
92
+ * // },
93
+ * // ],
94
+ * // },
95
+ * // ],
96
+ * // },
97
+ * // ],
98
+ * // };
99
+ *
80
100
  * ```
81
101
  *
82
102
  * @param BatchPutAssetPropertyValueCommandInput - {@link BatchPutAssetPropertyValueCommandInput}
@@ -114,6 +134,8 @@ export interface BatchPutAssetPropertyValueCommandOutput extends BatchPutAssetPr
114
134
  * on.</p>
115
135
  * <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>
116
136
  *
137
+ * @throws {@link IoTSiteWiseServiceException}
138
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
117
139
  *
118
140
  */
119
141
  export declare class BatchPutAssetPropertyValueCommand extends $Command<BatchPutAssetPropertyValueCommandInput, BatchPutAssetPropertyValueCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -58,6 +58,11 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo
58
58
  * };
59
59
  * const command = new CreateAccessPolicyCommand(input);
60
60
  * const response = await client.send(command);
61
+ * // { // CreateAccessPolicyResponse
62
+ * // accessPolicyId: "STRING_VALUE", // required
63
+ * // accessPolicyArn: "STRING_VALUE", // required
64
+ * // };
65
+ *
61
66
  * ```
62
67
  *
63
68
  * @param CreateAccessPolicyCommandInput - {@link CreateAccessPolicyCommandInput}
@@ -88,6 +93,8 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo
88
93
  * on.</p>
89
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>
90
95
  *
96
+ * @throws {@link IoTSiteWiseServiceException}
97
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
91
98
  *
92
99
  */
93
100
  export declare class CreateAccessPolicyCommand extends $Command<CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -38,6 +38,24 @@ export interface CreateAssetCommandOutput extends CreateAssetResponse, __Metadat
38
38
  * };
39
39
  * const command = new CreateAssetCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // CreateAssetResponse
42
+ * // assetId: "STRING_VALUE", // required
43
+ * // assetArn: "STRING_VALUE", // required
44
+ * // assetStatus: { // AssetStatus
45
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "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
+ *
41
59
  * ```
42
60
  *
43
61
  * @param CreateAssetCommandInput - {@link CreateAssetCommandInput}
@@ -75,6 +93,8 @@ export interface CreateAssetCommandOutput extends CreateAssetResponse, __Metadat
75
93
  * on.</p>
76
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>
77
95
  *
96
+ * @throws {@link IoTSiteWiseServiceException}
97
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
78
98
  *
79
99
  */
80
100
  export declare class CreateAssetCommand extends $Command<CreateAssetCommandInput, CreateAssetCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -171,6 +171,24 @@ export interface CreateAssetModelCommandOutput extends CreateAssetModelResponse,
171
171
  * };
172
172
  * const command = new CreateAssetModelCommand(input);
173
173
  * const response = await client.send(command);
174
+ * // { // CreateAssetModelResponse
175
+ * // assetModelId: "STRING_VALUE", // required
176
+ * // assetModelArn: "STRING_VALUE", // 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
+ *
174
192
  * ```
175
193
  *
176
194
  * @param CreateAssetModelCommandInput - {@link CreateAssetModelCommandInput}
@@ -208,6 +226,8 @@ export interface CreateAssetModelCommandOutput extends CreateAssetModelResponse,
208
226
  * on.</p>
209
227
  * <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>
210
228
  *
229
+ * @throws {@link IoTSiteWiseServiceException}
230
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
211
231
  *
212
232
  */
213
233
  export declare class CreateAssetModelCommand extends $Command<CreateAssetModelCommandInput, CreateAssetModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -57,6 +57,12 @@ export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobRes
57
57
  * };
58
58
  * const command = new CreateBulkImportJobCommand(input);
59
59
  * const response = await client.send(command);
60
+ * // { // CreateBulkImportJobResponse
61
+ * // jobId: "STRING_VALUE", // required
62
+ * // jobName: "STRING_VALUE", // required
63
+ * // jobStatus: "PENDING" || "CANCELLED" || "RUNNING" || "COMPLETED" || "FAILED" || "COMPLETED_WITH_FAILURES", // required
64
+ * // };
65
+ *
60
66
  * ```
61
67
  *
62
68
  * @param CreateBulkImportJobCommandInput - {@link CreateBulkImportJobCommandInput}
@@ -94,6 +100,8 @@ export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobRes
94
100
  * on.</p>
95
101
  * <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>
96
102
  *
103
+ * @throws {@link IoTSiteWiseServiceException}
104
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
97
105
  *
98
106
  */
99
107
  export declare class CreateBulkImportJobCommand extends $Command<CreateBulkImportJobCommandInput, CreateBulkImportJobCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -38,6 +38,11 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
38
38
  * };
39
39
  * const command = new CreateDashboardCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // CreateDashboardResponse
42
+ * // dashboardId: "STRING_VALUE", // required
43
+ * // dashboardArn: "STRING_VALUE", // required
44
+ * // };
45
+ *
41
46
  * ```
42
47
  *
43
48
  * @param CreateDashboardCommandInput - {@link CreateDashboardCommandInput}
@@ -68,6 +73,8 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
68
73
  * on.</p>
69
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>
70
75
  *
76
+ * @throws {@link IoTSiteWiseServiceException}
77
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
71
78
  *
72
79
  */
73
80
  export declare class CreateDashboardCommand extends $Command<CreateDashboardCommandInput, CreateDashboardCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -44,6 +44,11 @@ export interface CreateGatewayCommandOutput extends CreateGatewayResponse, __Met
44
44
  * };
45
45
  * const command = new CreateGatewayCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // CreateGatewayResponse
48
+ * // gatewayId: "STRING_VALUE", // required
49
+ * // gatewayArn: "STRING_VALUE", // required
50
+ * // };
51
+ *
47
52
  * ```
48
53
  *
49
54
  * @param CreateGatewayCommandInput - {@link CreateGatewayCommandInput}
@@ -74,6 +79,8 @@ export interface CreateGatewayCommandOutput extends CreateGatewayResponse, __Met
74
79
  * on.</p>
75
80
  * <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>
76
81
  *
82
+ * @throws {@link IoTSiteWiseServiceException}
83
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
77
84
  *
78
85
  */
79
86
  export declare class CreateGatewayCommand extends $Command<CreateGatewayCommandInput, CreateGatewayCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -54,6 +54,20 @@ export interface CreatePortalCommandOutput extends CreatePortalResponse, __Metad
54
54
  * };
55
55
  * const command = new CreatePortalCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // CreatePortalResponse
58
+ * // portalId: "STRING_VALUE", // required
59
+ * // portalArn: "STRING_VALUE", // required
60
+ * // portalStartUrl: "STRING_VALUE", // required
61
+ * // portalStatus: { // PortalStatus
62
+ * // state: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "FAILED", // required
63
+ * // error: { // MonitorErrorDetails
64
+ * // code: "INTERNAL_FAILURE" || "VALIDATION_ERROR" || "LIMIT_EXCEEDED",
65
+ * // message: "STRING_VALUE",
66
+ * // },
67
+ * // },
68
+ * // ssoApplicationId: "STRING_VALUE", // required
69
+ * // };
70
+ *
57
71
  * ```
58
72
  *
59
73
  * @param CreatePortalCommandInput - {@link CreatePortalCommandInput}
@@ -84,6 +98,8 @@ export interface CreatePortalCommandOutput extends CreatePortalResponse, __Metad
84
98
  * on.</p>
85
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>
86
100
  *
101
+ * @throws {@link IoTSiteWiseServiceException}
102
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
87
103
  *
88
104
  */
89
105
  export declare class CreatePortalCommand extends $Command<CreatePortalCommandInput, CreatePortalCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -41,6 +41,11 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
41
41
  * };
42
42
  * const command = new CreateProjectCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // CreateProjectResponse
45
+ * // projectId: "STRING_VALUE", // required
46
+ * // projectArn: "STRING_VALUE", // required
47
+ * // };
48
+ *
44
49
  * ```
45
50
  *
46
51
  * @param CreateProjectCommandInput - {@link CreateProjectCommandInput}
@@ -71,6 +76,8 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
71
76
  * on.</p>
72
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>
73
78
  *
79
+ * @throws {@link IoTSiteWiseServiceException}
80
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
74
81
  *
75
82
  */
76
83
  export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo
34
34
  * };
35
35
  * const command = new DeleteAccessPolicyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param DeleteAccessPolicyCommandInput - {@link DeleteAccessPolicyCommandInput}
@@ -58,6 +60,8 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo
58
60
  * on.</p>
59
61
  * <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>
60
62
  *
63
+ * @throws {@link IoTSiteWiseServiceException}
64
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeleteAccessPolicyCommand extends $Command<DeleteAccessPolicyCommandInput, DeleteAccessPolicyCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -37,6 +37,22 @@ export interface DeleteAssetCommandOutput extends DeleteAssetResponse, __Metadat
37
37
  * };
38
38
  * const command = new DeleteAssetCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DeleteAssetResponse
41
+ * // assetStatus: { // AssetStatus
42
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED", // required
43
+ * // error: { // ErrorDetails
44
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
45
+ * // message: "STRING_VALUE", // required
46
+ * // details: [ // DetailedErrors
47
+ * // { // DetailedError
48
+ * // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
49
+ * // message: "STRING_VALUE", // required
50
+ * // },
51
+ * // ],
52
+ * // },
53
+ * // },
54
+ * // };
55
+ *
40
56
  * ```
41
57
  *
42
58
  * @param DeleteAssetCommandInput - {@link DeleteAssetCommandInput}
@@ -65,6 +81,8 @@ export interface DeleteAssetCommandOutput extends DeleteAssetResponse, __Metadat
65
81
  * on.</p>
66
82
  * <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>
67
83
  *
84
+ * @throws {@link IoTSiteWiseServiceException}
85
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
68
86
  *
69
87
  */
70
88
  export declare class DeleteAssetCommand extends $Command<DeleteAssetCommandInput, DeleteAssetCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -36,6 +36,22 @@ export interface DeleteAssetModelCommandOutput extends DeleteAssetModelResponse,
36
36
  * };
37
37
  * const command = new DeleteAssetModelCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DeleteAssetModelResponse
40
+ * // assetModelStatus: { // AssetModelStatus
41
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "PROPAGATING" || "DELETING" || "FAILED", // required
42
+ * // error: { // ErrorDetails
43
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
44
+ * // message: "STRING_VALUE", // required
45
+ * // details: [ // DetailedErrors
46
+ * // { // DetailedError
47
+ * // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
48
+ * // message: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // },
52
+ * // },
53
+ * // };
54
+ *
39
55
  * ```
40
56
  *
41
57
  * @param DeleteAssetModelCommandInput - {@link DeleteAssetModelCommandInput}
@@ -64,6 +80,8 @@ export interface DeleteAssetModelCommandOutput extends DeleteAssetModelResponse,
64
80
  * on.</p>
65
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>
66
82
  *
83
+ * @throws {@link IoTSiteWiseServiceException}
84
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
67
85
  *
68
86
  */
69
87
  export declare class DeleteAssetModelCommand extends $Command<DeleteAssetModelCommandInput, DeleteAssetModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, _
32
32
  * };
33
33
  * const command = new DeleteDashboardCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteDashboardCommandInput - {@link DeleteDashboardCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, _
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 DeleteDashboardCommand extends $Command<DeleteDashboardCommandInput, DeleteDashboardCommandOutput, IoTSiteWiseClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteGatewayCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteGatewayCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteGatewayCommandInput - {@link DeleteGatewayCommandInput}
@@ -56,6 +58,8 @@ export interface DeleteGatewayCommandOutput extends __MetadataBearer {
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 DeleteGatewayCommand extends $Command<DeleteGatewayCommandInput, DeleteGatewayCommandOutput, IoTSiteWiseClientResolvedConfig> {