@aws-sdk/client-iotsitewise 3.451.0 → 3.456.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. package/README.md +88 -0
  2. package/dist-cjs/IoTSiteWise.js +22 -0
  3. package/dist-cjs/commands/CreateAssetModelCompositeModelCommand.js +51 -0
  4. package/dist-cjs/commands/DeleteAssetModelCompositeModelCommand.js +51 -0
  5. package/dist-cjs/commands/DescribeActionCommand.js +51 -0
  6. package/dist-cjs/commands/DescribeAssetCompositeModelCommand.js +51 -0
  7. package/dist-cjs/commands/DescribeAssetModelCompositeModelCommand.js +51 -0
  8. package/dist-cjs/commands/ExecuteActionCommand.js +51 -0
  9. package/dist-cjs/commands/ExecuteQueryCommand.js +51 -0
  10. package/dist-cjs/commands/ListActionsCommand.js +51 -0
  11. package/dist-cjs/commands/ListAssetModelCompositeModelsCommand.js +51 -0
  12. package/dist-cjs/commands/ListCompositionRelationshipsCommand.js +51 -0
  13. package/dist-cjs/commands/UpdateAssetModelCompositeModelCommand.js +51 -0
  14. package/dist-cjs/commands/index.js +11 -0
  15. package/dist-cjs/models/index.js +1 -0
  16. package/dist-cjs/models/models_0.js +59 -15
  17. package/dist-cjs/models/models_1.js +18 -0
  18. package/dist-cjs/pagination/ExecuteQueryPaginator.js +29 -0
  19. package/dist-cjs/pagination/ListAssetModelCompositeModelsPaginator.js +29 -0
  20. package/dist-cjs/pagination/ListCompositionRelationshipsPaginator.js +29 -0
  21. package/dist-cjs/pagination/index.js +3 -0
  22. package/dist-cjs/protocols/Aws_restJson1.js +1018 -25
  23. package/dist-es/IoTSiteWise.js +22 -0
  24. package/dist-es/commands/CreateAssetModelCompositeModelCommand.js +47 -0
  25. package/dist-es/commands/DeleteAssetModelCompositeModelCommand.js +47 -0
  26. package/dist-es/commands/DescribeActionCommand.js +47 -0
  27. package/dist-es/commands/DescribeAssetCompositeModelCommand.js +47 -0
  28. package/dist-es/commands/DescribeAssetModelCompositeModelCommand.js +47 -0
  29. package/dist-es/commands/ExecuteActionCommand.js +47 -0
  30. package/dist-es/commands/ExecuteQueryCommand.js +47 -0
  31. package/dist-es/commands/ListActionsCommand.js +47 -0
  32. package/dist-es/commands/ListAssetModelCompositeModelsCommand.js +47 -0
  33. package/dist-es/commands/ListCompositionRelationshipsCommand.js +47 -0
  34. package/dist-es/commands/UpdateAssetModelCompositeModelCommand.js +47 -0
  35. package/dist-es/commands/index.js +11 -0
  36. package/dist-es/models/index.js +1 -0
  37. package/dist-es/models/models_0.js +54 -13
  38. package/dist-es/models/models_1.js +14 -0
  39. package/dist-es/pagination/ExecuteQueryPaginator.js +25 -0
  40. package/dist-es/pagination/ListAssetModelCompositeModelsPaginator.js +25 -0
  41. package/dist-es/pagination/ListCompositionRelationshipsPaginator.js +25 -0
  42. package/dist-es/pagination/index.js +3 -0
  43. package/dist-es/protocols/Aws_restJson1.js +1038 -68
  44. package/dist-types/IoTSiteWise.d.ts +77 -0
  45. package/dist-types/IoTSiteWiseClient.d.ts +13 -2
  46. package/dist-types/commands/CreateAssetCommand.d.ts +2 -0
  47. package/dist-types/commands/CreateAssetModelCommand.d.ts +52 -4
  48. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +212 -0
  49. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +8 -3
  50. package/dist-types/commands/DeleteAssetCommand.d.ts +1 -1
  51. package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +111 -0
  52. package/dist-types/commands/DescribeActionCommand.d.ts +97 -0
  53. package/dist-types/commands/DescribeAssetCommand.d.ts +32 -0
  54. package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +145 -0
  55. package/dist-types/commands/DescribeAssetModelCommand.d.ts +46 -4
  56. package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +209 -0
  57. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +44 -4
  58. package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +4 -1
  59. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +5 -0
  60. package/dist-types/commands/ExecuteActionCommand.d.ts +106 -0
  61. package/dist-types/commands/ExecuteQueryCommand.d.ts +130 -0
  62. package/dist-types/commands/ListActionsCommand.d.ts +101 -0
  63. package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +106 -0
  64. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +21 -2
  65. package/dist-types/commands/ListAssetModelsCommand.d.ts +5 -0
  66. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +8 -1
  67. package/dist-types/commands/ListAssetsCommand.d.ts +2 -0
  68. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +2 -0
  69. package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +98 -0
  70. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
  71. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +1 -1
  72. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +11 -1
  73. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  74. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  75. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +1 -1
  76. package/dist-types/commands/UpdateAssetCommand.d.ts +2 -1
  77. package/dist-types/commands/UpdateAssetModelCommand.d.ts +31 -5
  78. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +220 -0
  79. package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +1 -1
  80. package/dist-types/commands/UpdateDashboardCommand.d.ts +1 -1
  81. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
  82. package/dist-types/commands/UpdateGatewayCommand.d.ts +1 -1
  83. package/dist-types/commands/UpdatePortalCommand.d.ts +1 -1
  84. package/dist-types/commands/UpdateProjectCommand.d.ts +1 -1
  85. package/dist-types/commands/index.d.ts +11 -0
  86. package/dist-types/models/index.d.ts +1 -0
  87. package/dist-types/models/models_0.d.ts +1377 -773
  88. package/dist-types/models/models_1.d.ts +796 -0
  89. package/dist-types/pagination/ExecuteQueryPaginator.d.ts +7 -0
  90. package/dist-types/pagination/ListAssetModelCompositeModelsPaginator.d.ts +7 -0
  91. package/dist-types/pagination/ListCompositionRelationshipsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/index.d.ts +3 -0
  93. package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
  94. package/dist-types/ts3.4/IoTSiteWise.d.ts +187 -0
  95. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +66 -0
  96. package/dist-types/ts3.4/commands/CreateAssetModelCompositeModelCommand.d.ts +42 -0
  97. package/dist-types/ts3.4/commands/DeleteAssetModelCompositeModelCommand.d.ts +42 -0
  98. package/dist-types/ts3.4/commands/DescribeActionCommand.d.ts +38 -0
  99. package/dist-types/ts3.4/commands/DescribeAssetCompositeModelCommand.d.ts +42 -0
  100. package/dist-types/ts3.4/commands/DescribeAssetModelCompositeModelCommand.d.ts +42 -0
  101. package/dist-types/ts3.4/commands/ExecuteActionCommand.d.ts +38 -0
  102. package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +36 -0
  103. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +35 -0
  104. package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +42 -0
  105. package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +42 -0
  106. package/dist-types/ts3.4/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
  107. package/dist-types/ts3.4/commands/PutLoggingOptionsCommand.d.ts +1 -1
  108. package/dist-types/ts3.4/commands/PutStorageConfigurationCommand.d.ts +1 -1
  109. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  111. package/dist-types/ts3.4/commands/UpdateAccessPolicyCommand.d.ts +1 -1
  112. package/dist-types/ts3.4/commands/UpdateAssetCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/UpdateAssetModelCommand.d.ts +1 -1
  114. package/dist-types/ts3.4/commands/UpdateAssetModelCompositeModelCommand.d.ts +42 -0
  115. package/dist-types/ts3.4/commands/UpdateAssetPropertyCommand.d.ts +1 -1
  116. package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
  117. package/dist-types/ts3.4/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
  118. package/dist-types/ts3.4/commands/UpdateGatewayCommand.d.ts +1 -1
  119. package/dist-types/ts3.4/commands/UpdatePortalCommand.d.ts +1 -1
  120. package/dist-types/ts3.4/commands/UpdateProjectCommand.d.ts +1 -1
  121. package/dist-types/ts3.4/commands/index.d.ts +11 -0
  122. package/dist-types/ts3.4/models/index.d.ts +1 -0
  123. package/dist-types/ts3.4/models/models_0.d.ts +284 -130
  124. package/dist-types/ts3.4/models/models_1.d.ts +190 -0
  125. package/dist-types/ts3.4/pagination/ExecuteQueryPaginator.d.ts +11 -0
  126. package/dist-types/ts3.4/pagination/ListAssetModelCompositeModelsPaginator.d.ts +11 -0
  127. package/dist-types/ts3.4/pagination/ListCompositionRelationshipsPaginator.d.ts +11 -0
  128. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  129. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
  130. package/package.json +2 -2
