@aws-sdk/client-iotsitewise 3.693.0 → 3.695.0

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

@@ -0,0 +1,124 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
+import { UpdateDatasetRequest, UpdateDatasetResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateDatasetCommand}.
+ */
+export interface UpdateDatasetCommandInput extends UpdateDatasetRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateDatasetCommand}.
+ */
+export interface UpdateDatasetCommandOutput extends UpdateDatasetResponse, __MetadataBearer {
+}
+declare const UpdateDatasetCommand_base: {
+    new (input: UpdateDatasetCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDatasetCommandInput, UpdateDatasetCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateDatasetCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDatasetCommandInput, UpdateDatasetCommandOutput, IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a dataset.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, UpdateDatasetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, UpdateDatasetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * const client = new IoTSiteWiseClient(config);
+ * const input = { // UpdateDatasetRequest
+ *   datasetId: "STRING_VALUE", // required
+ *   datasetName: "STRING_VALUE", // required
+ *   datasetDescription: "STRING_VALUE",
+ *   datasetSource: { // DatasetSource
+ *     sourceType: "KENDRA", // required
+ *     sourceFormat: "KNOWLEDGE_BASE", // required
+ *     sourceDetail: { // SourceDetail
+ *       kendra: { // KendraSourceDetail
+ *         knowledgeBaseArn: "STRING_VALUE", // required
+ *         roleArn: "STRING_VALUE", // required
+ *       },
+ *     },
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateDatasetCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateDatasetResponse
+ * //   datasetId: "STRING_VALUE",
+ * //   datasetArn: "STRING_VALUE",
+ * //   datasetStatus: { // DatasetStatus
+ * //     state: "CREATING" || "ACTIVE" || "UPDATING" || "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 UpdateDatasetCommandInput - {@link UpdateDatasetCommandInput}
+ * @returns {@link UpdateDatasetCommandOutput}
+ * @see {@link UpdateDatasetCommandInput} for command's `input` shape.
+ * @see {@link UpdateDatasetCommandOutput} 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 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>
+ *
+ * @public
+ */
+export declare class UpdateDatasetCommand extends UpdateDatasetCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateDatasetRequest;
+            output: UpdateDatasetResponse;
+        };
+        sdk: {
+            input: UpdateDatasetCommandInput;
+            output: UpdateDatasetCommandOutput;
+        };
+    };
+}

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

@@ -53,12 +53,20 @@ declare const UpdatePortalCommand_base: {
  *     alarmRoleArn: "STRING_VALUE", // required
  *     notificationLambdaArn: "STRING_VALUE",
  *   },
+ *   portalType: "SITEWISE_PORTAL_V1" || "SITEWISE_PORTAL_V2",
+ *   portalTypeConfiguration: { // PortalTypeConfiguration
+ *     "<keys>": { // PortalTypeEntry
+ *       portalTools: [ // PortalTools
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
  * };
  * const command = new UpdatePortalCommand(input);
  * const response = await client.send(command);
  * // { // UpdatePortalResponse
  * //   portalStatus: { // PortalStatus
- * //     state: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "FAILED", // required
+ * //     state: "CREATING" || "PENDING" || "UPDATING" || "DELETING" || "ACTIVE" || "FAILED", // required
  * //     error: { // MonitorErrorDetails
  * //       code: "INTERNAL_FAILURE" || "VALIDATION_ERROR" || "LIMIT_EXCEEDED",
  * //       message: "STRING_VALUE",

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

@@ -12,6 +12,7 @@ export * from "./CreateAssetModelCommand";
 export * from "./CreateAssetModelCompositeModelCommand";
 export * from "./CreateBulkImportJobCommand";
 export * from "./CreateDashboardCommand";
+export * from "./CreateDatasetCommand";
 export * from "./CreateGatewayCommand";
 export * from "./CreatePortalCommand";
 export * from "./CreateProjectCommand";
@@ -20,6 +21,7 @@ export * from "./DeleteAssetCommand";
 export * from "./DeleteAssetModelCommand";
 export * from "./DeleteAssetModelCompositeModelCommand";
 export * from "./DeleteDashboardCommand";
+export * from "./DeleteDatasetCommand";
 export * from "./DeleteGatewayCommand";
 export * from "./DeletePortalCommand";
 export * from "./DeleteProjectCommand";
@@ -33,6 +35,7 @@ export * from "./DescribeAssetModelCompositeModelCommand";
 export * from "./DescribeAssetPropertyCommand";
 export * from "./DescribeBulkImportJobCommand";
 export * from "./DescribeDashboardCommand";
+export * from "./DescribeDatasetCommand";
 export * from "./DescribeDefaultEncryptionConfigurationCommand";
 export * from "./DescribeGatewayCapabilityConfigurationCommand";
 export * from "./DescribeGatewayCommand";
@@ -49,6 +52,7 @@ export * from "./GetAssetPropertyAggregatesCommand";
 export * from "./GetAssetPropertyValueCommand";
 export * from "./GetAssetPropertyValueHistoryCommand";
 export * from "./GetInterpolatedAssetPropertyValuesCommand";
+export * from "./InvokeAssistantCommand";
 export * from "./ListAccessPoliciesCommand";
 export * from "./ListActionsCommand";
 export * from "./ListAssetModelCompositeModelsCommand";
@@ -61,6 +65,7 @@ export * from "./ListAssociatedAssetsCommand";
 export * from "./ListBulkImportJobsCommand";
 export * from "./ListCompositionRelationshipsCommand";
 export * from "./ListDashboardsCommand";
+export * from "./ListDatasetsCommand";
 export * from "./ListGatewaysCommand";
 export * from "./ListPortalsCommand";
 export * from "./ListProjectAssetsCommand";
@@ -78,6 +83,7 @@ export * from "./UpdateAssetModelCommand";
 export * from "./UpdateAssetModelCompositeModelCommand";
 export * from "./UpdateAssetPropertyCommand";
 export * from "./UpdateDashboardCommand";
+export * from "./UpdateDatasetCommand";
 export * from "./UpdateGatewayCapabilityConfigurationCommand";
 export * from "./UpdateGatewayCommand";
 export * from "./UpdatePortalCommand";