@aws-sdk/client-iotsitewise 3.616.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.
Files changed (25) hide show
  1. package/dist-cjs/index.js +1 -0
  2. package/dist-es/models/models_0.js +1 -0
  3. package/dist-types/commands/CreateAssetModelCommand.d.ts +8 -5
  4. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +17 -11
  5. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +2 -2
  6. package/dist-types/commands/CreateGatewayCommand.d.ts +3 -0
  7. package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +4 -4
  8. package/dist-types/commands/DeleteGatewayCommand.d.ts +4 -0
  9. package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +4 -2
  10. package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +3 -1
  11. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +1 -1
  12. package/dist-types/commands/DescribeGatewayCommand.d.ts +4 -1
  13. package/dist-types/commands/ExecuteQueryCommand.d.ts +2 -1
  14. package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +2 -1
  15. package/dist-types/commands/ListGatewaysCommand.d.ts +4 -1
  16. package/dist-types/commands/ListTimeSeriesCommand.d.ts +2 -1
  17. package/dist-types/commands/UpdateAssetModelCommand.d.ts +14 -6
  18. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +13 -9
  19. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
  20. package/dist-types/models/models_0.d.ts +116 -124
  21. package/dist-types/models/models_1.d.ts +32 -11
  22. package/dist-types/ts3.4/commands/ListTimeSeriesCommand.d.ts +2 -4
  23. package/dist-types/ts3.4/models/models_0.d.ts +5 -4
  24. package/dist-types/ts3.4/models/models_1.d.ts +5 -0
  25. package/package.json +1 -1
package/dist-cjs/index.js CHANGED
@@ -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"
@@ -262,6 +262,7 @@ export const EncryptionType = {
262
262
  };