@@ -26,8 +26,10 @@ export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobRes
26
26
  * <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a
27
27
  * bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
28
28
  * <important>
29
- * <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For
30
- * more information about how to configure storage settings, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
29
+ * <p>Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.
30
+ * For more information about how to configure storage settings, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
31
+ * <p>Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on
32
+ * IoT SiteWise warm or cold tier storage.</p>
31
33
  * </important>
32
34
  * @example
33
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -52,12 +54,15 @@ export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobRes
52
54
  * jobConfiguration: { // JobConfiguration
53
55
  * fileFormat: { // FileFormat
54
56
  * csv: { // Csv
55
- * columnNames: [ // ColumnNames
57
+ * columnNames: [ // ColumnNames // required
56
58
  * "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
57
59
  * ],
58
60
  * },
61
+ * parquet: {},
59
62
  * },
60
63
  * },
64
+ * adaptiveIngestion: true || false,
65
+ * deleteFilesAfterImport: true || false,
61
66
  * };
62
67
  * const command = new CreateBulkImportJobCommand(input);
63
68
  * const response = await client.send(command);
@@ -24,7 +24,7 @@ export interface DeleteAssetCommandOutput extends DeleteAssetResponse, __Metadat
24
24
  /**
25
25
  * @public
26
26
  * <p>Deletes an asset. This action can't be undone. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html">Deleting assets and
27
- * models</a> in the <i>IoT SiteWise User Guide</i>. </p>
27
+ * models</a> in the <i>IoT SiteWise User Guide</i>.</p>
28
28
  * <note>
29
29
  * <p>You can't delete an asset that's associated to another asset. For more information, see
30
30
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html">DisassociateAssets</a>.</p>
@@ -0,0 +1,111 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
+ import { DeleteAssetModelCompositeModelRequest, DeleteAssetModelCompositeModelResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteAssetModelCompositeModelCommand}.
14
+ */
15
+ export interface DeleteAssetModelCompositeModelCommandInput extends DeleteAssetModelCompositeModelRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteAssetModelCompositeModelCommand}.
21
+ */
22
+ export interface DeleteAssetModelCompositeModelCommandOutput extends DeleteAssetModelCompositeModelResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes a composite model. This action can't be undone. You must delete all assets created
27
+ * from a composite model before you can delete the model. Also, you can't delete a composite model if
28
+ * a parent asset model exists that contains a property formula expression that depends on the
29
+ * asset model that you want to delete. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html">Deleting assets and models</a> in the
30
+ * <i>IoT SiteWise User Guide</i>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IoTSiteWiseClient, DeleteAssetModelCompositeModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
35
+ * // const { IoTSiteWiseClient, DeleteAssetModelCompositeModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
36
+ * const client = new IoTSiteWiseClient(config);
37
+ * const input = { // DeleteAssetModelCompositeModelRequest
38
+ * assetModelId: "STRING_VALUE", // required
39
+ * assetModelCompositeModelId: "STRING_VALUE", // required
40
+ * clientToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new DeleteAssetModelCompositeModelCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // DeleteAssetModelCompositeModelResponse
45
+ * // assetModelStatus: { // AssetModelStatus
46
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "PROPAGATING" || "DELETING" || "FAILED", // required
47
+ * // error: { // ErrorDetails
48
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
49
+ * // message: "STRING_VALUE", // required
50
+ * // details: [ // DetailedErrors
51
+ * // { // DetailedError
52
+ * // code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
53
+ * // message: "STRING_VALUE", // required
54
+ * // },
55
+ * // ],
56
+ * // },
57
+ * // },
58
+ * // };
59
+ *
60
+ * ```
61
+ *
62
+ * @param DeleteAssetModelCompositeModelCommandInput - {@link DeleteAssetModelCompositeModelCommandInput}
63
+ * @returns {@link DeleteAssetModelCompositeModelCommandOutput}
64
+ * @see {@link DeleteAssetModelCompositeModelCommandInput} for command's `input` shape.
65
+ * @see {@link DeleteAssetModelCompositeModelCommandOutput} for command's `response` shape.
66
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
67
+ *
68
+ * @throws {@link ConflictingOperationException} (client fault)
69
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more
70
+ * than one operation on the same resource at the same time.</p>
71
+ *
72
+ * @throws {@link InternalFailureException} (server fault)
73
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
74
+ *
75
+ * @throws {@link InvalidRequestException} (client fault)
76
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
77
+ * unsupported characters. Check your request and try again.</p>
78
+ *
79
+ * @throws {@link ResourceNotFoundException} (client fault)
80
+ * <p>The requested resource can't be found.</p>
81
+ *
82
+ * @throws {@link ThrottlingException} (client fault)
83
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
84
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
85
+ * on.</p>
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>
87
+ *
88
+ * @throws {@link IoTSiteWiseServiceException}
89
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
90
+ *
91
+ */
92
+ export declare class DeleteAssetModelCompositeModelCommand extends $Command<DeleteAssetModelCompositeModelCommandInput, DeleteAssetModelCompositeModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
93
+ readonly input: DeleteAssetModelCompositeModelCommandInput;
94
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
98
+ constructor(input: DeleteAssetModelCompositeModelCommandInput);
99
+ /**
100
+ * @internal
101
+ */
102
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAssetModelCompositeModelCommandInput, DeleteAssetModelCompositeModelCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
106
+ private serialize;
107
+ /**
108
+ * @internal
109
+ */
110
+ private deserialize;
111
+ }
@@ -0,0 +1,97 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
+ import { DescribeActionRequest, DescribeActionResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeActionCommand}.
14
+ */
15
+ export interface DescribeActionCommandInput extends DescribeActionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeActionCommand}.
21
+ */
22
+ export interface DescribeActionCommandOutput extends DescribeActionResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Retrieves information about an action.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { IoTSiteWiseClient, DescribeActionCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
31
+ * // const { IoTSiteWiseClient, DescribeActionCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
32
+ * const client = new IoTSiteWiseClient(config);
33
+ * const input = { // DescribeActionRequest
34
+ * actionId: "STRING_VALUE", // required
35
+ * };
36
+ * const command = new DescribeActionCommand(input);
37
+ * const response = await client.send(command);
38
+ * // { // DescribeActionResponse
39
+ * // actionId: "STRING_VALUE", // required
40
+ * // targetResource: { // TargetResource
41
+ * // assetId: "STRING_VALUE", // required
42
+ * // },
43
+ * // actionDefinitionId: "STRING_VALUE", // required
44
+ * // actionPayload: { // ActionPayload
45
+ * // stringValue: "STRING_VALUE", // required
46
+ * // },
47
+ * // executionTime: new Date("TIMESTAMP"), // required
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param DescribeActionCommandInput - {@link DescribeActionCommandInput}
53
+ * @returns {@link DescribeActionCommandOutput}
54
+ * @see {@link DescribeActionCommandInput} for command's `input` shape.
55
+ * @see {@link DescribeActionCommandOutput} for command's `response` shape.
56
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
57
+ *
58
+ * @throws {@link InternalFailureException} (server fault)
59
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
60
+ *
61
+ * @throws {@link InvalidRequestException} (client fault)
62
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
63
+ * unsupported characters. Check your request and try again.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>The requested resource can't be found.</p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
70
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
71
+ * on.</p>
72
+ * <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
+ *
74
+ * @throws {@link IoTSiteWiseServiceException}
75
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
76
+ *
77
+ */
78
+ export declare class DescribeActionCommand extends $Command<DescribeActionCommandInput, DescribeActionCommandOutput, IoTSiteWiseClientResolvedConfig> {
79
+ readonly input: DescribeActionCommandInput;
80
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
84
+ constructor(input: DescribeActionCommandInput);
85
+ /**
86
+ * @internal
87
+ */
88
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeActionCommandInput, DescribeActionCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
92
+ private serialize;
93
+ /**
94
+ * @internal
95
+ */
96
+ private deserialize;
97
+ }
@@ -53,12 +53,20 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
53
53
  * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
54
54
  * // dataTypeSpec: "STRING_VALUE",
55
55
  * // unit: "STRING_VALUE",
56
+ * // path: [ // AssetPropertyPath
57
+ * // { // AssetPropertyPathSegment
58
+ * // id: "STRING_VALUE",
59
+ * // name: "STRING_VALUE",
60
+ * // },
61
+ * // ],
62
+ * // externalId: "STRING_VALUE",
56
63
  * // },
57
64
  * // ],
58
65
  * // assetHierarchies: [ // AssetHierarchies // required
59
66
  * // { // AssetHierarchy
60
67
  * // id: "STRING_VALUE",
61
68
  * // name: "STRING_VALUE", // required
69
+ * // externalId: "STRING_VALUE",
62
70
  * // },
63
71
  * // ],
64
72
  * // assetCompositeModels: [ // AssetCompositeModels
@@ -78,9 +86,17 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
78
86
  * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
79
87
  * // dataTypeSpec: "STRING_VALUE",
80
88
  * // unit: "STRING_VALUE",
89
+ * // path: [
90
+ * // {
91
+ * // id: "STRING_VALUE",
92
+ * // name: "STRING_VALUE",
93
+ * // },
94
+ * // ],
95
+ * // externalId: "STRING_VALUE",
81
96
  * // },
82
97
  * // ],
83
98
  * // id: "STRING_VALUE",
99
+ * // externalId: "STRING_VALUE",
84
100
  * // },
85
101
  * // ],
86
102
  * // assetCreationDate: new Date("TIMESTAMP"), // required
@@ -99,6 +115,22 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met
99
115
  * // },
100
116
  * // },
101
117
  * // assetDescription: "STRING_VALUE",
118
+ * // assetCompositeModelSummaries: [ // AssetCompositeModelSummaries
119
+ * // { // AssetCompositeModelSummary
120
+ * // id: "STRING_VALUE", // required
121
+ * // externalId: "STRING_VALUE",
122
+ * // name: "STRING_VALUE", // required
123
+ * // type: "STRING_VALUE", // required
124
+ * // description: "STRING_VALUE", // required
125
+ * // path: [ // AssetCompositeModelPath // required
126
+ * // { // AssetCompositeModelPathSegment
127
+ * // id: "STRING_VALUE",
128
+ * // name: "STRING_VALUE",
129
+ * // },
130
+ * // ],
131
+ * // },
132
+ * // ],
133
+ * // assetExternalId: "STRING_VALUE",
102
134
  * // };
103
135
  *
104
136
  * ```
@@ -0,0 +1,145 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
5
+ import { DescribeAssetCompositeModelRequest, DescribeAssetCompositeModelResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeAssetCompositeModelCommand}.
14
+ */
15
+ export interface DescribeAssetCompositeModelCommandInput extends DescribeAssetCompositeModelRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeAssetCompositeModelCommand}.
21
+ */
22
+ export interface DescribeAssetCompositeModelCommandOutput extends DescribeAssetCompositeModelResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Retrieves information about an asset composite model (also known as an asset component). An <code>AssetCompositeModel</code> is an instance of an <code>AssetModelCompositeModel</code>. If you want to see information about the model this is based on, call
27
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html">DescribeAssetModelCompositeModel</a>.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IoTSiteWiseClient, DescribeAssetCompositeModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
32
+ * // const { IoTSiteWiseClient, DescribeAssetCompositeModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
33
+ * const client = new IoTSiteWiseClient(config);
34
+ * const input = { // DescribeAssetCompositeModelRequest
35
+ * assetId: "STRING_VALUE", // required
36
+ * assetCompositeModelId: "STRING_VALUE", // required
37
+ * };
38
+ * const command = new DescribeAssetCompositeModelCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // DescribeAssetCompositeModelResponse
41
+ * // assetId: "STRING_VALUE", // required
42
+ * // assetCompositeModelId: "STRING_VALUE", // required
43
+ * // assetCompositeModelExternalId: "STRING_VALUE",
44
+ * // assetCompositeModelPath: [ // AssetCompositeModelPath // required
45
+ * // { // AssetCompositeModelPathSegment
46
+ * // id: "STRING_VALUE",
47
+ * // name: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // assetCompositeModelName: "STRING_VALUE", // required
51
+ * // assetCompositeModelDescription: "STRING_VALUE", // required
52
+ * // assetCompositeModelType: "STRING_VALUE", // required
53
+ * // assetCompositeModelProperties: [ // AssetProperties // required
54
+ * // { // AssetProperty
55
+ * // id: "STRING_VALUE", // required
56
+ * // name: "STRING_VALUE", // required
57
+ * // alias: "STRING_VALUE",
58
+ * // notification: { // PropertyNotification
59
+ * // topic: "STRING_VALUE", // required
60
+ * // state: "ENABLED" || "DISABLED", // required
61
+ * // },
62
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
63
+ * // dataTypeSpec: "STRING_VALUE",
64
+ * // unit: "STRING_VALUE",
65
+ * // path: [ // AssetPropertyPath
66
+ * // { // AssetPropertyPathSegment
67
+ * // id: "STRING_VALUE",
68
+ * // name: "STRING_VALUE",
69
+ * // },
70
+ * // ],
71
+ * // externalId: "STRING_VALUE",
72
+ * // },
73
+ * // ],
74
+ * // assetCompositeModelSummaries: [ // AssetCompositeModelSummaries // required
75
+ * // { // AssetCompositeModelSummary
76
+ * // id: "STRING_VALUE", // required
77
+ * // externalId: "STRING_VALUE",
78
+ * // name: "STRING_VALUE", // required
79
+ * // type: "STRING_VALUE", // required
80
+ * // description: "STRING_VALUE", // required
81
+ * // path: [ // required
82
+ * // {
83
+ * // id: "STRING_VALUE",
84
+ * // name: "STRING_VALUE",
85
+ * // },
86
+ * // ],
87
+ * // },
88
+ * // ],
89
+ * // actionDefinitions: [ // ActionDefinitions
90
+ * // { // ActionDefinition
91
+ * // actionDefinitionId: "STRING_VALUE", // required
92
+ * // actionName: "STRING_VALUE", // required
93
+ * // actionType: "STRING_VALUE", // required
94
+ * // },
95
+ * // ],
96
+ * // };
97
+ *
98
+ * ```
99
+ *
100
+ * @param DescribeAssetCompositeModelCommandInput - {@link DescribeAssetCompositeModelCommandInput}
101
+ * @returns {@link DescribeAssetCompositeModelCommandOutput}
102
+ * @see {@link DescribeAssetCompositeModelCommandInput} for command's `input` shape.
103
+ * @see {@link DescribeAssetCompositeModelCommandOutput} for command's `response` shape.
104
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
105
+ *
106
+ * @throws {@link InternalFailureException} (server fault)
107
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
108
+ *
109
+ * @throws {@link InvalidRequestException} (client fault)
110
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
111
+ * unsupported characters. Check your request and try again.</p>
112
+ *
113
+ * @throws {@link ResourceNotFoundException} (client fault)
114
+ * <p>The requested resource can't be found.</p>
115
+ *
116
+ * @throws {@link ThrottlingException} (client fault)
117
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
118
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
119
+ * on.</p>
120
+ * <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>
121
+ *
122
+ * @throws {@link IoTSiteWiseServiceException}
123
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
124
+ *
125
+ */
126
+ export declare class DescribeAssetCompositeModelCommand extends $Command<DescribeAssetCompositeModelCommandInput, DescribeAssetCompositeModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
127
+ readonly input: DescribeAssetCompositeModelCommandInput;
128
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
129
+ /**
130
+ * @public
131
+ */
132
+ constructor(input: DescribeAssetCompositeModelCommandInput);
133
+ /**
134
+ * @internal
135
+ */
136
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAssetCompositeModelCommandInput, DescribeAssetCompositeModelCommandOutput>;
137
+ /**
138
+ * @internal
139
+ */
140
+ private serialize;
141
+ /**
142
+ * @internal
143
+ */
144
+ private deserialize;
145
+ }
@@ -65,8 +65,14 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
65
65
  * // { // ExpressionVariable
66
66
  * // name: "STRING_VALUE", // required
67
67
  * // value: { // VariableValue
68
- * // propertyId: "STRING_VALUE", // required
68
+ * // propertyId: "STRING_VALUE",
69
69
  * // hierarchyId: "STRING_VALUE",
70
+ * // propertyPath: [ // AssetModelPropertyPath
71
+ * // { // AssetModelPropertyPathSegment
72
+ * // id: "STRING_VALUE",
73
+ * // name: "STRING_VALUE",
74
+ * // },
75
+ * // ],
70
76
  * // },
71
77
  * // },
72
78
  * // ],
@@ -83,8 +89,14 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
83
89
  * // {
84
90
  * // name: "STRING_VALUE", // required
85
91
  * // value: {
86
- * // propertyId: "STRING_VALUE", // required
92
+ * // propertyId: "STRING_VALUE",
87
93
  * // hierarchyId: "STRING_VALUE",
94
+ * // propertyPath: [
95
+ * // {
96
+ * // id: "STRING_VALUE",
97
+ * // name: "STRING_VALUE",
98
+ * // },
99
+ * // ],
88
100
  * // },
89
101
  * // },
90
102
  * // ],
@@ -99,6 +111,13 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
99
111
  * // },
100
112
  * // },
101
113
  * // },
114
+ * // path: [
115
+ * // {
116
+ * // id: "STRING_VALUE",
117
+ * // name: "STRING_VALUE",
118
+ * // },
119
+ * // ],
120
+ * // externalId: "STRING_VALUE",
102
121
  * // },
103
122
  * // ],
104
123
  * // assetModelHierarchies: [ // AssetModelHierarchies // required
@@ -106,6 +125,7 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
106
125
  * // id: "STRING_VALUE",
107
126
  * // name: "STRING_VALUE", // required
108
127
  * // childAssetModelId: "STRING_VALUE", // required
128
+ * // externalId: "STRING_VALUE",
109
129
  * // },
110
130
  * // ],
111
131
  * // assetModelCompositeModels: [ // AssetModelCompositeModels
@@ -137,8 +157,9 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
137
157
  * // {
138
158
  * // name: "STRING_VALUE", // required
139
159
  * // value: {
140
- * // propertyId: "STRING_VALUE", // required
160
+ * // propertyId: "STRING_VALUE",
141
161
  * // hierarchyId: "STRING_VALUE",
162
+ * // propertyPath: "<AssetModelPropertyPath>",
142
163
  * // },
143
164
  * // },
144
165
  * // ],
@@ -155,8 +176,9 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
155
176
  * // {
156
177
  * // name: "STRING_VALUE", // required
157
178
  * // value: {
158
- * // propertyId: "STRING_VALUE", // required
179
+ * // propertyId: "STRING_VALUE",
159
180
  * // hierarchyId: "STRING_VALUE",
181
+ * // propertyPath: "<AssetModelPropertyPath>",
160
182
  * // },
161
183
  * // },
162
184
  * // ],
@@ -171,9 +193,12 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
171
193
  * // },
172
194
  * // },
173
195
  * // },
196
+ * // path: "<AssetModelPropertyPath>",
197
+ * // externalId: "STRING_VALUE",
174
198
  * // },
175
199
  * // ],
176
200
  * // id: "STRING_VALUE",
201
+ * // externalId: "STRING_VALUE",
177
202
  * // },
178
203
  * // ],
179
204
  * // assetModelCreationDate: new Date("TIMESTAMP"), // required
@@ -191,6 +216,23 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo
191
216
  * // ],
192
217
  * // },
193
218
  * // },
219
+ * // assetModelType: "ASSET_MODEL" || "COMPONENT_MODEL",
220
+ * // assetModelCompositeModelSummaries: [ // AssetModelCompositeModelSummaries
221
+ * // { // AssetModelCompositeModelSummary
222
+ * // id: "STRING_VALUE", // required
223
+ * // externalId: "STRING_VALUE",
224
+ * // name: "STRING_VALUE", // required
225
+ * // type: "STRING_VALUE", // required
226
+ * // description: "STRING_VALUE",
227
+ * // path: [ // AssetModelCompositeModelPath
228
+ * // { // AssetModelCompositeModelPathSegment
229
+ * // id: "STRING_VALUE",
230
+ * // name: "STRING_VALUE",
231
+ * // },
232
+ * // ],
233
+ * // },
234
+ * // ],
235
+ * // assetModelExternalId: "STRING_VALUE",
194
236
  * // };
195
237
  *
196
238
  * ```