@aws-sdk/client-iotsitewise 3.1096.0 → 3.1098.0

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListAssetModelPropertiesRequest, ListAssetModelPropertiesResponse } from "../models/models_0";
+import type { ListAssetModelPropertiesRequest, ListAssetModelPropertiesResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -50,7 +50,7 @@ declare const ListAssetModelPropertiesCommand_base: {
  * //       id: "STRING_VALUE",
  * //       externalId: "STRING_VALUE",
  * //       name: "STRING_VALUE", // required
- * //       dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
+ * //       dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
  * //       dataTypeSpec: "STRING_VALUE",
  * //       unit: "STRING_VALUE",
  * //       type: { // PropertyType

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListAssetModelsRequest, ListAssetModelsResponse } from "../models/models_0";
+import type { ListAssetModelsRequest, ListAssetModelsResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -88,6 +88,9 @@ declare const ListAssetModelsCommand_base: {
  *  <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 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

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListAssetPropertiesRequest, ListAssetPropertiesResponse } from "../models/models_0";
+import type { ListAssetPropertiesRequest, ListAssetPropertiesResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListAssetRelationshipsRequest, ListAssetRelationshipsResponse } from "../models/models_0";
+import type { ListAssetRelationshipsRequest, ListAssetRelationshipsResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListAssetsRequest, ListAssetsResponse } from "../models/models_0";
+import type { ListAssetsRequest, ListAssetsResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListAssociatedAssetsRequest, ListAssociatedAssetsResponse } from "../models/models_0";
+import type { ListAssociatedAssetsRequest, ListAssociatedAssetsResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListBulkImportJobsRequest, ListBulkImportJobsResponse } from "../models/models_0";
+import type { ListBulkImportJobsRequest, ListBulkImportJobsResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -38,6 +38,7 @@ declare const ListBulkImportJobsCommand_base: {
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
  *   filter: "ALL" || "PENDING" || "RUNNING" || "CANCELLED" || "FAILED" || "COMPLETED_WITH_FAILURES" || "COMPLETED",
+ *   workspaceName: "STRING_VALUE",
  * };
  * const command = new ListBulkImportJobsCommand(input);
  * const response = await client.send(command);

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListCompositionRelationshipsRequest, ListCompositionRelationshipsResponse } from "../models/models_0";
+import type { ListCompositionRelationshipsRequest, ListCompositionRelationshipsResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListComputationModelDataBindingUsagesRequest, ListComputationModelDataBindingUsagesResponse } from "../models/models_0";
+import type { ListComputationModelDataBindingUsagesRequest, ListComputationModelDataBindingUsagesResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListComputationModelResolveToResourcesRequest, ListComputationModelResolveToResourcesResponse } from "../models/models_0";
+import type { ListComputationModelResolveToResourcesRequest, ListComputationModelResolveToResourcesResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListComputationModelsRequest, ListComputationModelsResponse } from "../models/models_0";
+import type { ListComputationModelsRequest, ListComputationModelsResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListDashboardsRequest, ListDashboardsResponse } from "../models/models_0";
+import type { ListDashboardsRequest, ListDashboardsResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -0,0 +1,107 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListDatasetDataSegmentRelationshipsRequest, ListDatasetDataSegmentRelationshipsResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListDatasetDataSegmentRelationshipsCommand}.
+ */
+export interface ListDatasetDataSegmentRelationshipsCommandInput extends ListDatasetDataSegmentRelationshipsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDatasetDataSegmentRelationshipsCommand}.
+ */
+export interface ListDatasetDataSegmentRelationshipsCommandOutput extends ListDatasetDataSegmentRelationshipsResponse, __MetadataBearer {
+}
+declare const ListDatasetDataSegmentRelationshipsCommand_base: {
+    new (input: ListDatasetDataSegmentRelationshipsCommandInput): import("@smithy/core/client").CommandImpl<ListDatasetDataSegmentRelationshipsCommandInput, ListDatasetDataSegmentRelationshipsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListDatasetDataSegmentRelationshipsCommandInput): import("@smithy/core/client").CommandImpl<ListDatasetDataSegmentRelationshipsCommandInput, ListDatasetDataSegmentRelationshipsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a paginated list of data segment relationships for a session dataset. Use this
+ *       operation to find the curated datasets that reference data segments of the specified session
+ *       dataset. Use the <code>nextToken</code> parameter to retrieve additional results.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, ListDatasetDataSegmentRelationshipsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, ListDatasetDataSegmentRelationshipsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
+ * const config = {}; // type is IoTSiteWiseClientConfig
+ * const client = new IoTSiteWiseClient(config);
+ * const input = { // ListDatasetDataSegmentRelationshipsRequest
+ *   datasetId: "STRING_VALUE", // required
+ *   workspaceName: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListDatasetDataSegmentRelationshipsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDatasetDataSegmentRelationshipsResponse
+ * //   dataSegmentRelationshipSummaries: [ // DataSegmentRelationshipSummaries // required
+ * //     { // DataSegmentRelationshipSummary
+ * //       targetDatasetId: "STRING_VALUE", // required
+ * //       sourceDatasetId: "STRING_VALUE", // required
+ * //       timeSeriesId: "STRING_VALUE", // required
+ * //       startTimestamp: { // TimeInNanos
+ * //         timeInSeconds: Number("long"), // required
+ * //         offsetInNanos: Number("int"),
+ * //       },
+ * //       endTimestamp: {
+ * //         timeInSeconds: Number("long"), // required
+ * //         offsetInNanos: Number("int"),
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDatasetDataSegmentRelationshipsCommandInput - {@link ListDatasetDataSegmentRelationshipsCommandInput}
+ * @returns {@link ListDatasetDataSegmentRelationshipsCommandOutput}
+ * @see {@link ListDatasetDataSegmentRelationshipsCommandInput} for command's `input` shape.
+ * @see {@link ListDatasetDataSegmentRelationshipsCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
+ *
+ * @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 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 ListDatasetDataSegmentRelationshipsCommand extends ListDatasetDataSegmentRelationshipsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListDatasetDataSegmentRelationshipsRequest;
+            output: ListDatasetDataSegmentRelationshipsResponse;
+        };
+        sdk: {
+            input: ListDatasetDataSegmentRelationshipsCommandInput;
+            output: ListDatasetDataSegmentRelationshipsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,111 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListDatasetDataSegmentsRequest, ListDatasetDataSegmentsResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListDatasetDataSegmentsCommand}.
+ */
+export interface ListDatasetDataSegmentsCommandInput extends ListDatasetDataSegmentsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDatasetDataSegmentsCommand}.
+ */
+export interface ListDatasetDataSegmentsCommandOutput extends ListDatasetDataSegmentsResponse, __MetadataBearer {
+}
+declare const ListDatasetDataSegmentsCommand_base: {
+    new (input: ListDatasetDataSegmentsCommandInput): import("@smithy/core/client").CommandImpl<ListDatasetDataSegmentsCommandInput, ListDatasetDataSegmentsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListDatasetDataSegmentsCommandInput): import("@smithy/core/client").CommandImpl<ListDatasetDataSegmentsCommandInput, ListDatasetDataSegmentsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a paginated list of data segments associated with a dataset. Use the <code>nextToken</code> parameter to retrieve additional results.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, ListDatasetDataSegmentsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, ListDatasetDataSegmentsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
+ * const config = {}; // type is IoTSiteWiseClientConfig
+ * const client = new IoTSiteWiseClient(config);
+ * const input = { // ListDatasetDataSegmentsRequest
+ *   datasetId: "STRING_VALUE", // required
+ *   workspaceName: "STRING_VALUE", // required
+ *   datasetVersion: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListDatasetDataSegmentsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDatasetDataSegmentsResponse
+ * //   dataSegments: [ // DataSegmentSummaries // required
+ * //     { // DataSegmentSummary
+ * //       sourceDatasetId: "STRING_VALUE", // required
+ * //       timeSeriesId: "STRING_VALUE", // required
+ * //       startTimestamp: { // TimeInNanos
+ * //         timeInSeconds: Number("long"), // required
+ * //         offsetInNanos: Number("int"),
+ * //       },
+ * //       endTimestamp: {
+ * //         timeInSeconds: Number("long"), // required
+ * //         offsetInNanos: Number("int"),
+ * //       },
+ * //       alias: "STRING_VALUE", // required
+ * //       dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
+ * //       enrichment: { // DataSegmentEnrichment
+ * //         status: "ENRICHED" || "NOT_ENRICHED", // required
+ * //         lastEnrichedAt: new Date("TIMESTAMP"),
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDatasetDataSegmentsCommandInput - {@link ListDatasetDataSegmentsCommandInput}
+ * @returns {@link ListDatasetDataSegmentsCommandOutput}
+ * @see {@link ListDatasetDataSegmentsCommandInput} for command's `input` shape.
+ * @see {@link ListDatasetDataSegmentsCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
+ *
+ * @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 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 ListDatasetDataSegmentsCommand extends ListDatasetDataSegmentsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListDatasetDataSegmentsRequest;
+            output: ListDatasetDataSegmentsResponse;
+        };
+        sdk: {
+            input: ListDatasetDataSegmentsCommandInput;
+            output: ListDatasetDataSegmentsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,102 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListDatasetExportJobsRequest, ListDatasetExportJobsResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListDatasetExportJobsCommand}.
+ */
+export interface ListDatasetExportJobsCommandInput extends ListDatasetExportJobsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListDatasetExportJobsCommand}.
+ */
+export interface ListDatasetExportJobsCommandOutput extends ListDatasetExportJobsResponse, __MetadataBearer {
+}
+declare const ListDatasetExportJobsCommand_base: {
+    new (input: ListDatasetExportJobsCommandInput): import("@smithy/core/client").CommandImpl<ListDatasetExportJobsCommandInput, ListDatasetExportJobsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListDatasetExportJobsCommandInput): import("@smithy/core/client").CommandImpl<ListDatasetExportJobsCommandInput, ListDatasetExportJobsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves a paginated list of dataset export jobs for a workspace.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, ListDatasetExportJobsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, ListDatasetExportJobsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
+ * const config = {}; // type is IoTSiteWiseClientConfig
+ * const client = new IoTSiteWiseClient(config);
+ * const input = { // ListDatasetExportJobsRequest
+ *   workspaceName: "STRING_VALUE", // required
+ *   filter: "ALL" || "SUBMITTED" || "RUNNING" || "COMPLETED" || "COMPLETED_WITH_ERRORS" || "FAILED",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListDatasetExportJobsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListDatasetExportJobsResponse
+ * //   jobs: [ // ExportJobSummaryList // required
+ * //     { // ExportJobSummary
+ * //       jobId: "STRING_VALUE", // required
+ * //       status: "SUBMITTED" || "RUNNING" || "COMPLETED" || "COMPLETED_WITH_ERRORS" || "FAILED", // required
+ * //       startedAt: new Date("TIMESTAMP"), // required
+ * //       completedAt: new Date("TIMESTAMP"),
+ * //       destinationS3Uri: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListDatasetExportJobsCommandInput - {@link ListDatasetExportJobsCommandInput}
+ * @returns {@link ListDatasetExportJobsCommandOutput}
+ * @see {@link ListDatasetExportJobsCommandInput} for command's `input` shape.
+ * @see {@link ListDatasetExportJobsCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</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 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 ListDatasetExportJobsCommand extends ListDatasetExportJobsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListDatasetExportJobsRequest;
+            output: ListDatasetExportJobsResponse;
+        };
+        sdk: {
+            input: ListDatasetExportJobsCommandInput;
+            output: ListDatasetExportJobsCommandOutput;
+        };
+    };
+}

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

