@aws-sdk/client-iotsitewise 3.451.0 → 3.456.0

package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts

@@ -0,0 +1,220 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { UpdateAssetModelCompositeModelRequest, UpdateAssetModelCompositeModelResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateAssetModelCompositeModelCommand}.
+ */
+export interface UpdateAssetModelCompositeModelCommandInput extends UpdateAssetModelCompositeModelRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateAssetModelCompositeModelCommand}.
+ */
+export interface UpdateAssetModelCompositeModelCommandOutput extends UpdateAssetModelCompositeModelResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates a composite model and all of the assets that were created from the model. Each asset
+ *       created from the model inherits the updated asset model's property and hierarchy 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
+ *       <i>IoT SiteWise User Guide</i>.</p>
+ *          <important>
+ *             <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>
+ *             <p>To replace an existing composite asset model property with a new one with the same <code>name</code>, do the following:</p>
+ *             <ol>
+ *                <li>
+ *                   <p>Submit an <code>UpdateAssetModelCompositeModel</code> request with the entire existing property removed.</p>
+ *                </li>
+ *                <li>
+ *                   <p>Submit a second <code>UpdateAssetModelCompositeModel</code> request that includes the new property. The new asset property will have the same
+ *           <code>name</code> as the previous one and IoT SiteWise will generate a new unique <code>id</code>.</p>
+ *                </li>
+ *             </ol>
+ *          </important>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, UpdateAssetModelCompositeModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, UpdateAssetModelCompositeModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const input = { // UpdateAssetModelCompositeModelRequest
+ *   assetModelId: "STRING_VALUE", // required
+ *   assetModelCompositeModelId: "STRING_VALUE", // required
+ *   assetModelCompositeModelExternalId: "STRING_VALUE",
+ *   assetModelCompositeModelDescription: "STRING_VALUE",
+ *   assetModelCompositeModelName: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ *   assetModelCompositeModelProperties: [ // AssetModelProperties
+ *     { // AssetModelProperty
+ *       id: "STRING_VALUE",
+ *       name: "STRING_VALUE", // required
+ *       dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
+ *       dataTypeSpec: "STRING_VALUE",
+ *       unit: "STRING_VALUE",
+ *       type: { // PropertyType
+ *         attribute: { // Attribute
+ *           defaultValue: "STRING_VALUE",
+ *         },
+ *         measurement: { // Measurement
+ *           processingConfig: { // MeasurementProcessingConfig
+ *             forwardingConfig: { // ForwardingConfig
+ *               state: "DISABLED" || "ENABLED", // required
+ *             },
+ *           },
+ *         },
+ *         transform: { // Transform
+ *           expression: "STRING_VALUE", // required
+ *           variables: [ // ExpressionVariables // required
+ *             { // ExpressionVariable
+ *               name: "STRING_VALUE", // required
+ *               value: { // VariableValue
+ *                 propertyId: "STRING_VALUE",
+ *                 hierarchyId: "STRING_VALUE",
+ *                 propertyPath: [ // AssetModelPropertyPath
+ *                   { // AssetModelPropertyPathSegment
+ *                     id: "STRING_VALUE",
+ *                     name: "STRING_VALUE",
+ *                   },
+ *                 ],
+ *               },
+ *             },
+ *           ],
+ *           processingConfig: { // TransformProcessingConfig
+ *             computeLocation: "EDGE" || "CLOUD", // required
+ *             forwardingConfig: {
+ *               state: "DISABLED" || "ENABLED", // required
+ *             },
+ *           },
+ *         },
+ *         metric: { // Metric
+ *           expression: "STRING_VALUE", // required
+ *           variables: [ // required
+ *             {
+ *               name: "STRING_VALUE", // required
+ *               value: {
+ *                 propertyId: "STRING_VALUE",
+ *                 hierarchyId: "STRING_VALUE",
+ *                 propertyPath: [
+ *                   {
+ *                     id: "STRING_VALUE",
+ *                     name: "STRING_VALUE",
+ *                   },
+ *                 ],
+ *               },
+ *             },
+ *           ],
+ *           window: { // MetricWindow
+ *             tumbling: { // TumblingWindow
+ *               interval: "STRING_VALUE", // required
+ *               offset: "STRING_VALUE",
+ *             },
+ *           },
+ *           processingConfig: { // MetricProcessingConfig
+ *             computeLocation: "EDGE" || "CLOUD", // required
+ *           },
+ *         },
+ *       },
+ *       path: [
+ *         {
+ *           id: "STRING_VALUE",
+ *           name: "STRING_VALUE",
+ *         },
+ *       ],
+ *       externalId: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateAssetModelCompositeModelCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateAssetModelCompositeModelResponse
+ * //   assetModelCompositeModelPath: [ // AssetModelCompositeModelPath // required
+ * //     { // AssetModelCompositeModelPathSegment
+ * //       id: "STRING_VALUE",
+ * //       name: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   assetModelStatus: { // AssetModelStatus
+ * //     state: "CREATING" || "ACTIVE" || "UPDATING" || "PROPAGATING" || "DELETING" || "FAILED", // required
+ * //     error: { // ErrorDetails
+ * //       code: "VALIDATION_ERROR" || "INTERNAL_FAILURE", // required
+ * //       message: "STRING_VALUE", // required
+ * //       details: [ // DetailedErrors
+ * //         { // DetailedError
+ * //           code: "INCOMPATIBLE_COMPUTE_LOCATION" || "INCOMPATIBLE_FORWARDING_CONFIGURATION", // required
+ * //           message: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateAssetModelCompositeModelCommandInput - {@link UpdateAssetModelCompositeModelCommandInput}
+ * @returns {@link UpdateAssetModelCompositeModelCommandOutput}
+ * @see {@link UpdateAssetModelCompositeModelCommandInput} for command's `input` shape.
+ * @see {@link UpdateAssetModelCompositeModelCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
+ *
+ * @throws {@link ConflictingOperationException} (client fault)
+ *  <p>Your request has conflicting operations. This can occur if you're trying to perform more
+ *       than one operation on the same resource at the same time.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>IoT SiteWise can't process your request right now. Try again later.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request isn't valid. This can occur if your request contains malformed JSON or
+ *       unsupported characters. Check your request and try again.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>You've reached the limit for a resource. For example, this can occur if you're trying to
+ *       associate more than the allowed number of child assets or attempting to create more than the
+ *       allowed number of properties for an asset model.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
+ *
+ * @throws {@link ResourceAlreadyExistsException} (client fault)
+ *  <p>The resource already exists.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The requested resource can't be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
+ *       IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
+ *       on.</p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
+ *
+ * @throws {@link IoTSiteWiseServiceException}
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
+ *
+ */
+export declare class UpdateAssetModelCompositeModelCommand extends $Command<UpdateAssetModelCompositeModelCommandInput, UpdateAssetModelCompositeModelCommandOutput, IoTSiteWiseClientResolvedConfig> {
+    readonly input: UpdateAssetModelCompositeModelCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateAssetModelCompositeModelCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAssetModelCompositeModelCommandInput, UpdateAssetModelCompositeModelCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/UpdateAssetPropertyCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
-import { UpdateAssetPropertyRequest } from "../models/models_0";
+import { UpdateAssetPropertyRequest } from "../models/models_1";
 /**
  * @public
  */

package/dist-types/commands/UpdateDashboardCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
-import { UpdateDashboardRequest, UpdateDashboardResponse } from "../models/models_0";
+import { UpdateDashboardRequest, UpdateDashboardResponse } from "../models/models_1";
 /**
  * @public
  */

package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
-import { UpdateGatewayCapabilityConfigurationRequest, UpdateGatewayCapabilityConfigurationResponse } from "../models/models_0";
+import { UpdateGatewayCapabilityConfigurationRequest, UpdateGatewayCapabilityConfigurationResponse } from "../models/models_1";
 /**
  * @public
  */

package/dist-types/commands/UpdateGatewayCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
-import { UpdateGatewayRequest } from "../models/models_0";
+import { UpdateGatewayRequest } from "../models/models_1";
 /**
  * @public
  */

package/dist-types/commands/UpdatePortalCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
-import { UpdatePortalRequest, UpdatePortalResponse } from "../models/models_0";
+import { UpdatePortalRequest, UpdatePortalResponse } from "../models/models_1";
 /**
  * @public
  */

package/dist-types/commands/UpdateProjectCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
-import { UpdateProjectRequest, UpdateProjectResponse } from "../models/models_0";
+import { UpdateProjectRequest, UpdateProjectResponse } from "../models/models_1";
 /**
  * @public
  */

package/dist-types/commands/index.d.ts

@@ -9,6 +9,7 @@ export * from "./BatchPutAssetPropertyValueCommand";
 export * from "./CreateAccessPolicyCommand";
 export * from "./CreateAssetCommand";
 export * from "./CreateAssetModelCommand";
+export * from "./CreateAssetModelCompositeModelCommand";
 export * from "./CreateBulkImportJobCommand";
 export * from "./CreateDashboardCommand";
 export * from "./CreateGatewayCommand";
@@ -17,14 +18,18 @@ export * from "./CreateProjectCommand";
 export * from "./DeleteAccessPolicyCommand";
 export * from "./DeleteAssetCommand";
 export * from "./DeleteAssetModelCommand";
+export * from "./DeleteAssetModelCompositeModelCommand";
 export * from "./DeleteDashboardCommand";
 export * from "./DeleteGatewayCommand";
 export * from "./DeletePortalCommand";
 export * from "./DeleteProjectCommand";
 export * from "./DeleteTimeSeriesCommand";
 export * from "./DescribeAccessPolicyCommand";
+export * from "./DescribeActionCommand";
 export * from "./DescribeAssetCommand";
+export * from "./DescribeAssetCompositeModelCommand";
 export * from "./DescribeAssetModelCommand";
+export * from "./DescribeAssetModelCompositeModelCommand";
 export * from "./DescribeAssetPropertyCommand";
 export * from "./DescribeBulkImportJobCommand";
 export * from "./DescribeDashboardCommand";
@@ -38,11 +43,15 @@ export * from "./DescribeStorageConfigurationCommand";
 export * from "./DescribeTimeSeriesCommand";
 export * from "./DisassociateAssetsCommand";
 export * from "./DisassociateTimeSeriesFromAssetPropertyCommand";
+export * from "./ExecuteActionCommand";
+export * from "./ExecuteQueryCommand";
 export * from "./GetAssetPropertyAggregatesCommand";
 export * from "./GetAssetPropertyValueCommand";
 export * from "./GetAssetPropertyValueHistoryCommand";
 export * from "./GetInterpolatedAssetPropertyValuesCommand";
 export * from "./ListAccessPoliciesCommand";
+export * from "./ListActionsCommand";
+export * from "./ListAssetModelCompositeModelsCommand";
 export * from "./ListAssetModelPropertiesCommand";
 export * from "./ListAssetModelsCommand";
 export * from "./ListAssetPropertiesCommand";
@@ -50,6 +59,7 @@ export * from "./ListAssetRelationshipsCommand";
 export * from "./ListAssetsCommand";
 export * from "./ListAssociatedAssetsCommand";
 export * from "./ListBulkImportJobsCommand";
+export * from "./ListCompositionRelationshipsCommand";
 export * from "./ListDashboardsCommand";
 export * from "./ListGatewaysCommand";
 export * from "./ListPortalsCommand";
@@ -65,6 +75,7 @@ export * from "./UntagResourceCommand";
 export * from "./UpdateAccessPolicyCommand";
 export * from "./UpdateAssetCommand";
 export * from "./UpdateAssetModelCommand";
+export * from "./UpdateAssetModelCompositeModelCommand";
 export * from "./UpdateAssetPropertyCommand";
 export * from "./UpdateDashboardCommand";
 export * from "./UpdateGatewayCapabilityConfigurationCommand";

package/dist-types/models/index.d.ts

@@ -1 +1,2 @@
 export * from "./models_0";
+export * from "./models_1";