@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.
- package/README.md +88 -0
- package/dist-cjs/IoTSiteWise.js +22 -0
- package/dist-cjs/commands/CreateAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/DeleteAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/DescribeActionCommand.js +51 -0
- package/dist-cjs/commands/DescribeAssetCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/DescribeAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/ExecuteActionCommand.js +51 -0
- package/dist-cjs/commands/ExecuteQueryCommand.js +51 -0
- package/dist-cjs/commands/ListActionsCommand.js +51 -0
- package/dist-cjs/commands/ListAssetModelCompositeModelsCommand.js +51 -0
- package/dist-cjs/commands/ListCompositionRelationshipsCommand.js +51 -0
- package/dist-cjs/commands/UpdateAssetModelCompositeModelCommand.js +51 -0
- package/dist-cjs/commands/index.js +11 -0
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +59 -15
- package/dist-cjs/models/models_1.js +18 -0
- package/dist-cjs/pagination/ExecuteQueryPaginator.js +29 -0
- package/dist-cjs/pagination/ListAssetModelCompositeModelsPaginator.js +29 -0
- package/dist-cjs/pagination/ListCompositionRelationshipsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1018 -25
- package/dist-es/IoTSiteWise.js +22 -0
- package/dist-es/commands/CreateAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/DeleteAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/DescribeActionCommand.js +47 -0
- package/dist-es/commands/DescribeAssetCompositeModelCommand.js +47 -0
- package/dist-es/commands/DescribeAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/ExecuteActionCommand.js +47 -0
- package/dist-es/commands/ExecuteQueryCommand.js +47 -0
- package/dist-es/commands/ListActionsCommand.js +47 -0
- package/dist-es/commands/ListAssetModelCompositeModelsCommand.js +47 -0
- package/dist-es/commands/ListCompositionRelationshipsCommand.js +47 -0
- package/dist-es/commands/UpdateAssetModelCompositeModelCommand.js +47 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +54 -13
- package/dist-es/models/models_1.js +14 -0
- package/dist-es/pagination/ExecuteQueryPaginator.js +25 -0
- package/dist-es/pagination/ListAssetModelCompositeModelsPaginator.js +25 -0
- package/dist-es/pagination/ListCompositionRelationshipsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1038 -68
- package/dist-types/IoTSiteWise.d.ts +77 -0
- package/dist-types/IoTSiteWiseClient.d.ts +13 -2
- package/dist-types/commands/CreateAssetCommand.d.ts +2 -0
- package/dist-types/commands/CreateAssetModelCommand.d.ts +52 -4
- package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +212 -0
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +8 -3
- package/dist-types/commands/DeleteAssetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +111 -0
- package/dist-types/commands/DescribeActionCommand.d.ts +97 -0
- package/dist-types/commands/DescribeAssetCommand.d.ts +32 -0
- package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +145 -0
- package/dist-types/commands/DescribeAssetModelCommand.d.ts +46 -4
- package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +209 -0
- package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +44 -4
- package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +4 -1
- package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +5 -0
- package/dist-types/commands/ExecuteActionCommand.d.ts +106 -0
- package/dist-types/commands/ExecuteQueryCommand.d.ts +130 -0
- package/dist-types/commands/ListActionsCommand.d.ts +101 -0
- package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +106 -0
- package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +21 -2
- package/dist-types/commands/ListAssetModelsCommand.d.ts +5 -0
- package/dist-types/commands/ListAssetPropertiesCommand.d.ts +8 -1
- package/dist-types/commands/ListAssetsCommand.d.ts +2 -0
- package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +2 -0
- package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +98 -0
- package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutLoggingOptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutStorageConfigurationCommand.d.ts +11 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAssetModelCommand.d.ts +31 -5
- package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +220 -0
- package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePortalCommand.d.ts +1 -1
- package/dist-types/commands/UpdateProjectCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1377 -773
- package/dist-types/models/models_1.d.ts +796 -0
- package/dist-types/pagination/ExecuteQueryPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAssetModelCompositeModelsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListCompositionRelationshipsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +187 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/CreateAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeActionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeAssetCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ExecuteActionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutLoggingOptionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssetModelCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAssetModelCompositeModelCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateAssetPropertyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGatewayCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePortalCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateProjectCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +284 -130
- package/dist-types/ts3.4/models/models_1.d.ts +190 -0
- package/dist-types/ts3.4/pagination/ExecuteQueryPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAssetModelCompositeModelsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListCompositionRelationshipsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
- package/package.json +2 -2
|
@@ -0,0 +1,209 @@
|
|
|
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 { DescribeAssetModelCompositeModelRequest, DescribeAssetModelCompositeModelResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeAssetModelCompositeModelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeAssetModelCompositeModelCommandInput extends DescribeAssetModelCompositeModelRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeAssetModelCompositeModelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeAssetModelCompositeModelCommandOutput extends DescribeAssetModelCompositeModelResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Retrieves information about an asset model composite model (also known as an asset model component). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html">Custom composite models (Components)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IoTSiteWiseClient, DescribeAssetModelCompositeModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
31
|
+
* // const { IoTSiteWiseClient, DescribeAssetModelCompositeModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
32
|
+
* const client = new IoTSiteWiseClient(config);
|
|
33
|
+
* const input = { // DescribeAssetModelCompositeModelRequest
|
|
34
|
+
* assetModelId: "STRING_VALUE", // required
|
|
35
|
+
* assetModelCompositeModelId: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new DescribeAssetModelCompositeModelCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // DescribeAssetModelCompositeModelResponse
|
|
40
|
+
* // assetModelId: "STRING_VALUE", // required
|
|
41
|
+
* // assetModelCompositeModelId: "STRING_VALUE", // required
|
|
42
|
+
* // assetModelCompositeModelExternalId: "STRING_VALUE",
|
|
43
|
+
* // assetModelCompositeModelPath: [ // AssetModelCompositeModelPath // required
|
|
44
|
+
* // { // AssetModelCompositeModelPathSegment
|
|
45
|
+
* // id: "STRING_VALUE",
|
|
46
|
+
* // name: "STRING_VALUE",
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // assetModelCompositeModelName: "STRING_VALUE", // required
|
|
50
|
+
* // assetModelCompositeModelDescription: "STRING_VALUE", // required
|
|
51
|
+
* // assetModelCompositeModelType: "STRING_VALUE", // required
|
|
52
|
+
* // assetModelCompositeModelProperties: [ // AssetModelProperties // required
|
|
53
|
+
* // { // AssetModelProperty
|
|
54
|
+
* // id: "STRING_VALUE",
|
|
55
|
+
* // name: "STRING_VALUE", // required
|
|
56
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
57
|
+
* // dataTypeSpec: "STRING_VALUE",
|
|
58
|
+
* // unit: "STRING_VALUE",
|
|
59
|
+
* // type: { // PropertyType
|
|
60
|
+
* // attribute: { // Attribute
|
|
61
|
+
* // defaultValue: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // measurement: { // Measurement
|
|
64
|
+
* // processingConfig: { // MeasurementProcessingConfig
|
|
65
|
+
* // forwardingConfig: { // ForwardingConfig
|
|
66
|
+
* // state: "DISABLED" || "ENABLED", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // transform: { // Transform
|
|
71
|
+
* // expression: "STRING_VALUE", // required
|
|
72
|
+
* // variables: [ // ExpressionVariables // required
|
|
73
|
+
* // { // ExpressionVariable
|
|
74
|
+
* // name: "STRING_VALUE", // required
|
|
75
|
+
* // value: { // VariableValue
|
|
76
|
+
* // propertyId: "STRING_VALUE",
|
|
77
|
+
* // hierarchyId: "STRING_VALUE",
|
|
78
|
+
* // propertyPath: [ // AssetModelPropertyPath
|
|
79
|
+
* // { // AssetModelPropertyPathSegment
|
|
80
|
+
* // id: "STRING_VALUE",
|
|
81
|
+
* // name: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // ],
|
|
87
|
+
* // processingConfig: { // TransformProcessingConfig
|
|
88
|
+
* // computeLocation: "EDGE" || "CLOUD", // required
|
|
89
|
+
* // forwardingConfig: {
|
|
90
|
+
* // state: "DISABLED" || "ENABLED", // required
|
|
91
|
+
* // },
|
|
92
|
+
* // },
|
|
93
|
+
* // },
|
|
94
|
+
* // metric: { // Metric
|
|
95
|
+
* // expression: "STRING_VALUE", // required
|
|
96
|
+
* // variables: [ // required
|
|
97
|
+
* // {
|
|
98
|
+
* // name: "STRING_VALUE", // required
|
|
99
|
+
* // value: {
|
|
100
|
+
* // propertyId: "STRING_VALUE",
|
|
101
|
+
* // hierarchyId: "STRING_VALUE",
|
|
102
|
+
* // propertyPath: [
|
|
103
|
+
* // {
|
|
104
|
+
* // id: "STRING_VALUE",
|
|
105
|
+
* // name: "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // ],
|
|
108
|
+
* // },
|
|
109
|
+
* // },
|
|
110
|
+
* // ],
|
|
111
|
+
* // window: { // MetricWindow
|
|
112
|
+
* // tumbling: { // TumblingWindow
|
|
113
|
+
* // interval: "STRING_VALUE", // required
|
|
114
|
+
* // offset: "STRING_VALUE",
|
|
115
|
+
* // },
|
|
116
|
+
* // },
|
|
117
|
+
* // processingConfig: { // MetricProcessingConfig
|
|
118
|
+
* // computeLocation: "EDGE" || "CLOUD", // required
|
|
119
|
+
* // },
|
|
120
|
+
* // },
|
|
121
|
+
* // },
|
|
122
|
+
* // path: [
|
|
123
|
+
* // {
|
|
124
|
+
* // id: "STRING_VALUE",
|
|
125
|
+
* // name: "STRING_VALUE",
|
|
126
|
+
* // },
|
|
127
|
+
* // ],
|
|
128
|
+
* // externalId: "STRING_VALUE",
|
|
129
|
+
* // },
|
|
130
|
+
* // ],
|
|
131
|
+
* // compositionDetails: { // CompositionDetails
|
|
132
|
+
* // compositionRelationship: [ // CompositionRelationship
|
|
133
|
+
* // { // CompositionRelationshipItem
|
|
134
|
+
* // id: "STRING_VALUE",
|
|
135
|
+
* // },
|
|
136
|
+
* // ],
|
|
137
|
+
* // },
|
|
138
|
+
* // assetModelCompositeModelSummaries: [ // AssetModelCompositeModelSummaries // required
|
|
139
|
+
* // { // AssetModelCompositeModelSummary
|
|
140
|
+
* // id: "STRING_VALUE", // required
|
|
141
|
+
* // externalId: "STRING_VALUE",
|
|
142
|
+
* // name: "STRING_VALUE", // required
|
|
143
|
+
* // type: "STRING_VALUE", // required
|
|
144
|
+
* // description: "STRING_VALUE",
|
|
145
|
+
* // path: [
|
|
146
|
+
* // {
|
|
147
|
+
* // id: "STRING_VALUE",
|
|
148
|
+
* // name: "STRING_VALUE",
|
|
149
|
+
* // },
|
|
150
|
+
* // ],
|
|
151
|
+
* // },
|
|
152
|
+
* // ],
|
|
153
|
+
* // actionDefinitions: [ // ActionDefinitions
|
|
154
|
+
* // { // ActionDefinition
|
|
155
|
+
* // actionDefinitionId: "STRING_VALUE", // required
|
|
156
|
+
* // actionName: "STRING_VALUE", // required
|
|
157
|
+
* // actionType: "STRING_VALUE", // required
|
|
158
|
+
* // },
|
|
159
|
+
* // ],
|
|
160
|
+
* // };
|
|
161
|
+
*
|
|
162
|
+
* ```
|
|
163
|
+
*
|
|
164
|
+
* @param DescribeAssetModelCompositeModelCommandInput - {@link DescribeAssetModelCompositeModelCommandInput}
|
|
165
|
+
* @returns {@link DescribeAssetModelCompositeModelCommandOutput}
|
|
166
|
+
* @see {@link DescribeAssetModelCompositeModelCommandInput} for command's `input` shape.
|
|
167
|
+
* @see {@link DescribeAssetModelCompositeModelCommandOutput} for command's `response` shape.
|
|
168
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
169
|
+
*
|
|
170
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
171
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
172
|
+
*
|
|
173
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
174
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
175
|
+
* unsupported characters. Check your request and try again.</p>
|
|
176
|
+
*
|
|
177
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
178
|
+
* <p>The requested resource can't be found.</p>
|
|
179
|
+
*
|
|
180
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
181
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
182
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
183
|
+
* on.</p>
|
|
184
|
+
* <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>
|
|
185
|
+
*
|
|
186
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
187
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
188
|
+
*
|
|
189
|
+
*/
|
|
190
|
+
export declare class DescribeAssetModelCompositeModelCommand extends $Command<DescribeAssetModelCompositeModelCommandInput, DescribeAssetModelCompositeModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
191
|
+
readonly input: DescribeAssetModelCompositeModelCommandInput;
|
|
192
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
193
|
+
/**
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
constructor(input: DescribeAssetModelCompositeModelCommandInput);
|
|
197
|
+
/**
|
|
198
|
+
* @internal
|
|
199
|
+
*/
|
|
200
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAssetModelCompositeModelCommandInput, DescribeAssetModelCompositeModelCommandOutput>;
|
|
201
|
+
/**
|
|
202
|
+
* @internal
|
|
203
|
+
*/
|
|
204
|
+
private serialize;
|
|
205
|
+
/**
|
|
206
|
+
* @internal
|
|
207
|
+
*/
|
|
208
|
+
private deserialize;
|
|
209
|
+
}
|
|
@@ -74,8 +74,14 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
|
|
|
74
74
|
* // { // ExpressionVariable
|
|
75
75
|
* // name: "STRING_VALUE", // required
|
|
76
76
|
* // value: { // VariableValue
|
|
77
|
-
* // propertyId: "STRING_VALUE",
|
|
77
|
+
* // propertyId: "STRING_VALUE",
|
|
78
78
|
* // hierarchyId: "STRING_VALUE",
|
|
79
|
+
* // propertyPath: [ // AssetModelPropertyPath
|
|
80
|
+
* // { // AssetModelPropertyPathSegment
|
|
81
|
+
* // id: "STRING_VALUE",
|
|
82
|
+
* // name: "STRING_VALUE",
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
79
85
|
* // },
|
|
80
86
|
* // },
|
|
81
87
|
* // ],
|
|
@@ -92,8 +98,14 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
|
|
|
92
98
|
* // {
|
|
93
99
|
* // name: "STRING_VALUE", // required
|
|
94
100
|
* // value: {
|
|
95
|
-
* // propertyId: "STRING_VALUE",
|
|
101
|
+
* // propertyId: "STRING_VALUE",
|
|
96
102
|
* // hierarchyId: "STRING_VALUE",
|
|
103
|
+
* // propertyPath: [
|
|
104
|
+
* // {
|
|
105
|
+
* // id: "STRING_VALUE",
|
|
106
|
+
* // name: "STRING_VALUE",
|
|
107
|
+
* // },
|
|
108
|
+
* // ],
|
|
97
109
|
* // },
|
|
98
110
|
* // },
|
|
99
111
|
* // ],
|
|
@@ -108,6 +120,13 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
|
|
|
108
120
|
* // },
|
|
109
121
|
* // },
|
|
110
122
|
* // },
|
|
123
|
+
* // path: [ // AssetPropertyPath
|
|
124
|
+
* // { // AssetPropertyPathSegment
|
|
125
|
+
* // id: "STRING_VALUE",
|
|
126
|
+
* // name: "STRING_VALUE",
|
|
127
|
+
* // },
|
|
128
|
+
* // ],
|
|
129
|
+
* // externalId: "STRING_VALUE",
|
|
111
130
|
* // },
|
|
112
131
|
* // compositeModel: { // CompositeModelProperty
|
|
113
132
|
* // name: "STRING_VALUE", // required
|
|
@@ -139,8 +158,14 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
|
|
|
139
158
|
* // {
|
|
140
159
|
* // name: "STRING_VALUE", // required
|
|
141
160
|
* // value: {
|
|
142
|
-
* // propertyId: "STRING_VALUE",
|
|
161
|
+
* // propertyId: "STRING_VALUE",
|
|
143
162
|
* // hierarchyId: "STRING_VALUE",
|
|
163
|
+
* // propertyPath: [
|
|
164
|
+
* // {
|
|
165
|
+
* // id: "STRING_VALUE",
|
|
166
|
+
* // name: "STRING_VALUE",
|
|
167
|
+
* // },
|
|
168
|
+
* // ],
|
|
144
169
|
* // },
|
|
145
170
|
* // },
|
|
146
171
|
* // ],
|
|
@@ -157,8 +182,14 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
|
|
|
157
182
|
* // {
|
|
158
183
|
* // name: "STRING_VALUE", // required
|
|
159
184
|
* // value: {
|
|
160
|
-
* // propertyId: "STRING_VALUE",
|
|
185
|
+
* // propertyId: "STRING_VALUE",
|
|
161
186
|
* // hierarchyId: "STRING_VALUE",
|
|
187
|
+
* // propertyPath: [
|
|
188
|
+
* // {
|
|
189
|
+
* // id: "STRING_VALUE",
|
|
190
|
+
* // name: "STRING_VALUE",
|
|
191
|
+
* // },
|
|
192
|
+
* // ],
|
|
162
193
|
* // },
|
|
163
194
|
* // },
|
|
164
195
|
* // ],
|
|
@@ -173,9 +204,18 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert
|
|
|
173
204
|
* // },
|
|
174
205
|
* // },
|
|
175
206
|
* // },
|
|
207
|
+
* // path: [
|
|
208
|
+
* // {
|
|
209
|
+
* // id: "STRING_VALUE",
|
|
210
|
+
* // name: "STRING_VALUE",
|
|
211
|
+
* // },
|
|
212
|
+
* // ],
|
|
213
|
+
* // externalId: "STRING_VALUE",
|
|
176
214
|
* // },
|
|
177
215
|
* // id: "STRING_VALUE",
|
|
216
|
+
* // externalId: "STRING_VALUE",
|
|
178
217
|
* // },
|
|
218
|
+
* // assetExternalId: "STRING_VALUE",
|
|
179
219
|
* // };
|
|
180
220
|
*
|
|
181
221
|
* ```
|
|
@@ -55,14 +55,17 @@ export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJo
|
|
|
55
55
|
* // jobConfiguration: { // JobConfiguration
|
|
56
56
|
* // fileFormat: { // FileFormat
|
|
57
57
|
* // csv: { // Csv
|
|
58
|
-
* // columnNames: [ // ColumnNames
|
|
58
|
+
* // columnNames: [ // ColumnNames // required
|
|
59
59
|
* // "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
|
|
60
60
|
* // ],
|
|
61
61
|
* // },
|
|
62
|
+
* // parquet: {},
|
|
62
63
|
* // },
|
|
63
64
|
* // },
|
|
64
65
|
* // jobCreationDate: new Date("TIMESTAMP"), // required
|
|
65
66
|
* // jobLastUpdateDate: new Date("TIMESTAMP"), // required
|
|
67
|
+
* // adaptiveIngestion: true || false,
|
|
68
|
+
* // deleteFilesAfterImport: true || false,
|
|
66
69
|
* // };
|
|
67
70
|
*
|
|
68
71
|
* ```
|
|
@@ -54,6 +54,11 @@ export interface DescribeStorageConfigurationCommandOutput extends DescribeStora
|
|
|
54
54
|
* // },
|
|
55
55
|
* // },
|
|
56
56
|
* // lastUpdateDate: new Date("TIMESTAMP"),
|
|
57
|
+
* // warmTier: "ENABLED" || "DISABLED",
|
|
58
|
+
* // warmTierRetentionPeriod: { // WarmTierRetentionPeriod
|
|
59
|
+
* // numberOfDays: Number("int"),
|
|
60
|
+
* // unlimited: true || false,
|
|
61
|
+
* // },
|
|
57
62
|
* // };
|
|
58
63
|
*
|
|
59
64
|
* ```
|
|
@@ -0,0 +1,106 @@
|
|
|
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 { ExecuteActionRequest, ExecuteActionResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ExecuteActionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ExecuteActionCommandInput extends ExecuteActionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ExecuteActionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ExecuteActionCommandOutput extends ExecuteActionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Executes an action on a target resource.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { IoTSiteWiseClient, ExecuteActionCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
31
|
+
* // const { IoTSiteWiseClient, ExecuteActionCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
32
|
+
* const client = new IoTSiteWiseClient(config);
|
|
33
|
+
* const input = { // ExecuteActionRequest
|
|
34
|
+
* targetResource: { // TargetResource
|
|
35
|
+
* assetId: "STRING_VALUE", // required
|
|
36
|
+
* },
|
|
37
|
+
* actionDefinitionId: "STRING_VALUE", // required
|
|
38
|
+
* actionPayload: { // ActionPayload
|
|
39
|
+
* stringValue: "STRING_VALUE", // required
|
|
40
|
+
* },
|
|
41
|
+
* clientToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ExecuteActionCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ExecuteActionResponse
|
|
46
|
+
* // actionId: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param ExecuteActionCommandInput - {@link ExecuteActionCommandInput}
|
|
52
|
+
* @returns {@link ExecuteActionCommandOutput}
|
|
53
|
+
* @see {@link ExecuteActionCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link ExecuteActionCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
58
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
59
|
+
* than one operation on the same resource at the same time.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
62
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
65
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
66
|
+
* unsupported characters. Check your request and try again.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
69
|
+
* <p>You've reached the limit for a resource. For example, this can occur if you're trying to
|
|
70
|
+
* associate more than the allowed number of child assets or attempting to create more than the
|
|
71
|
+
* allowed number of properties for an asset model.</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 ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The requested resource can't be found.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
79
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
80
|
+
* on.</p>
|
|
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>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
85
|
+
*
|
|
86
|
+
*/
|
|
87
|
+
export declare class ExecuteActionCommand extends $Command<ExecuteActionCommandInput, ExecuteActionCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
88
|
+
readonly input: ExecuteActionCommandInput;
|
|
89
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
constructor(input: ExecuteActionCommandInput);
|
|
94
|
+
/**
|
|
95
|
+
* @internal
|
|
96
|
+
*/
|
|
97
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteActionCommandInput, ExecuteActionCommandOutput>;
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
private serialize;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private deserialize;
|
|
106
|
+
}
|
|
@@ -0,0 +1,130 @@
|
|
|
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 { ExecuteQueryRequest } from "../models/models_0";
|
|
6
|
+
import { ExecuteQueryResponse } from "../models/models_1";
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export { __MetadataBearer, $Command };
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*
|
|
14
|
+
* The input for {@link ExecuteQueryCommand}.
|
|
15
|
+
*/
|
|
16
|
+
export interface ExecuteQueryCommandInput extends ExecuteQueryRequest {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*
|
|
21
|
+
* The output of {@link ExecuteQueryCommand}.
|
|
22
|
+
*/
|
|
23
|
+
export interface ExecuteQueryCommandOutput extends ExecuteQueryResponse, __MetadataBearer {
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
* <p>Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { IoTSiteWiseClient, ExecuteQueryCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
32
|
+
* // const { IoTSiteWiseClient, ExecuteQueryCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
33
|
+
* const client = new IoTSiteWiseClient(config);
|
|
34
|
+
* const input = { // ExecuteQueryRequest
|
|
35
|
+
* queryStatement: "STRING_VALUE", // required
|
|
36
|
+
* nextToken: "STRING_VALUE",
|
|
37
|
+
* maxResults: Number("int"),
|
|
38
|
+
* };
|
|
39
|
+
* const command = new ExecuteQueryCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // ExecuteQueryResponse
|
|
42
|
+
* // columns: [ // ColumnsList
|
|
43
|
+
* // { // ColumnInfo
|
|
44
|
+
* // name: "STRING_VALUE",
|
|
45
|
+
* // type: { // ColumnType
|
|
46
|
+
* // scalarType: "BOOLEAN" || "INT" || "DOUBLE" || "TIMESTAMP" || "STRING",
|
|
47
|
+
* // },
|
|
48
|
+
* // },
|
|
49
|
+
* // ],
|
|
50
|
+
* // rows: [ // Rows
|
|
51
|
+
* // { // Row
|
|
52
|
+
* // data: [ // DatumList // required
|
|
53
|
+
* // { // Datum
|
|
54
|
+
* // scalarValue: "STRING_VALUE",
|
|
55
|
+
* // arrayValue: [
|
|
56
|
+
* // {
|
|
57
|
+
* // scalarValue: "STRING_VALUE",
|
|
58
|
+
* // arrayValue: "<DatumList>",
|
|
59
|
+
* // rowValue: {
|
|
60
|
+
* // data: "<DatumList>", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // nullValue: true || false,
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // rowValue: "<Row>",
|
|
66
|
+
* // nullValue: true || false,
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // nextToken: "STRING_VALUE",
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* @param ExecuteQueryCommandInput - {@link ExecuteQueryCommandInput}
|
|
77
|
+
* @returns {@link ExecuteQueryCommandOutput}
|
|
78
|
+
* @see {@link ExecuteQueryCommandInput} for command's `input` shape.
|
|
79
|
+
* @see {@link ExecuteQueryCommandOutput} for command's `response` shape.
|
|
80
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
83
|
+
* <p>Access is denied.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
86
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
89
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
90
|
+
* unsupported characters. Check your request and try again.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link QueryTimeoutException} (client fault)
|
|
93
|
+
* <p>The query timed out.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
96
|
+
* <p>The requested service is unavailable.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
99
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
100
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
101
|
+
* on.</p>
|
|
102
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ValidationException} (client fault)
|
|
105
|
+
* <p>The validation failed for this query.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
108
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
109
|
+
*
|
|
110
|
+
*/
|
|
111
|
+
export declare class ExecuteQueryCommand extends $Command<ExecuteQueryCommandInput, ExecuteQueryCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
112
|
+
readonly input: ExecuteQueryCommandInput;
|
|
113
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
constructor(input: ExecuteQueryCommandInput);
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
*/
|
|
121
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ExecuteQueryCommandInput, ExecuteQueryCommandOutput>;
|
|
122
|
+
/**
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
125
|
+
private serialize;
|
|
126
|
+
/**
|
|
127
|
+
* @internal
|
|
128
|
+
*/
|
|
129
|
+
private deserialize;
|
|
130
|
+
}
|