@aws-sdk/client-iotsitewise 3.614.0 → 3.619.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/dist-cjs/index.js +6 -5
- package/dist-es/IoTSiteWiseClient.js +5 -5
- package/dist-es/models/models_0.js +1 -0
- package/dist-types/IoTSiteWiseClient.d.ts +2 -2
- package/dist-types/commands/CreateAssetModelCommand.d.ts +8 -5
- package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +17 -11
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +2 -2
- package/dist-types/commands/CreateGatewayCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +4 -4
- package/dist-types/commands/DeleteGatewayCommand.d.ts +4 -0
- package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +4 -2
- package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +3 -1
- package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGatewayCommand.d.ts +4 -1
- package/dist-types/commands/ExecuteQueryCommand.d.ts +2 -1
- package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +2 -1
- package/dist-types/commands/ListGatewaysCommand.d.ts +4 -1
- package/dist-types/commands/ListTimeSeriesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAssetModelCommand.d.ts +14 -6
- package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +13 -9
- package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +116 -124
- package/dist-types/models/models_1.d.ts +32 -11
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +2 -2
- package/dist-types/ts3.4/commands/ListTimeSeriesCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +5 -4
- package/dist-types/ts3.4/models/models_1.d.ts +5 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +17 -17
package/dist-cjs/index.js
CHANGED
|
@@ -306,19 +306,19 @@ var _IoTSiteWiseClient = class _IoTSiteWiseClient extends import_smithy_client.C
|
|
|
306
306
|
const _config_1 = resolveClientEndpointParameters(_config_0);
|
|
307
307
|
const _config_2 = (0, import_config_resolver.resolveRegionConfig)(_config_1);
|
|
308
308
|
const _config_3 = (0, import_middleware_endpoint.resolveEndpointConfig)(_config_2);
|
|
309
|
-
const _config_4 = (0,
|
|
310
|
-
const _config_5 = (0,
|
|
311
|
-
const _config_6 = (0,
|
|
309
|
+
const _config_4 = (0, import_middleware_host_header.resolveHostHeaderConfig)(_config_3);
|
|
310
|
+
const _config_5 = (0, import_middleware_user_agent.resolveUserAgentConfig)(_config_4);
|
|
311
|
+
const _config_6 = (0, import_middleware_retry.resolveRetryConfig)(_config_5);
|
|
312
312
|
const _config_7 = (0, import_httpAuthSchemeProvider.resolveHttpAuthSchemeConfig)(_config_6);
|
|
313
313
|
const _config_8 = resolveRuntimeExtensions(_config_7, (configuration == null ? void 0 : configuration.extensions) || []);
|
|
314
314
|
super(_config_8);
|
|
315
315
|
this.config = _config_8;
|
|
316
|
-
this.middlewareStack.use((0, import_middleware_retry.getRetryPlugin)(this.config));
|
|
317
|
-
this.middlewareStack.use((0, import_middleware_content_length.getContentLengthPlugin)(this.config));
|
|
318
316
|
this.middlewareStack.use((0, import_middleware_host_header.getHostHeaderPlugin)(this.config));
|
|
319
317
|
this.middlewareStack.use((0, import_middleware_logger.getLoggerPlugin)(this.config));
|
|
320
318
|
this.middlewareStack.use((0, import_middleware_recursion_detection.getRecursionDetectionPlugin)(this.config));
|
|
321
319
|
this.middlewareStack.use((0, import_middleware_user_agent.getUserAgentPlugin)(this.config));
|
|
320
|
+
this.middlewareStack.use((0, import_middleware_retry.getRetryPlugin)(this.config));
|
|
321
|
+
this.middlewareStack.use((0, import_middleware_content_length.getContentLengthPlugin)(this.config));
|
|
322
322
|
this.middlewareStack.use(
|
|
323
323
|
(0, import_core.getHttpAuthSchemeEndpointRuleSetPlugin)(this.config, {
|
|
324
324
|
httpAuthSchemeParametersProvider: this.getDefaultHttpAuthSchemeParametersProvider(),
|
|
@@ -685,6 +685,7 @@ var EncryptionType = {
|
|
|
685
685
|
};
|
|
686
686
|
var CapabilitySyncStatus = {
|
|
687
687
|
IN_SYNC: "IN_SYNC",
|
|
688
|
+
NOT_APPLICABLE: "NOT_APPLICABLE",
|
|
688
689
|
OUT_OF_SYNC: "OUT_OF_SYNC",
|
|
689
690
|
SYNC_FAILED: "SYNC_FAILED",
|
|
690
691
|
UNKNOWN: "UNKNOWN"
|
|
@@ -19,19 +19,19 @@ export class IoTSiteWiseClient extends __Client {
|
|
|
19
19
|
const _config_1 = resolveClientEndpointParameters(_config_0);
|
|
20
20
|
const _config_2 = resolveRegionConfig(_config_1);
|
|
21
21
|
const _config_3 = resolveEndpointConfig(_config_2);
|
|
22
|
-
const _config_4 =
|
|
23
|
-
const _config_5 =
|
|
24
|
-
const _config_6 =
|
|
22
|
+
const _config_4 = resolveHostHeaderConfig(_config_3);
|
|
23
|
+
const _config_5 = resolveUserAgentConfig(_config_4);
|
|
24
|
+
const _config_6 = resolveRetryConfig(_config_5);
|
|
25
25
|
const _config_7 = resolveHttpAuthSchemeConfig(_config_6);
|
|
26
26
|
const _config_8 = resolveRuntimeExtensions(_config_7, configuration?.extensions || []);
|
|
27
27
|
super(_config_8);
|
|
28
28
|
this.config = _config_8;
|
|
29
|
-
this.middlewareStack.use(getRetryPlugin(this.config));
|
|
30
|
-
this.middlewareStack.use(getContentLengthPlugin(this.config));
|
|
31
29
|
this.middlewareStack.use(getHostHeaderPlugin(this.config));
|
|
32
30
|
this.middlewareStack.use(getLoggerPlugin(this.config));
|
|
33
31
|
this.middlewareStack.use(getRecursionDetectionPlugin(this.config));
|
|
34
32
|
this.middlewareStack.use(getUserAgentPlugin(this.config));
|
|
33
|
+
this.middlewareStack.use(getRetryPlugin(this.config));
|
|
34
|
+
this.middlewareStack.use(getContentLengthPlugin(this.config));
|
|
35
35
|
this.middlewareStack.use(getHttpAuthSchemeEndpointRuleSetPlugin(this.config, {
|
|
36
36
|
httpAuthSchemeParametersProvider: this.getDefaultHttpAuthSchemeParametersProvider(),
|
|
37
37
|
identityProviderConfigProvider: this.getIdentityProviderConfigProvider(),
|
|
@@ -215,7 +215,7 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
|
|
|
215
215
|
/**
|
|
216
216
|
* @public
|
|
217
217
|
*/
|
|
218
|
-
export type IoTSiteWiseClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> &
|
|
218
|
+
export type IoTSiteWiseClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & HostHeaderInputConfig & UserAgentInputConfig & RetryInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
|
|
219
219
|
/**
|
|
220
220
|
* @public
|
|
221
221
|
*
|
|
@@ -226,7 +226,7 @@ export interface IoTSiteWiseClientConfig extends IoTSiteWiseClientConfigType {
|
|
|
226
226
|
/**
|
|
227
227
|
* @public
|
|
228
228
|
*/
|
|
229
|
-
export type IoTSiteWiseClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> &
|
|
229
|
+
export type IoTSiteWiseClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & HostHeaderResolvedConfig & UserAgentResolvedConfig & RetryResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
|
|
230
230
|
/**
|
|
231
231
|
* @public
|
|
232
232
|
*
|
|
@@ -32,17 +32,20 @@ declare const CreateAssetModelCommand_base: {
|
|
|
32
32
|
* that have standardized definitions. Each asset created from a model inherits the asset model's
|
|
33
33
|
* property and hierarchy definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html">Defining asset models</a> in the
|
|
34
34
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
35
|
-
* <p>You can create two types of asset models, <code>ASSET_MODEL</code> or
|
|
35
|
+
* <p>You can create two types of asset models, <code>ASSET_MODEL</code> or
|
|
36
|
+
* <code>COMPONENT_MODEL</code>.</p>
|
|
36
37
|
* <ul>
|
|
37
38
|
* <li>
|
|
38
39
|
* <p>
|
|
39
|
-
* <b>ASSET_MODEL</b> – (default) An asset model that
|
|
40
|
-
*
|
|
40
|
+
* <b>ASSET_MODEL</b> – (default) An asset model that
|
|
41
|
+
* you can use to create assets. Can't be included as a component in another asset
|
|
42
|
+
* model.</p>
|
|
41
43
|
* </li>
|
|
42
44
|
* <li>
|
|
43
45
|
* <p>
|
|
44
|
-
* <b>COMPONENT_MODEL</b> – A reusable component that
|
|
45
|
-
*
|
|
46
|
+
* <b>COMPONENT_MODEL</b> – A reusable component that
|
|
47
|
+
* you can include in the composite models of other asset models. You can't create
|
|
48
|
+
* assets directly from this type of asset model. </p>
|
|
46
49
|
* </li>
|
|
47
50
|
* </ul>
|
|
48
51
|
* @example
|
|
@@ -27,17 +27,23 @@ declare const CreateAssetModelCompositeModelCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a custom composite model from specified property and hierarchy definitions. There
|
|
31
|
-
* <code>inline</code> and
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* component
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* <p>
|
|
40
|
-
*
|
|
30
|
+
* <p>Creates a custom composite model from specified property and hierarchy definitions. There
|
|
31
|
+
* are two types of custom composite models, <code>inline</code> and
|
|
32
|
+
* <code>component-model-based</code>. </p>
|
|
33
|
+
* <p>Use component-model-based custom composite models to define standard, reusable components.
|
|
34
|
+
* A component-model-based custom composite model consists of a name, a description, and the ID
|
|
35
|
+
* of the component model it references. A component-model-based custom composite model has no
|
|
36
|
+
* properties of its own; its referenced component model provides its associated properties to
|
|
37
|
+
* any created assets. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html">Custom composite models (Components)</a>
|
|
38
|
+
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
39
|
+
* <p>Use inline custom composite models to organize the properties of an asset model. The
|
|
40
|
+
* properties of inline custom composite models are local to the asset model where they are
|
|
41
|
+
* included and can't be used to create multiple assets.</p>
|
|
42
|
+
* <p>To create a component-model-based model, specify the <code>composedAssetModelId</code> of
|
|
43
|
+
* an existing asset model with <code>assetModelType</code> of
|
|
44
|
+
* <code>COMPONENT_MODEL</code>.</p>
|
|
45
|
+
* <p>To create an inline model, specify the <code>assetModelCompositeModelProperties</code> and
|
|
46
|
+
* don't include an <code>composedAssetModelId</code>.</p>
|
|
41
47
|
* @example
|
|
42
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
49
|
* ```javascript
|
|
@@ -32,8 +32,8 @@ declare const CreateBulkImportJobCommand_base: {
|
|
|
32
32
|
* <important>
|
|
33
33
|
* <p>Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.
|
|
34
34
|
* 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>
|
|
35
|
-
* <p>Bulk import is designed to store historical data to IoT SiteWise. It does not trigger
|
|
36
|
-
* IoT SiteWise warm or cold tier storage.</p>
|
|
35
|
+
* <p>Bulk import is designed to store historical data to IoT SiteWise. It does not trigger
|
|
36
|
+
* computations or notifications on IoT SiteWise warm or cold tier storage.</p>
|
|
37
37
|
* </important>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -45,6 +45,9 @@ declare const CreateGatewayCommand_base: {
|
|
|
45
45
|
* greengrassV2: { // GreengrassV2
|
|
46
46
|
* coreDeviceThingName: "STRING_VALUE", // required
|
|
47
47
|
* },
|
|
48
|
+
* siemensIE: { // SiemensIE
|
|
49
|
+
* iotCoreThingName: "STRING_VALUE", // required
|
|
50
|
+
* },
|
|
48
51
|
* },
|
|
49
52
|
* tags: { // TagMap
|
|
50
53
|
* "<keys>": "STRING_VALUE",
|
|
@@ -28,10 +28,10 @@ declare const DeleteAssetModelCompositeModelCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Deletes a composite model. This action can't be undone. You must delete all assets created
|
|
31
|
-
* from a
|
|
32
|
-
* a parent asset model exists that contains a property formula expression that depends
|
|
33
|
-
* 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
|
|
34
|
-
*
|
|
31
|
+
* from a composite model before you can delete the model. Also, you can't delete a composite
|
|
32
|
+
* model if a parent asset model exists that contains a property formula expression that depends
|
|
33
|
+
* on the 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
|
|
34
|
+
* models</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -50,6 +50,10 @@ declare const DeleteGatewayCommand_base: {
|
|
|
50
50
|
* @see {@link DeleteGatewayCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
54
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
55
|
+
* than one operation on the same resource at the same time.</p>
|
|
56
|
+
*
|
|
53
57
|
* @throws {@link InternalFailureException} (server fault)
|
|
54
58
|
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
55
59
|
*
|
|
@@ -27,8 +27,10 @@ declare const DescribeAssetCompositeModelCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves information about an asset composite model (also known as an asset component).
|
|
31
|
-
* <
|
|
30
|
+
* <p>Retrieves information about an asset composite model (also known as an asset component).
|
|
31
|
+
* An <code>AssetCompositeModel</code> is an instance of an
|
|
32
|
+
* <code>AssetModelCompositeModel</code>. If you want to see information about the model this is
|
|
33
|
+
* based on, call <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html">DescribeAssetModelCompositeModel</a>.</p>
|
|
32
34
|
* @example
|
|
33
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
36
|
* ```javascript
|
|
@@ -27,7 +27,9 @@ declare const DescribeAssetModelCompositeModelCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves information about an asset model composite model (also known as an asset model
|
|
30
|
+
* <p>Retrieves information about an asset model composite model (also known as an asset model
|
|
31
|
+
* component). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html">Custom composite models
|
|
32
|
+
* (Components)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
31
33
|
* @example
|
|
32
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
35
|
* ```javascript
|
|
@@ -48,7 +48,7 @@ declare const DescribeGatewayCapabilityConfigurationCommand_base: {
|
|
|
48
48
|
* // gatewayId: "STRING_VALUE", // required
|
|
49
49
|
* // capabilityNamespace: "STRING_VALUE", // required
|
|
50
50
|
* // capabilityConfiguration: "STRING_VALUE", // required
|
|
51
|
-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
|
|
51
|
+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
|
|
52
52
|
* // };
|
|
53
53
|
*
|
|
54
54
|
* ```
|
|
@@ -50,11 +50,14 @@ declare const DescribeGatewayCommand_base: {
|
|
|
50
50
|
* // greengrassV2: { // GreengrassV2
|
|
51
51
|
* // coreDeviceThingName: "STRING_VALUE", // required
|
|
52
52
|
* // },
|
|
53
|
+
* // siemensIE: { // SiemensIE
|
|
54
|
+
* // iotCoreThingName: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
53
56
|
* // },
|
|
54
57
|
* // gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries // required
|
|
55
58
|
* // { // GatewayCapabilitySummary
|
|
56
59
|
* // capabilityNamespace: "STRING_VALUE", // required
|
|
57
|
-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
|
|
60
|
+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
|
|
58
61
|
* // },
|
|
59
62
|
* // ],
|
|
60
63
|
* // creationDate: new Date("TIMESTAMP"), // required
|
|
@@ -28,7 +28,8 @@ declare const ExecuteQueryCommand_base: {
|
|
|
28
28
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
29
|
};
|
|
30
30
|
/**
|
|
31
|
-
* <p>Run SQL queries to retrieve metadata and time-series data from asset models, assets,
|
|
31
|
+
* <p>Run SQL queries to retrieve metadata and time-series data from asset models, assets,
|
|
32
|
+
* measurements, metrics, transforms, and aggregates.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ declare const ListCompositionRelationshipsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a paginated list of composition relationships for an asset model of type
|
|
30
|
+
* <p>Retrieves a paginated list of composition relationships for an asset model of type
|
|
31
|
+
* <code>COMPONENT_MODEL</code>.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -52,11 +52,14 @@ declare const ListGatewaysCommand_base: {
|
|
|
52
52
|
* // greengrassV2: { // GreengrassV2
|
|
53
53
|
* // coreDeviceThingName: "STRING_VALUE", // required
|
|
54
54
|
* // },
|
|
55
|
+
* // siemensIE: { // SiemensIE
|
|
56
|
+
* // iotCoreThingName: "STRING_VALUE", // required
|
|
57
|
+
* // },
|
|
55
58
|
* // },
|
|
56
59
|
* // gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries
|
|
57
60
|
* // { // GatewayCapabilitySummary
|
|
58
61
|
* // capabilityNamespace: "STRING_VALUE", // required
|
|
59
|
-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
|
|
62
|
+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
|
|
60
63
|
* // },
|
|
61
64
|
* // ],
|
|
62
65
|
* // creationDate: new Date("TIMESTAMP"), // required
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
-
import { ListTimeSeriesRequest
|
|
4
|
+
import { ListTimeSeriesRequest } from "../models/models_0";
|
|
5
|
+
import { ListTimeSeriesResponse } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -32,13 +32,21 @@ declare const UpdateAssetModelCommand_base: {
|
|
|
32
32
|
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the
|
|
33
33
|
* <i>IoT SiteWise User Guide</i>.</p>
|
|
34
34
|
* <important>
|
|
35
|
-
* <p>This operation overwrites the existing model with the provided model. To avoid deleting
|
|
36
|
-
* your asset model's properties or hierarchies, you must include their IDs and definitions in
|
|
37
|
-
* the updated asset model payload. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a>.</p>
|
|
38
35
|
* <p>If you remove a property from an asset model, IoT SiteWise deletes all previous data for that
|
|
39
|
-
* property.
|
|
40
|
-
*
|
|
41
|
-
*
|
|
36
|
+
* property. You can’t change the type or data type of an existing property.</p>
|
|
37
|
+
* <p>To replace an existing asset model property with a new one with the same
|
|
38
|
+
* <code>name</code>, do the following:</p>
|
|
39
|
+
* <ol>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>Submit an <code>UpdateAssetModel</code> request with the entire existing property
|
|
42
|
+
* removed.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>Submit a second <code>UpdateAssetModel</code> request that includes the new
|
|
46
|
+
* property. The new asset property will have the same <code>name</code> as the previous
|
|
47
|
+
* one and IoT SiteWise will generate a new unique <code>id</code>.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ol>
|
|
42
50
|
* </important>
|
|
43
51
|
* @example
|
|
44
52
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,20 +27,24 @@ declare const UpdateAssetModelCompositeModelCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates a composite model and all of the assets that were created from the model. Each
|
|
31
|
-
* created from the model inherits the updated asset model's property and hierarchy
|
|
32
|
-
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the
|
|
33
|
-
*
|
|
30
|
+
* <p>Updates a composite model and all of the assets that were created from the model. Each
|
|
31
|
+
* asset created from the model inherits the updated asset model's property and hierarchy
|
|
32
|
+
* definitions. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the
|
|
33
|
+
* <i>IoT SiteWise User Guide</i>.</p>
|
|
34
34
|
* <important>
|
|
35
|
-
* <p>If you remove a property from a composite asset model, IoT SiteWise deletes all previous data
|
|
36
|
-
*
|
|
35
|
+
* <p>If you remove a property from a composite asset model, IoT SiteWise deletes all previous data
|
|
36
|
+
* for that property. You can’t change the type or data type of an existing property.</p>
|
|
37
|
+
* <p>To replace an existing composite asset model property with a new one with the same
|
|
38
|
+
* <code>name</code>, do the following:</p>
|
|
37
39
|
* <ol>
|
|
38
40
|
* <li>
|
|
39
|
-
* <p>Submit an <code>UpdateAssetModelCompositeModel</code> request with the entire
|
|
41
|
+
* <p>Submit an <code>UpdateAssetModelCompositeModel</code> request with the entire
|
|
42
|
+
* existing property removed.</p>
|
|
40
43
|
* </li>
|
|
41
44
|
* <li>
|
|
42
|
-
* <p>Submit a second <code>UpdateAssetModelCompositeModel</code> request that includes
|
|
43
|
-
*
|
|
45
|
+
* <p>Submit a second <code>UpdateAssetModelCompositeModel</code> request that includes
|
|
46
|
+
* the new property. The new asset property will have the same <code>name</code> as the
|
|
47
|
+
* previous one and IoT SiteWise will generate a new unique <code>id</code>.</p>
|
|
44
48
|
* </li>
|
|
45
49
|
* </ol>
|
|
46
50
|
* </important>
|
|
@@ -47,7 +47,7 @@ declare const UpdateGatewayCapabilityConfigurationCommand_base: {
|
|
|
47
47
|
* const response = await client.send(command);
|
|
48
48
|
* // { // UpdateGatewayCapabilityConfigurationResponse
|
|
49
49
|
* // capabilityNamespace: "STRING_VALUE", // required
|
|
50
|
-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
|
|
50
|
+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
|
|
51
51
|
* // };
|
|
52
52
|
*
|
|
53
53
|
* ```
|