Skip to content

Commit f1138f7

Browse files
author
awstools
committed
feat(client-iotsitewise): Adds support for creating SiteWise Edge gateways that run on a Siemens Industrial Edge Device.
1 parent 42b8fd5 commit f1138f7

22 files changed

+374
-261
lines changed

‎clients/client-iotsitewise/src/auth/httpAuthSchemeProvider.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: IoTSiteWiseHttpAuthSch
6060
name: "iotsitewise",
6161
region: authParameters.region,
6262
},
63-
propertiesExtractor: (config: IoTSiteWiseClientConfig, context) => ({
63+
propertiesExtractor: (config: Partial<IoTSiteWiseClientConfig>, context) => ({
6464
/**
6565
* @internal
6666
*/

‎clients/client-iotsitewise/src/commands/CreateAssetModelCommand.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,20 @@ export interface CreateAssetModelCommandOutput extends CreateAssetModelResponse,
3333
* that have standardized definitions. Each asset created from a model inherits the asset model's
3434
* 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
3535
* <i>IoT SiteWise User Guide</i>.</p>
36-
* <p>You can create two types of asset models, <code>ASSET_MODEL</code> or <code>COMPONENT_MODEL</code>.</p>
36+
* <p>You can create two types of asset models, <code>ASSET_MODEL</code> or
37+
* <code>COMPONENT_MODEL</code>.</p>
3738
* <ul>
3839
* <li>
3940
* <p>
40-
* <b>ASSET_MODEL</b> – (default) An asset model that you can use to create assets.
41-
* Can't be included as a component in another asset model.</p>
41+
* <b>ASSET_MODEL</b> – (default) An asset model that
42+
* you can use to create assets. Can't be included as a component in another asset
43+
* model.</p>
4244
* </li>
4345
* <li>
4446
* <p>
45-
* <b>COMPONENT_MODEL</b> – A reusable component that you can include in the composite
46-
* models of other asset models. You can't create assets directly from this type of asset model. </p>
47+
* <b>COMPONENT_MODEL</b> – A reusable component that
48+
* you can include in the composite models of other asset models. You can't create
49+
* assets directly from this type of asset model. </p>
4750
* </li>
4851
* </ul>
4952
* @example

‎clients/client-iotsitewise/src/commands/CreateAssetModelCompositeModelCommand.ts

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,23 @@ export interface CreateAssetModelCompositeModelCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models,
37-
* <code>inline</code> and <code>component-model-based</code>. </p>
38-
* <p>Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name,
39-
* 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
40-
* component model provides its associated properties to any created assets. For more information, see
41-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html">Custom composite models (Components)</a> in the
42-
* <i>IoT SiteWise User Guide</i>.</p>
43-
* <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
44-
* included and can't be used to create multiple assets.</p>
45-
* <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>
46-
* <p>To create an inline model, specify the <code>assetModelCompositeModelProperties</code> and don't include an <code>composedAssetModelId</code>.</p>
36+
* <p>Creates a custom composite model from specified property and hierarchy definitions. There
37+
* are two types of custom composite models, <code>inline</code> and
38+
* <code>component-model-based</code>. </p>
39+
* <p>Use component-model-based custom composite models to define standard, reusable components.
40+
* A component-model-based custom composite model consists of a name, a description, and the ID
41+
* of the component model it references. A component-model-based custom composite model has no
42+
* properties of its own; its referenced component model provides its associated properties to
43+
* 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>
44+
* in the <i>IoT SiteWise User Guide</i>.</p>
45+
* <p>Use inline custom composite models to organize the properties of an asset model. The
46+
* properties of inline custom composite models are local to the asset model where they are
47+
* included and can't be used to create multiple assets.</p>
48+
* <p>To create a component-model-based model, specify the <code>composedAssetModelId</code> of
49+
* an existing asset model with <code>assetModelType</code> of
50+
* <code>COMPONENT_MODEL</code>.</p>
51+
* <p>To create an inline model, specify the <code>assetModelCompositeModelProperties</code> and
52+
* don't include an <code>composedAssetModelId</code>.</p>
4753
* @example
4854
* Use a bare-bones client and the command you need to make an API call.
4955
* ```javascript

‎clients/client-iotsitewise/src/commands/CreateBulkImportJobCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobRes
3333
* <important>
3434
* <p>Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier.
3535
* 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>
36-
* <p>Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on
37-
* IoT SiteWise warm or cold tier storage.</p>
36+
* <p>Bulk import is designed to store historical data to IoT SiteWise. It does not trigger
37+
* computations or notifications on IoT SiteWise warm or cold tier storage.</p>
3838
* </important>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotsitewise/src/commands/CreateGatewayCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ export interface CreateGatewayCommandOutput extends CreateGatewayResponse, __Met
4646
* greengrassV2: { // GreengrassV2
4747
* coreDeviceThingName: "STRING_VALUE", // required
4848
* },
49+
* siemensIE: { // SiemensIE
50+
* iotCoreThingName: "STRING_VALUE", // required
51+
* },
4952
* },
5053
* tags: { // TagMap
5154
* "<keys>": "STRING_VALUE",

‎clients/client-iotsitewise/src/commands/DeleteAssetModelCompositeModelCommand.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ export interface DeleteAssetModelCompositeModelCommandOutput
3434

3535
/**
3636
* <p>Deletes a composite model. This action can't be undone. You must delete all assets created
37-
* from a composite model before you can delete the model. Also, you can't delete a composite model if
38-
* a parent asset model exists that contains a property formula expression that depends on the
39-
* 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
40-
* <i>IoT SiteWise User Guide</i>.</p>
37+
* from a composite model before you can delete the model. Also, you can't delete a composite
38+
* model if a parent asset model exists that contains a property formula expression that depends
39+
* 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
40+
* models</a> in the <i>IoT SiteWise User Guide</i>.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

‎clients/client-iotsitewise/src/commands/DeleteGatewayCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ export interface DeleteGatewayCommandOutput extends __MetadataBearer {}
5151
* @see {@link DeleteGatewayCommandOutput} for command's `response` shape.
5252
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
5353
*
54+
* @throws {@link ConflictingOperationException} (client fault)
55+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
56+
* than one operation on the same resource at the same time.</p>
57+
*
5458
* @throws {@link InternalFailureException} (server fault)
5559
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
5660
*

‎clients/client-iotsitewise/src/commands/DescribeAssetCompositeModelCommand.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,10 @@ export interface DescribeAssetCompositeModelCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <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
37-
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html">DescribeAssetModelCompositeModel</a>.</p>
36+
* <p>Retrieves information about an asset composite model (also known as an asset component).
37+
* An <code>AssetCompositeModel</code> is an instance of an
38+
* <code>AssetModelCompositeModel</code>. If you want to see information about the model this is
39+
* based on, call <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html">DescribeAssetModelCompositeModel</a>.</p>
3840
* @example
3941
* Use a bare-bones client and the command you need to make an API call.
4042
* ```javascript

‎clients/client-iotsitewise/src/commands/DescribeAssetModelCompositeModelCommand.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ export interface DescribeAssetModelCompositeModelCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <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>
36+
* <p>Retrieves information about an asset model composite model (also known as an asset model
37+
* component). For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html">Custom composite models
38+
* (Components)</a> in the <i>IoT SiteWise User Guide</i>.</p>
3739
* @example
3840
* Use a bare-bones client and the command you need to make an API call.
3941
* ```javascript

‎clients/client-iotsitewise/src/commands/DescribeGatewayCapabilityConfigurationCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export interface DescribeGatewayCapabilityConfigurationCommandOutput
5858
* // gatewayId: "STRING_VALUE", // required
5959
* // capabilityNamespace: "STRING_VALUE", // required
6060
* // capabilityConfiguration: "STRING_VALUE", // required
61-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
61+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
6262
* // };
6363
*
6464
* ```

‎clients/client-iotsitewise/src/commands/DescribeGatewayCommand.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,14 @@ export interface DescribeGatewayCommandOutput extends DescribeGatewayResponse, _
5151
* // greengrassV2: { // GreengrassV2
5252
* // coreDeviceThingName: "STRING_VALUE", // required
5353
* // },
54+
* // siemensIE: { // SiemensIE
55+
* // iotCoreThingName: "STRING_VALUE", // required
56+
* // },
5457
* // },
5558
* // gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries // required
5659
* // { // GatewayCapabilitySummary
5760
* // capabilityNamespace: "STRING_VALUE", // required
58-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
61+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
5962
* // },
6063
* // ],
6164
* // creationDate: new Date("TIMESTAMP"), // required

‎clients/client-iotsitewise/src/commands/ExecuteQueryCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ export interface ExecuteQueryCommandInput extends ExecuteQueryRequest {}
2929
export interface ExecuteQueryCommandOutput extends ExecuteQueryResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.</p>
32+
* <p>Run SQL queries to retrieve metadata and time-series data from asset models, assets,
33+
* measurements, metrics, transforms, and aggregates.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

‎clients/client-iotsitewise/src/commands/ListCompositionRelationshipsCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export interface ListCompositionRelationshipsCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Retrieves a paginated list of composition relationships for an asset model of type <code>COMPONENT_MODEL</code>.</p>
36+
* <p>Retrieves a paginated list of composition relationships for an asset model of type
37+
* <code>COMPONENT_MODEL</code>.</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
3940
* ```javascript

‎clients/client-iotsitewise/src/commands/ListGatewaysCommand.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,14 @@ export interface ListGatewaysCommandOutput extends ListGatewaysResponse, __Metad
5353
* // greengrassV2: { // GreengrassV2
5454
* // coreDeviceThingName: "STRING_VALUE", // required
5555
* // },
56+
* // siemensIE: { // SiemensIE
57+
* // iotCoreThingName: "STRING_VALUE", // required
58+
* // },
5659
* // },
5760
* // gatewayCapabilitySummaries: [ // GatewayCapabilitySummaries
5861
* // { // GatewayCapabilitySummary
5962
* // capabilityNamespace: "STRING_VALUE", // required
60-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
63+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
6164
* // },
6265
* // ],
6366
* // creationDate: new Date("TIMESTAMP"), // required

‎clients/client-iotsitewise/src/commands/ListTimeSeriesCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { commonParams } from "../endpoint/EndpointParameters";
88
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
9-
import { ListTimeSeriesRequest, ListTimeSeriesResponse } from "../models/models_0";
9+
import { ListTimeSeriesRequest } from "../models/models_0";
10+
import { ListTimeSeriesResponse } from "../models/models_1";
1011
import { de_ListTimeSeriesCommand, se_ListTimeSeriesCommand } from "../protocols/Aws_restJson1";
1112

1213
/**

‎clients/client-iotsitewise/src/commands/UpdateAssetModelCommand.ts

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,21 @@ export interface UpdateAssetModelCommandOutput extends UpdateAssetModelResponse,
3333
* 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
3434
* <i>IoT SiteWise User Guide</i>.</p>
3535
* <important>
36-
* <p>This operation overwrites the existing model with the provided model. To avoid deleting
37-
* your asset model's properties or hierarchies, you must include their IDs and definitions in
38-
* 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>
3936
* <p>If you remove a property from an asset model, IoT SiteWise deletes all previous data for that
40-
* property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every
41-
* asset associated with that hierarchy. You can't change the type or data type of an existing
42-
* property.</p>
37+
* property. You can’t change the type or data type of an existing property.</p>
38+
* <p>To replace an existing asset model property with a new one with the same
39+
* <code>name</code>, do the following:</p>
40+
* <ol>
41+
* <li>
42+
* <p>Submit an <code>UpdateAssetModel</code> request with the entire existing property
43+
* removed.</p>
44+
* </li>
45+
* <li>
46+
* <p>Submit a second <code>UpdateAssetModel</code> request that includes the new
47+
* property. The new asset property will have the same <code>name</code> as the previous
48+
* one and IoT SiteWise will generate a new unique <code>id</code>.</p>
49+
* </li>
50+
* </ol>
4351
* </important>
4452
* @example
4553
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotsitewise/src/commands/UpdateAssetModelCompositeModelCommand.ts

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,24 @@ export interface UpdateAssetModelCompositeModelCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Updates a composite model and all of the assets that were created from the model. Each asset
37-
* created from the model inherits the updated asset model's property and hierarchy definitions.
38-
* 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
39-
* <i>IoT SiteWise User Guide</i>.</p>
36+
* <p>Updates a composite model and all of the assets that were created from the model. Each
37+
* asset created from the model inherits the updated asset model's property and hierarchy
38+
* 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
39+
* <i>IoT SiteWise User Guide</i>.</p>
4040
* <important>
41-
* <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>
42-
* <p>To replace an existing composite asset model property with a new one with the same <code>name</code>, do the following:</p>
41+
* <p>If you remove a property from a composite asset model, IoT SiteWise deletes all previous data
42+
* for that property. You can’t change the type or data type of an existing property.</p>
43+
* <p>To replace an existing composite asset model property with a new one with the same
44+
* <code>name</code>, do the following:</p>
4345
* <ol>
4446
* <li>
45-
* <p>Submit an <code>UpdateAssetModelCompositeModel</code> request with the entire existing property removed.</p>
47+
* <p>Submit an <code>UpdateAssetModelCompositeModel</code> request with the entire
48+
* existing property removed.</p>
4649
* </li>
4750
* <li>
48-
* <p>Submit a second <code>UpdateAssetModelCompositeModel</code> request that includes the new property. The new asset property will have the same
49-
* <code>name</code> as the previous one and IoT SiteWise will generate a new unique <code>id</code>.</p>
51+
* <p>Submit a second <code>UpdateAssetModelCompositeModel</code> request that includes
52+
* the new property. The new asset property will have the same <code>name</code> as the
53+
* previous one and IoT SiteWise will generate a new unique <code>id</code>.</p>
5054
* </li>
5155
* </ol>
5256
* </important>

‎clients/client-iotsitewise/src/commands/UpdateGatewayCapabilityConfigurationCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export interface UpdateGatewayCapabilityConfigurationCommandOutput
5656
* const response = await client.send(command);
5757
* // { // UpdateGatewayCapabilityConfigurationResponse
5858
* // capabilityNamespace: "STRING_VALUE", // required
59-
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN", // required
59+
* // capabilitySyncStatus: "IN_SYNC" || "OUT_OF_SYNC" || "SYNC_FAILED" || "UNKNOWN" || "NOT_APPLICABLE", // required
6060
* // };
6161
*
6262
* ```

0 commit comments

Comments
 (0)