@@ -1,5 +1,5 @@
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { ListDatasetsRequest, ListDatasetsResponse } from "../models/models_0";
+import type { ListDatasetsRequest, ListDatasetsResponse } from "../models/models_1";
 /**
  * @public
  */
@@ -34,7 +34,9 @@ declare const ListDatasetsCommand_base: {
  * const config = {}; // type is IoTSiteWiseClientConfig
  * const client = new IoTSiteWiseClient(config);
  * const input = { // ListDatasetsRequest
- *   sourceType: "KENDRA", // required
+ *   sourceType: "KENDRA" || "SITEWISE", // required
+ *   workspaceName: "STRING_VALUE",
+ *   datasetType: "SESSION" || "CURATED" || "EXTERNAL",
  *   nextToken: "STRING_VALUE",
  *   maxResults: Number("int"),
  * };
@@ -47,6 +49,8 @@ declare const ListDatasetsCommand_base: {
  * //       arn: "STRING_VALUE", // required
  * //       name: "STRING_VALUE", // required
  * //       description: "STRING_VALUE", // required
+ * //       sourceType: "KENDRA" || "SITEWISE",
+ * //       datasetType: "SESSION" || "CURATED" || "EXTERNAL",
  * //       creationDate: new Date("TIMESTAMP"), // required
  * //       lastUpdateDate: new Date("TIMESTAMP"), // required
  * //       status: { // DatasetStatus
@@ -62,9 +66,16 @@ declare const ListDatasetsCommand_base: {
  * //           ],
  * //         },
  * //       },
+ * //       enrichmentStatus: { // DatasetEnrichment
+ * //         video: { // DatasetEnrichmentEntry
+ * //           status: "FULLY_ENRICHED" || "PARTIALLY_ENRICHED" || "NOT_ENRICHED", // required
+ * //           lastEnrichedAt: new Date("TIMESTAMP"),
+ * //         },
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",
+ * //   workspaceName: "STRING_VALUE",
  * // };
  *
  * ```
@@ -82,6 +93,9 @@ declare const ListDatasetsCommand_base: {
  *  <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 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

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

@@ -0,0 +1,151 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListEnrichmentJobsRequest, ListEnrichmentJobsResponse } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListEnrichmentJobsCommand}.
+ */
+export interface ListEnrichmentJobsCommandInput extends ListEnrichmentJobsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListEnrichmentJobsCommand}.
+ */
+export interface ListEnrichmentJobsCommandOutput extends ListEnrichmentJobsResponse, __MetadataBearer {
+}
+declare const ListEnrichmentJobsCommand_base: {
+    new (input: ListEnrichmentJobsCommandInput): import("@smithy/core/client").CommandImpl<ListEnrichmentJobsCommandInput, ListEnrichmentJobsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListEnrichmentJobsCommandInput): import("@smithy/core/client").CommandImpl<ListEnrichmentJobsCommandInput, ListEnrichmentJobsCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered
+ * by createdAt timestamp descending (newest first).</p>
+ * <h2>Filtering</h2>
+ * <p>Combine filters to narrow results:</p>
+ * <ul>
+ * <li><strong>datasetId</strong>: Filter by dataset</li>
+ * <li><strong>propertyAlias</strong> OR <strong>timeSeriesId</strong>: Filter by time series (specify one, not both)</li>
+ * <li><strong>status</strong>: Filter by job status (e.g., RUNNING to find active jobs)</li>
+ * <li><strong>jobType</strong>: Filter by enrichment type (currently only EVENT_DETECTION)</li>
+ * <li><strong>startDate</strong> and <strong>endDate</strong>: Filter by job creation time range</li>
+ * </ul>
+ * <h2>Important Constraints</h2>
+ * <ul>
+ * <li>You must specify either propertyAlias OR timeSeriesId, but not both</li>
+ * <li>Attempting to specify both results in an InvalidRequestException</li>
+ * <li>Date filters use ISO 8601 format</li>
+ * <li>startDate is exclusive, endDate is inclusive</li>
+ * </ul>
+ * <h2>Pagination</h2>
+ * <p>The operation returns up to maxResults jobs per page (default 50). If more results exist, the
+ * response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.</p>
+ * <h2>Common Use Cases</h2>
+ * <ul>
+ * <li>Find all running jobs: Filter by status=RUNNING</li>
+ * <li>List recent jobs for a dataset: Filter by datasetId with optional date range</li>
+ * <li>Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId</li>
+ * <li>Track all event detection jobs: Filter by jobType=EVENT_DETECTION</li>
+ * </ul>
+ * <h2>Performance</h2>
+ * <p>Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTSiteWiseClient, ListEnrichmentJobsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
+ * // const { IoTSiteWiseClient, ListEnrichmentJobsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
+ * const config = {}; // type is IoTSiteWiseClientConfig
+ * const client = new IoTSiteWiseClient(config);
+ * const input = { // ListEnrichmentJobsRequest
+ *   workspaceName: "STRING_VALUE", // required
+ *   datasetId: "STRING_VALUE",
+ *   propertyAlias: "STRING_VALUE",
+ *   timeSeriesId: "STRING_VALUE",
+ *   status: "PENDING" || "RUNNING" || "COMPLETED" || "FAILED" || "TIMED_OUT" || "CANCELLED",
+ *   jobType: "EVENT_DETECTION",
+ *   startDate: new Date("TIMESTAMP"),
+ *   endDate: new Date("TIMESTAMP"),
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListEnrichmentJobsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListEnrichmentJobsResponse
+ * //   jobs: [ // EnrichmentJobSummaries // required
+ * //     { // EnrichmentJobSummary
+ * //       jobId: "STRING_VALUE", // required
+ * //       status: "PENDING" || "RUNNING" || "COMPLETED" || "FAILED" || "TIMED_OUT" || "CANCELLED", // required
+ * //       workspaceName: "STRING_VALUE", // required
+ * //       jobType: "EVENT_DETECTION", // required
+ * //       datasetId: "STRING_VALUE", // required
+ * //       propertyAlias: "STRING_VALUE",
+ * //       timeSeriesId: "STRING_VALUE",
+ * //       createdAt: new Date("TIMESTAMP"), // required
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListEnrichmentJobsCommandInput - {@link ListEnrichmentJobsCommandInput}
+ * @returns {@link ListEnrichmentJobsCommandOutput}
+ * @see {@link ListEnrichmentJobsCommandInput} for command's `input` shape.
+ * @see {@link ListEnrichmentJobsCommandOutput} for command's `response` shape.
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *
+ * @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 quota 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 ListEnrichmentJobsCommand extends ListEnrichmentJobsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListEnrichmentJobsRequest;
+            output: ListEnrichmentJobsResponse;
+        };
+        sdk: {
+            input: ListEnrichmentJobsCommandInput;
+            output: ListEnrichmentJobsCommandOutput;
+        };
+    };
+}