263
263
  export const CapabilitySyncStatus = {
264
264
  IN_SYNC: "IN_SYNC",
265
+ NOT_APPLICABLE: "NOT_APPLICABLE",
265
266
  OUT_OF_SYNC: "OUT_OF_SYNC",
266
267
  SYNC_FAILED: "SYNC_FAILED",
267
268
  UNKNOWN: "UNKNOWN",
@@ -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 <code>COMPONENT_MODEL</code>.</p>
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 you can use to create assets.
40
- * Can't be included as a component in another asset model.</p>
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 you can include in the composite
45
- * models of other asset models. You can't create assets directly from this type of asset model. </p>
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 are two types of custom composite models,
31
- * <code>inline</code> and <code>component-model-based</code>. </p>
32
- * <p>Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name,
33
- * a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced
34
- * component model provides its associated properties to any created assets. For more information, see
35
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html">Custom composite models (Components)</a> in the
36
- * <i>IoT SiteWise User Guide</i>.</p>
37
- * <p>Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are
38
- * included and can't be used to create multiple assets.</p>
39
- * <p>To create a component-model-based model, specify the <code>composedAssetModelId</code> of an existing asset model with <code>assetModelType</code> of <code>COMPONENT_MODEL</code>.</p>
40
- * <p>To create an inline model, specify the <code>assetModelCompositeModelProperties</code> and don't include an <code>composedAssetModelId</code>.</p>
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 computations or notifications on
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 composite model before you can delete the model. Also, you can't delete a composite model if
32
- * a parent asset model exists that contains a property formula expression that depends on the
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 models</a> in the
34
- * <i>IoT SiteWise User Guide</i>.</p>
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). 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
31
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html">DescribeAssetModelCompositeModel</a>.</p>
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 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>
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, measurements, metrics, transforms, and aggregates.</p>
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 <code>COMPONENT_MODEL</code>.</p>
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, ListTimeSeriesResponse } from "../models/models_0";
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. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every
40
- * asset associated with that hierarchy. You can't change the type or data type of an existing
41
- * property.</p>
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 asset
31
- * created from the model inherits the updated asset model's property and hierarchy definitions.
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
- * <i>IoT SiteWise User Guide</i>.</p>
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 for that property. You can’t change the type or data type of an existing property.</p>
36
- * <p>To replace an existing composite asset model property with a new one with the same <code>name</code>, do the following:</p>
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 existing property removed.</p>
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 the new property. The new asset property will have the same
43
- * <code>name</code> as the previous one and IoT SiteWise will generate a new unique <code>id</code>.</p>
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
  * ```
@@ -67,8 +67,8 @@ export interface UserIdentity {
67
67
  /**
68
68
  * <p>Contains an identity that can access an IoT SiteWise Monitor resource.</p>
69
69
  * <note>
70
- * <p>Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the
71
- * IAM Identity Center identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">IAM Identity Center console</a>.</p>
70
+ * <p>Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can
71
+ * find the IAM Identity Center identity IDs in the URL of user and group pages in the <a href="https://console.aws.amazon.com/singlesignon">IAM Identity Center console</a>.</p>
72
72
  * </note>
73
73
  * @public
74
74
  */
@@ -497,9 +497,7 @@ export interface AssetCompositeModel {
497
497
  */
498
498
  properties: AssetProperty[] | undefined;
499
499
  /**
500
- * <p>
501
- * The ID of the asset composite model.
502
- * </p>
500
+ * <p> The ID of the asset composite model. </p>
503
501
  * @public
504
502
  */
505
503
  id?: string;
@@ -537,8 +535,10 @@ export interface AssetCompositeModelSummary {
537
535
  id: string | undefined;
538
536
  /**
539
537
  * <p>An external ID to assign to the asset model.</p>
540
- * <p>If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using
541
- * <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p>
538
+ * <p>If the composite model is a derived composite model, or one nested inside a component
539
+ * model, you can only set the external ID using <code>UpdateAssetModelCompositeModel</code> and
540
+ * specifying the derived ID of the model or property from the created model it's a part
541
+ * of.</p>
542
542
  * @public
543
543
  */
544
544
  externalId?: string;
@@ -624,9 +624,9 @@ export interface AssetHierarchy {
624
624
  */
625
625
  name: string | undefined;
626
626
  /**
627
- * <p>The external ID of the hierarchy, if it has one. When you update an asset hierarchy,
628
- * you may assign an external ID if it doesn't already have one. You can't change the external ID
629
- * of an asset hierarchy that already has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
627
+ * <p>The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you
628
+ * may assign an external ID if it doesn't already have one. You can't change the external ID of
629
+ * an asset hierarchy that already has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
630
630
  * @public
631
631
  */
632
632
  externalId?: string;
@@ -762,14 +762,14 @@ export interface VariableValue {
762
762
  /**
763
763
  * <p>The ID of the property to use as the variable. You can use the property <code>name</code>
764
764
  * if it's from the same asset model. If the property has an external ID, you can specify
765
- * <code>externalId:</code> followed by the external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
765
+ * <code>externalId:</code> followed by the external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
766
766
  * @public
767
767
  */
768
768
  propertyId?: string;
769
769
  /**
770
770
  * <p>The ID of the hierarchy to query for the property ID. You can use the hierarchy's name
771
- * instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify
772
- * <code>externalId:</code> followed by the external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
771
+ * instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify
772
+ * <code>externalId:</code> followed by the external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
773
773
  * <p>You use a hierarchy ID instead of a model ID because you can have several hierarchies
774
774
  * using the same model and therefore the same <code>propertyId</code>. For example, you might
775
775
  * have separately grouped assets that come from the same asset model. For more information, see
@@ -1032,15 +1032,15 @@ export interface AssetModelProperty {
1032
1032
  * <p>The ID of the asset model property.</p>
1033
1033
  * <ul>
1034
1034
  * <li>
1035
- * <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
1036
- * to create a <i>new</i> property: You can specify its ID here, if desired.
1037
- * IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
1035
+ * <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> to create a
1036
+ * <i>new</i> property: You can specify its ID here, if desired.
1037
+ * IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
1038
1038
  * However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
1039
1039
  * If you specify your own ID, it must be globally unique.</p>
1040
1040
  * </li>
1041
1041
  * <li>
1042
1042
  * <p>If you are calling UpdateAssetModel to modify an <i>existing</i>
1043
- * property: This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1043
+ * property: This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1044
1044
  * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1045
1045
  * </li>
1046
1046
  * </ul>
@@ -1115,9 +1115,7 @@ export interface AssetModelCompositeModel {
1115
1115
  */
1116
1116
  properties?: AssetModelProperty[];
1117
1117
  /**
1118
- * <p>
1119
- * The ID of the asset model composite model.
1120
- * </p>
1118
+ * <p> The ID of the asset model composite model. </p>
1121
1119
  * @public
1122
1120
  */
1123
1121
  id?: string;
@@ -1243,7 +1241,7 @@ export interface AssetModelCompositeModelPathSegment {
1243
1241
  */
1244
1242
  export interface AssetModelCompositeModelSummary {
1245
1243
  /**
1246
- * <p>The ID of the the composite model that this summary describes..</p>
1244
+ * <p>The ID of the composite model that this summary describes..</p>
1247
1245
  * @public
1248
1246
  */
1249
1247
  id: string | undefined;
@@ -1253,29 +1251,17 @@ export interface AssetModelCompositeModelSummary {
1253
1251
  */
1254
1252
  externalId?: string;
1255
1253
  /**
1256
- * <p>The name of the the composite model that this summary describes..</p>
1254
+ * <p>The name of the composite model that this summary describes..</p>
1257
1255
  * @public
1258
1256
  */
1259
1257
  name: string | undefined;
1260
1258
  /**
1261
- * <p>The type of asset model.</p>
1262
- * <ul>
1263
- * <li>
1264
- * <p>
1265
- * <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
1266
- * Can't be included as a component in another asset model.</p>
1267
- * </li>
1268
- * <li>
1269
- * <p>
1270
- * <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
1271
- * models of other asset models. You can't create assets directly from this type of asset model. </p>
1272
- * </li>
1273
- * </ul>
1259
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
1274
1260
  * @public
1275
1261
  */
1276
1262
  type: string | undefined;
1277
1263
  /**
1278
- * <p>The description of the the composite model that this summary describes..</p>
1264
+ * <p>The description of the composite model that this summary describes..</p>
1279
1265
  * @public
1280
1266
  */
1281
1267
  description?: string;
@@ -1295,8 +1281,8 @@ export interface AssetModelHierarchy {
1295
1281
  * <p>The ID of the asset model hierarchy. This ID is a <code>hierarchyId</code>.</p>
1296
1282
  * <ul>
1297
1283
  * <li>
1298
- * <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>
1299
- * to create a <i>new</i> hierarchy: You can specify its ID here, if desired.
1284
+ * <p>If you are callling <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a> to create a
1285
+ * <i>new</i> hierarchy: You can specify its ID here, if desired.
1300
1286
  * IoT SiteWise automatically generates a unique ID for you, so this parameter is never required.
1301
1287
  * However, if you prefer to supply your own ID instead, you can specify it here in UUID format.
1302
1288
  * If you specify your own ID, it must be globally unique.</p>
@@ -1318,7 +1304,7 @@ export interface AssetModelHierarchy {
1318
1304
  name: string | undefined;
1319
1305
  /**
1320
1306
  * <p>The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the
1321
- * <code>childAssetModelId</code> asset model. IoT SiteWise will always return the actual
1307
+ * <code>childAssetModelId</code> asset model. IoT SiteWise will always return the actual
1322
1308
  * asset model ID for this value. However, when you are specifying this value as part of a call to
1323
1309
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html">UpdateAssetModel</a>, you may provide either the asset model ID or else <code>externalId:</code>
1324
1310
  * followed by the asset model's external ID. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.
@@ -1360,8 +1346,8 @@ export interface AssetModelHierarchyDefinition {
1360
1346
  */
1361
1347
  id?: string;
1362
1348
  /**
1363
- * <p>An external ID to assign to the asset model hierarchy. The external ID must be unique among
1364
- * asset model hierarchies within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1349
+ * <p>An external ID to assign to the asset model hierarchy. The external ID must be unique
1350
+ * among asset model hierarchies within this asset model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1365
1351
  * @public
1366
1352
  */
1367
1353
  externalId?: string;
@@ -1404,9 +1390,7 @@ export interface AssetModelPropertySummary {
1404
1390
  */
1405
1391
  type: PropertyType | undefined;
1406
1392
  /**
1407
- * <p>
1408
- * The ID of the composite model that contains the asset model property.
1409
- * </p>
1393
+ * <p> The ID of the composite model that contains the asset model property. </p>
1410
1394
  * @public
1411
1395
  */
1412
1396
  assetModelCompositeModelId?: string;
@@ -1612,9 +1596,7 @@ export interface AssetPropertySummary {
1612
1596
  */
1613
1597
  alias?: string;
1614
1598
  /**
1615
- * <p>
1616
- * The unit of measure (such as Newtons or RPM) of the asset property.
1617
- * </p>
1599
+ * <p> The unit of measure (such as Newtons or RPM) of the asset property. </p>
1618
1600
  * @public
1619
1601
  */
1620
1602
  unit?: string;
@@ -1625,9 +1607,7 @@ export interface AssetPropertySummary {
1625
1607
  */
1626
1608
  notification?: PropertyNotification;
1627
1609
  /**
1628
- * <p>
1629
- * The ID of the composite model that contains the asset property.
1630
- * </p>
1610
+ * <p> The ID of the composite model that contains the asset property. </p>
1631
1611
  * @public
1632
1612
  */
1633
1613
  assetCompositeModelId?: string;
@@ -1670,7 +1650,7 @@ export interface Variant {
1670
1650
  */
1671
1651
  stringValue?: string;
1672
1652
  /**
1673
- * <p>Asset property data of type integer (number that's greater than or equal to zero).</p>
1653
+ * <p>Asset property data of type integer (whole number).</p>
1674
1654
  * @public
1675
1655
  */
1676
1656
  integerValue?: number;
@@ -1848,9 +1828,9 @@ export interface AssociateAssetsRequest {
1848
1828
  assetId: string | undefined;
1849
1829
  /**
1850
1830
  * <p>The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1851
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) Hierarchies allow different groupings
1852
- * of assets to be formed that all come from the same asset model. For more information, see
1853
- * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
1831
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) Hierarchies allow
1832
+ * different groupings of assets to be formed that all come from the same asset model. For more
1833
+ * information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
1854
1834
  * @public
1855
1835
  */
1856
1836
  hierarchyId: string | undefined;
@@ -2244,7 +2224,7 @@ export interface BatchGetAssetPropertyAggregatesRequest {
2244
2224
  * </li>
2245
2225
  * <li>
2246
2226
  * <p>The number of data points in the result set is equal to the value of
2247
- * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</p>
2227
+ * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 4000.</p>
2248
2228
  * </li>
2249
2229
  * </ul>
2250
2230
  * @public
@@ -3018,7 +2998,7 @@ export interface CreateAssetResponse {
3018
2998
  */
3019
2999
  export interface CreateAssetModelRequest {
3020
3000
  /**
3021
- * <p>A unique, friendly name for the asset model.</p>
3001
+ * <p>A unique name for the asset model.</p>
3022
3002
  * @public
3023
3003
  */
3024
3004
  assetModelName: string | undefined;
@@ -3051,7 +3031,8 @@ export interface CreateAssetModelRequest {
3051
3031
  * properties that the composite model supports. Use composite models to define alarms on this asset model.</p>
3052
3032
  * <note>
3053
3033
  * <p>When creating custom composite models, you need to use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">CreateAssetModelCompositeModel</a>. For more information,
3054
- * see <LINK>.</p>
3034
+ * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html">Creating custom composite models (Components)</a> in the
3035
+ * <i>IoT SiteWise User Guide</i>.</p>
3055
3036
  * </note>
3056
3037
  * @public
3057
3038
  */
@@ -3138,14 +3119,17 @@ export interface CreateAssetModelCompositeModelRequest {
3138
3119
  parentAssetModelCompositeModelId?: string;
3139
3120
  /**
3140
3121
  * <p>An external ID to assign to the composite model.</p>
3141
- * <p>If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using
3142
- * <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p>
3122
+ * <p>If the composite model is a derived composite model, or one nested inside a component
3123
+ * model, you can only set the external ID using <code>UpdateAssetModelCompositeModel</code> and
3124
+ * specifying the derived ID of the model or property from the created model it's a part
3125
+ * of.</p>
3143
3126
  * @public
3144
3127
  */
3145
3128
  assetModelCompositeModelExternalId?: string;
3146
3129
  /**
3147
- * <p>The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However,
3148
- * if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.</p>
3130
+ * <p>The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this
3131
+ * parameter is never required. However, if you prefer to supply your own ID instead, you can
3132
+ * specify it here in UUID format. If you specify your own ID, it must be globally unique.</p>
3149
3133
  * @public
3150
3134
  */
3151
3135
  assetModelCompositeModelId?: string;
@@ -3155,7 +3139,7 @@ export interface CreateAssetModelCompositeModelRequest {
3155
3139
  */
3156
3140
  assetModelCompositeModelDescription?: string;
3157
3141
  /**
3158
- * <p>A unique, friendly name for the composite model.</p>
3142
+ * <p>A unique name for the composite model.</p>
3159
3143
  * @public
3160
3144
  */
3161
3145
  assetModelCompositeModelName: string | undefined;
@@ -3170,12 +3154,13 @@ export interface CreateAssetModelCompositeModelRequest {
3170
3154
  */
3171
3155
  clientToken?: string;
3172
3156
  /**
3173
- * <p>The ID of a composite model on this asset.</p>
3157
+ * <p>The ID of a component model which is reused to create this composite model.</p>
3174
3158
  * @public
3175
3159
  */
3176
3160
  composedAssetModelId?: string;
3177
3161
  /**
3178
- * <p>The property definitions of the composite model. For more information, see <LINK>.</p>
3162
+ * <p>The property definitions of the composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models">
3163
+ * Inline custom composite models</a> in the <i>IoT SiteWise User Guide</i>.</p>
3179
3164
  * <p>You can specify up to 200 properties per composite model. For more
3180
3165
  * 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>
3181
3166
  * @public
@@ -3187,7 +3172,8 @@ export interface CreateAssetModelCompositeModelRequest {
3187
3172
  */
3188
3173
  export interface CreateAssetModelCompositeModelResponse {
3189
3174
  /**
3190
- * <p>The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.</p>
3175
+ * <p>The ID of the composed asset model. You can use this ID when you call other IoT SiteWise
3176
+ * APIs.</p>
3191
3177
  * @public
3192
3178
  */
3193
3179
  assetModelCompositeModelId: string | undefined;
@@ -3479,15 +3465,15 @@ export interface CreateDashboardResponse {
3479
3465
  export interface Greengrass {
3480
3466
  /**
3481
3467
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Greengrass group. For more information about how to find a group's
3482
- * ARN, see <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html">GetGroup</a> in the
3483
- * <i>IoT Greengrass API Reference</i>.</p>
3468
+ * ARN, see <a href="https://docs.aws.amazon.com/greengrass/v1/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/v1/apireference/getgroup-get.html">GetGroup</a> in the <i>IoT Greengrass V1
3469
+ * API Reference</i>.</p>
3484
3470
  * @public
3485
3471
  */
3486
3472
  groupArn: string | undefined;
3487
3473
  }
3488
3474
  /**
3489
- * <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass
3490
- * V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass
3475
+ * <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2,
3476
+ * you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass
3491
3477
  * device role</a> must use the <code>AWSIoTSiteWiseEdgeAccess</code> policy. For more
3492
3478
  * information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html">Using IoT SiteWise at the edge</a> in the
3493
3479
  * <i>IoT SiteWise User Guide</i>.</p>
@@ -3500,6 +3486,17 @@ export interface GreengrassV2 {
3500
3486
  */
3501
3487
  coreDeviceThingName: string | undefined;
3502
3488
  }
3489
+ /**
3490
+ * <p>Contains details for a SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.</p>
3491
+ * @public
3492
+ */
3493
+ export interface SiemensIE {
3494
+ /**
3495
+ * <p>The name of the IoT Thing for your SiteWise Edge gateway.</p>
3496
+ * @public
3497
+ */
3498
+ iotCoreThingName: string | undefined;
3499
+ }
3503
3500
  /**
3504
3501
  * <p>Contains a gateway's platform information.</p>
3505
3502
  * @public
@@ -3515,13 +3512,18 @@ export interface GatewayPlatform {
3515
3512
  * @public
3516
3513
  */
3517
3514
  greengrassV2?: GreengrassV2;
3515
+ /**
3516
+ * <p>A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.</p>
3517
+ * @public
3518
+ */
3519
+ siemensIE?: SiemensIE;
3518
3520
  }
3519
3521
  /**
3520
3522
  * @public
3521
3523
  */
3522
3524
  export interface CreateGatewayRequest {
3523
3525
  /**
3524
- * <p>A unique, friendly name for the gateway.</p>
3526
+ * <p>A unique name for the gateway.</p>
3525
3527
  * @public
3526
3528
  */
3527
3529
  gatewayName: string | undefined;
@@ -4131,9 +4133,7 @@ export interface DescribeAssetRequest {
4131
4133
  */
4132
4134
  assetId: string | undefined;
4133
4135
  /**
4134
- * <p>
4135
- * Whether or not to exclude asset properties from the response.
4136
- * </p>
4136
+ * <p> Whether or not to exclude asset properties from the response. </p>
4137
4137
  * @public
4138
4138
  */
4139
4139
  excludeProperties?: boolean;
@@ -4247,8 +4247,10 @@ export interface DescribeAssetCompositeModelResponse {
4247
4247
  assetCompositeModelId: string | undefined;
4248
4248
  /**
4249
4249
  * <p>An external ID to assign to the asset model.</p>
4250
- * <p>If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using
4251
- * <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or property from the created model it's a part of.</p>
4250
+ * <p>If the composite model is a component-based composite model, or one nested inside a
4251
+ * component model, you can only set the external ID using
4252
+ * <code>UpdateAssetModelCompositeModel</code> and specifying the derived ID of the model or
4253
+ * property from the created model it's a part of.</p>
4252
4254
  * @public
4253
4255
  */
4254
4256
  assetCompositeModelExternalId?: string;
@@ -4268,7 +4270,8 @@ export interface DescribeAssetCompositeModelResponse {
4268
4270
  */
4269
4271
  assetCompositeModelDescription: string | undefined;
4270
4272
  /**
4271
- * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
4273
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
4274
+ * <code> AWS/L4E_ANOMALY</code>.</p>
4272
4275
  * @public
4273
4276
  */
4274
4277
  assetCompositeModelType: string | undefined;
@@ -4299,9 +4302,7 @@ export interface DescribeAssetModelRequest {
4299
4302
  */
4300
4303
  assetModelId: string | undefined;
4301
4304
  /**
4302
- * <p>
4303
- * Whether or not to exclude asset model properties from the response.
4304
- * </p>
4305
+ * <p> Whether or not to exclude asset model properties from the response. </p>
4305
4306
  * @public
4306
4307
  */
4307
4308
  excludeProperties?: boolean;
@@ -4348,7 +4349,8 @@ export interface DescribeAssetModelResponse {
4348
4349
  */
4349
4350
  assetModelHierarchies: AssetModelHierarchy[] | undefined;
4350
4351
  /**
4351
- * <p>The list of built-in composite models for the asset model, such as those with those of type <code>AWS/ALARMS</code>.</p>
4352
+ * <p>The list of built-in composite models for the asset model, such as those with those of
4353
+ * type <code>AWS/ALARMS</code>.</p>
4352
4354
  * @public
4353
4355
  */
4354
4356
  assetModelCompositeModels?: AssetModelCompositeModel[];
@@ -4386,7 +4388,8 @@ export interface DescribeAssetModelResponse {
4386
4388
  */
4387
4389
  assetModelType?: AssetModelType;
4388
4390
  /**
4389
- * <p>The list of the immediate child custom composite model summaries for the asset model.</p>
4391
+ * <p>The list of the immediate child custom composite model summaries for the asset
4392
+ * model.</p>
4390
4393
  * @public
4391
4394
  */
4392
4395
  assetModelCompositeModelSummaries?: AssetModelCompositeModelSummary[];
@@ -4414,7 +4417,8 @@ export interface DescribeAssetModelCompositeModelRequest {
4414
4417
  assetModelCompositeModelId: string | undefined;
4415
4418
  }
4416
4419
  /**
4417
- * <p>Represents a composite model that composed an asset model of type <code>COMPONENT_MODEL</code>.</p>
4420
+ * <p>Represents a composite model that composed an asset model of type
4421
+ * <code>COMPONENT_MODEL</code>.</p>
4418
4422
  * @public
4419
4423
  */
4420
4424
  export interface CompositionRelationshipItem {
@@ -4425,7 +4429,8 @@ export interface CompositionRelationshipItem {
4425
4429
  id?: string;
4426
4430
  }
4427
4431
  /**
4428
- * <p>Metadata for the composition relationship established by using <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
4432
+ * <p>Metadata for the composition relationship established by using
4433
+ * <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
4429
4434
  * <code>CreateAssetModelCompositeModel</code>
4430
4435
  * </a>.</p>
4431
4436
  * @public
@@ -4472,7 +4477,8 @@ export interface DescribeAssetModelCompositeModelResponse {
4472
4477
  */
4473
4478
  assetModelCompositeModelDescription: string | undefined;
4474
4479
  /**
4475
- * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
4480
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
4481
+ * <code> AWS/L4E_ANOMALY</code>.</p>
4476
4482
  * @public
4477
4483
  */
4478
4484
  assetModelCompositeModelType: string | undefined;
@@ -4482,10 +4488,11 @@ export interface DescribeAssetModelCompositeModelResponse {
4482
4488
  */
4483
4489
  assetModelCompositeModelProperties: AssetModelProperty[] | undefined;
4484
4490
  /**
4485
- * <p>Metadata for the composition relationship established by using <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
4491
+ * <p>Metadata for the composition relationship established by using
4492
+ * <code>composedAssetModelId</code> in <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">
4486
4493
  * <code>CreateAssetModelCompositeModel</code>
4487
- * </a>.
4488
- * For instance, an array detailing the path of the composition relationship for this composite model.</p>
4494
+ * </a>. For instance, an array detailing the
4495
+ * path of the composition relationship for this composite model.</p>
4489
4496
  * @public
4490
4497
  */
4491
4498
  compositionDetails?: CompositionDetails;
@@ -4592,9 +4599,7 @@ export interface CompositeModelProperty {
4592
4599
  */
4593
4600
  assetProperty: Property | undefined;
4594
4601
  /**
4595
- * <p>
4596
- * The ID of the composite model that contains the property.
4597
- * </p>
4602
+ * <p> The ID of the composite model that contains the property. </p>
4598
4603
  * @public
4599
4604
  */
4600
4605
  id?: string;
@@ -4632,8 +4637,8 @@ export interface DescribeAssetPropertyResponse {
4632
4637
  */
4633
4638
  assetProperty?: Property;
4634
4639
  /**
4635
- * <p>The composite model that declares this asset property, if this asset property exists
4636
- * in a composite model.</p>
4640
+ * <p>The composite model that declares this asset property, if this asset property exists in a
4641
+ * composite model.</p>
4637
4642
  * @public
4638
4643
  */
4639
4644
  compositeModel?: CompositeModelProperty;
@@ -4902,6 +4907,7 @@ export interface DescribeGatewayRequest {
4902
4907
  */
4903
4908
  export declare const CapabilitySyncStatus: {
4904
4909
  readonly IN_SYNC: "IN_SYNC";
4910
+ readonly NOT_APPLICABLE: "NOT_APPLICABLE";
4905
4911
  readonly OUT_OF_SYNC: "OUT_OF_SYNC";
4906
4912
  readonly SYNC_FAILED: "SYNC_FAILED";
4907
4913
  readonly UNKNOWN: "UNKNOWN";
@@ -5524,16 +5530,17 @@ export interface DescribeTimeSeriesResponse {
5524
5530
  */
5525
5531
  export interface DisassociateAssetsRequest {
5526
5532
  /**
5527
- * <p>The ID of the parent asset from which to disassociate the child asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
5533
+ * <p>The ID of the parent asset from which to disassociate the child asset.
5534
+ * This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
5528
5535
  * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
5529
5536
  * @public
5530
5537
  */
5531
5538
  assetId: string | undefined;
5532
5539
  /**
5533
5540
  * <p>The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
5534
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) Hierarchies allow different groupings
5535
- * of assets to be formed that all come from the same asset model. You can use the hierarchy ID
5536
- * to identify the correct asset to disassociate. For more information, see
5541
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) Hierarchies allow
5542
+ * different groupings of assets to be formed that all come from the same asset model. You can
5543
+ * use the hierarchy ID to identify the correct asset to disassociate. For more information, see
5537
5544
  * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
5538
5545
  * @public
5539
5546
  */
@@ -5766,7 +5773,7 @@ export interface GetAssetPropertyAggregatesRequest {
5766
5773
  * </li>
5767
5774
  * <li>
5768
5775
  * <p>The number of data points in the result set is equal to the value of
5769
- * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 2500.</p>
5776
+ * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 2500.</p>
5770
5777
  * </li>
5771
5778
  * </ul>
5772
5779
  * @public
@@ -5879,7 +5886,7 @@ export interface GetAssetPropertyValueHistoryRequest {
5879
5886
  * </li>
5880
5887
  * <li>
5881
5888
  * <p>The number of data points in the result set is equal to the value of
5882
- * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 20000.</p>
5889
+ * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 20000.</p>
5883
5890
  * </li>
5884
5891
  * </ul>
5885
5892
  * @public
@@ -6387,13 +6394,13 @@ export interface ListAssetPropertiesRequest {
6387
6394
  * <ul>
6388
6395
  * <li>
6389
6396
  * <p>
6390
- * <code>ALL</code> – The list includes all asset properties for a given asset
6391
- * model ID. </p>
6397
+ * <code>ALL</code> – The list includes all asset properties for a given asset model ID.
6398
+ * </p>
6392
6399
  * </li>
6393
6400
  * <li>
6394
6401
  * <p>
6395
- * <code>BASE</code> – The list includes only base asset properties for a given
6396
- * asset model ID. </p>
6402
+ * <code>BASE</code> – The list includes only base asset properties for a given asset
6403
+ * model ID. </p>
6397
6404
  * </li>
6398
6405
  * </ul>
6399
6406
  * <p>Default: <code>BASE</code>
@@ -6571,11 +6578,10 @@ export interface ListAssociatedAssetsRequest {
6571
6578
  */
6572
6579
  assetId: string | undefined;
6573
6580
  /**
6574
- * <p>The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
6575
- * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) To find a
6576
- * hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This
6577
- * parameter is required if you choose <code>CHILD</code> for
6578
- * <code>traversalDirection</code>.</p>
6581
+ * <p>The ID of the hierarchy by which child assets are associated to the asset.
6582
+ * (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
6583
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) To find a hierarchy ID, use the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html">DescribeAsset</a> or <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html">DescribeAssetModel</a> operations. This parameter is required if you choose
6584
+ * <code>CHILD</code> for <code>traversalDirection</code>.</p>
6579
6585
  * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
6580
6586
  * @public
6581
6587
  */
@@ -6765,7 +6771,8 @@ export interface CompositionRelationshipSummary {
6765
6771
  */
6766
6772
  assetModelCompositeModelId: string | undefined;
6767
6773
  /**
6768
- * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or <code> AWS/L4E_ANOMALY</code>.</p>
6774
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
6775
+ * <code> AWS/L4E_ANOMALY</code>.</p>
6769
6776
  * @public
6770
6777
  */
6771
6778
  assetModelCompositeModelType: string | undefined;
@@ -6879,7 +6886,7 @@ export interface GatewaySummary {
6879
6886
  */
6880
6887
  gatewayId: string | undefined;
6881
6888
  /**
6882
- * <p>The name of the asset.</p>
6889
+ * <p>The name of the gateway.</p>
6883
6890
  * @public
6884
6891
  */
6885
6892
  gatewayName: string | undefined;
@@ -7254,18 +7261,3 @@ export interface TimeSeriesSummary {
7254
7261
  */
7255
7262
  timeSeriesArn: string | undefined;
7256
7263
  }
7257
- /**
7258
- * @public
7259
- */
7260
- export interface ListTimeSeriesResponse {
7261
- /**
7262
- * <p>One or more time series summaries to list.</p>
7263
- * @public
7264
- */
7265
- TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
7266
- /**
7267
- * <p>The token for the next set of results, or null if there are no additional results.</p>
7268
- * @public
7269
- */
7270
- nextToken?: string;
7271
- }
@@ -1,6 +1,21 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
3
- import { Alarms, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelHierarchy, AssetModelProperty, AssetModelStatus, AssetStatus, CapabilitySyncStatus, ColumnInfo, ConfigurationStatus, DisassociatedDataStorageState, EncryptionType, Identity, ImageFile, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PropertyNotificationState, Resource, RetentionPeriod, StorageType, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
3
+ import { Alarms, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelHierarchy, AssetModelProperty, AssetModelStatus, AssetStatus, CapabilitySyncStatus, ColumnInfo, ConfigurationStatus, DisassociatedDataStorageState, EncryptionType, Identity, ImageFile, LoggingOptions, MultiLayerStorage, Permission, PortalStatus, PropertyNotificationState, Resource, RetentionPeriod, StorageType, TimeSeriesSummary, WarmTierRetentionPeriod, WarmTierState } from "./models_0";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface ListTimeSeriesResponse {
8
+ /**
9
+ * <p>One or more time series summaries to list.</p>
10
+ * @public
11
+ */
12
+ TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
13
+ /**
14
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
15
+ * @public
16
+ */
17
+ nextToken?: string;
18
+ }
4
19
  /**
5
20
  * @public
6
21
  */
@@ -311,7 +326,8 @@ export interface UpdateAssetRequest {
311
326
  */
312
327
  assetDescription?: string;
313
328
  /**
314
- * <p>An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
329
+ * <p>An external ID to assign to the asset. The asset must not already have an external ID.
330
+ * The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
315
331
  * @public
316
332
  */
317
333
  assetExternalId?: string;
@@ -338,7 +354,7 @@ export interface UpdateAssetModelRequest {
338
354
  */
339
355
  assetModelId: string | undefined;
340
356
  /**
341
- * <p>A unique, friendly name for the asset model.</p>
357
+ * <p>A unique name for the asset model.</p>
342
358
  * @public
343
359
  */
344
360
  assetModelName: string | undefined;
@@ -371,7 +387,8 @@ export interface UpdateAssetModelRequest {
371
387
  * properties that the composite model supports. Use composite models to define alarms on this asset model.</p>
372
388
  * <note>
373
389
  * <p>When creating custom composite models, you need to use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">CreateAssetModelCompositeModel</a>. For more information,
374
- * see <LINK>.</p>
390
+ * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html">Creating custom composite models (Components)</a> in the
391
+ * <i>IoT SiteWise User Guide</i>.</p>
375
392
  * </note>
376
393
  * @public
377
394
  */
@@ -382,7 +399,8 @@ export interface UpdateAssetModelRequest {
382
399
  */
383
400
  clientToken?: string;
384
401
  /**
385
- * <p>An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
402
+ * <p>An external ID to assign to the asset model. The asset model must not already have an
403
+ * external ID. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
386
404
  * @public
387
405
  */
388
406
  assetModelExternalId?: string;
@@ -413,8 +431,9 @@ export interface UpdateAssetModelCompositeModelRequest {
413
431
  */
414
432
  assetModelCompositeModelId: string | undefined;
415
433
  /**
416
- * <p>An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to
417
- * the exact same thing as when it was created.</p>
434
+ * <p>An external ID to assign to the asset model. You can only set the external ID of the asset
435
+ * model if it wasn't set when it was created, or you're setting it to the exact same thing as
436
+ * when it was created.</p>
418
437
  * @public
419
438
  */
420
439
  assetModelCompositeModelExternalId?: string;
@@ -424,7 +443,7 @@ export interface UpdateAssetModelCompositeModelRequest {
424
443
  */
425
444
  assetModelCompositeModelDescription?: string;
426
445
  /**
427
- * <p>A unique, friendly name for the composite model.</p>
446
+ * <p>A unique name for the composite model.</p>
428
447
  * @public
429
448
  */
430
449
  assetModelCompositeModelName: string | undefined;
@@ -434,7 +453,8 @@ export interface UpdateAssetModelCompositeModelRequest {
434
453
  */
435
454
  clientToken?: string;
436
455
  /**
437
- * <p>The property definitions of the composite model. For more information, see <LINK>.</p>
456
+ * <p>The property definitions of the composite model. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models">
457
+ * Inline custom composite models</a> in the <i>IoT SiteWise User Guide</i>.</p>
438
458
  * <p>You can specify up to 200 properties per composite model. For more
439
459
  * 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>
440
460
  * @public
@@ -549,7 +569,7 @@ export interface UpdateGatewayRequest {
549
569
  */
550
570
  gatewayId: string | undefined;
551
571
  /**
552
- * <p>A unique, friendly name for the gateway.</p>
572
+ * <p>A unique name for the gateway.</p>
553
573
  * @public
554
574
  */
555
575
  gatewayName: string | undefined;
@@ -743,7 +763,8 @@ export interface UpdateProjectResponse {
743
763
  */
744
764
  export interface Datum {
745
765
  /**
746
- * <p>Indicates if the data point is a scalar value such as integer, string, double, or Boolean. </p>
766
+ * <p>Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
767
+ * </p>
747
768
  * @public
748
769
  */
749
770
  scalarValue?: string;
@@ -5,10 +5,8 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../IoTSiteWiseClient";
8
- import {
9
- ListTimeSeriesRequest,
10
- ListTimeSeriesResponse,
11
- } from "../models/models_0";
8
+ import { ListTimeSeriesRequest } from "../models/models_0";
9
+ import { ListTimeSeriesResponse } from "../models/models_1";
12
10
  export { __MetadataBearer };
13
11
  export { $Command };
14
12
  export interface ListTimeSeriesCommandInput extends ListTimeSeriesRequest {}
@@ -834,9 +834,13 @@ export interface Greengrass {
834
834
  export interface GreengrassV2 {
835
835
  coreDeviceThingName: string | undefined;
836
836
  }
837
+ export interface SiemensIE {
838
+ iotCoreThingName: string | undefined;
839
+ }
837
840
  export interface GatewayPlatform {
838
841
  greengrass?: Greengrass;
839
842
  greengrassV2?: GreengrassV2;
843
+ siemensIE?: SiemensIE;
840
844
  }
841
845
  export interface CreateGatewayRequest {
842
846
  gatewayName: string | undefined;
@@ -1155,6 +1159,7 @@ export interface DescribeGatewayRequest {
1155
1159
  }
1156
1160
  export declare const CapabilitySyncStatus: {
1157
1161
  readonly IN_SYNC: "IN_SYNC";
1162
+ readonly NOT_APPLICABLE: "NOT_APPLICABLE";
1158
1163
  readonly OUT_OF_SYNC: "OUT_OF_SYNC";
1159
1164
  readonly SYNC_FAILED: "SYNC_FAILED";
1160
1165
  readonly UNKNOWN: "UNKNOWN";
@@ -1700,7 +1705,3 @@ export interface TimeSeriesSummary {
1700
1705
  timeSeriesLastUpdateDate: Date | undefined;
1701
1706
  timeSeriesArn: string | undefined;
1702
1707
  }
1703
- export interface ListTimeSeriesResponse {
1704
- TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
1705
- nextToken?: string;
1706
- }
@@ -23,9 +23,14 @@ import {
23
23
  Resource,
24
24
  RetentionPeriod,
25
25
  StorageType,
26
+ TimeSeriesSummary,
26
27
  WarmTierRetentionPeriod,
27
28
  WarmTierState,
28
29
  } from "./models_0";
30
+ export interface ListTimeSeriesResponse {
31
+ TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
32
+ nextToken?: string;
33
+ }
29
34
  export interface PutDefaultEncryptionConfigurationRequest {
30
35
  encryptionType: EncryptionType | undefined;
31
36
  kmsKeyId?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-iotsitewise",
3
3
  "description": "AWS SDK for JavaScript Iotsitewise Client for Node.js, Browser and React Native",
4
- "version": "3.616.0",
4
+ "version": "3.619.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-iotsitewise",