@aws-sdk/client-iotsitewise 3.1097.0 → 3.1098.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.
- package/README.md +315 -0
- package/dist-cjs/index.js +2189 -237
- package/dist-es/IoTSiteWise.js +118 -0
- package/dist-es/commands/BatchAssociateDataSegmentsToDatasetCommand.js +4 -0
- package/dist-es/commands/BatchDeleteDatasetDataSegmentsCommand.js +4 -0
- package/dist-es/commands/BatchDisassociateDataSegmentsFromDatasetCommand.js +4 -0
- package/dist-es/commands/CancelEnrichmentJobCommand.js +4 -0
- package/dist-es/commands/CancelPipelineExecutionCommand.js +4 -0
- package/dist-es/commands/CancelQueryCommand.js +4 -0
- package/dist-es/commands/CreateApplicationCommand.js +4 -0
- package/dist-es/commands/CreateDatasetExportJobCommand.js +4 -0
- package/dist-es/commands/CreateEnrichmentJobCommand.js +4 -0
- package/dist-es/commands/CreatePipelineCommand.js +4 -0
- package/dist-es/commands/CreateTaskCommand.js +4 -0
- package/dist-es/commands/CreateWorkspaceCommand.js +4 -0
- package/dist-es/commands/DeleteApplicationCommand.js +4 -0
- package/dist-es/commands/DeletePipelineCommand.js +4 -0
- package/dist-es/commands/DeleteTaskCommand.js +4 -0
- package/dist-es/commands/DeleteWorkspaceCommand.js +4 -0
- package/dist-es/commands/DescribeApplicationCommand.js +4 -0
- package/dist-es/commands/DescribeDatasetExportJobCommand.js +4 -0
- package/dist-es/commands/DescribeEnrichmentJobCommand.js +4 -0
- package/dist-es/commands/DescribePipelineCommand.js +4 -0
- package/dist-es/commands/DescribePipelineExecutionCommand.js +4 -0
- package/dist-es/commands/DescribeQueryCommand.js +4 -0
- package/dist-es/commands/DescribeSearchCommand.js +4 -0
- package/dist-es/commands/DescribeTaskCommand.js +4 -0
- package/dist-es/commands/DescribeWorkspaceCommand.js +4 -0
- package/dist-es/commands/GetCaptureDataCommand.js +4 -0
- package/dist-es/commands/GetQueryResultsCommand.js +4 -0
- package/dist-es/commands/GetSearchResultsCommand.js +4 -0
- package/dist-es/commands/ListApplicationsCommand.js +4 -0
- package/dist-es/commands/ListDatasetDataSegmentRelationshipsCommand.js +4 -0
- package/dist-es/commands/ListDatasetDataSegmentsCommand.js +4 -0
- package/dist-es/commands/ListDatasetExportJobsCommand.js +4 -0
- package/dist-es/commands/ListEnrichmentJobsCommand.js +4 -0
- package/dist-es/commands/ListPipelineExecutionsCommand.js +4 -0
- package/dist-es/commands/ListPipelinesCommand.js +4 -0
- package/dist-es/commands/ListQueriesCommand.js +4 -0
- package/dist-es/commands/ListSearchesCommand.js +4 -0
- package/dist-es/commands/ListTasksCommand.js +4 -0
- package/dist-es/commands/ListWorkspacesCommand.js +4 -0
- package/dist-es/commands/StartPipelineExecutionCommand.js +4 -0
- package/dist-es/commands/StartQueryCommand.js +4 -0
- package/dist-es/commands/StartSearchCommand.js +4 -0
- package/dist-es/commands/UpdatePipelineCommand.js +4 -0
- package/dist-es/commands/UpdateTaskCommand.js +4 -0
- package/dist-es/commands/UpdateWorkspaceCommand.js +4 -0
- package/dist-es/commands/index.js +45 -0
- package/dist-es/models/enums.js +157 -3
- package/dist-es/pagination/DescribePipelineExecutionPaginator.js +4 -0
- package/dist-es/pagination/GetQueryResultsPaginator.js +4 -0
- package/dist-es/pagination/GetSearchResultsPaginator.js +4 -0
- package/dist-es/pagination/ListApplicationsPaginator.js +4 -0
- package/dist-es/pagination/ListDatasetDataSegmentRelationshipsPaginator.js +4 -0
- package/dist-es/pagination/ListDatasetDataSegmentsPaginator.js +4 -0
- package/dist-es/pagination/ListDatasetExportJobsPaginator.js +4 -0
- package/dist-es/pagination/ListEnrichmentJobsPaginator.js +4 -0
- package/dist-es/pagination/ListPipelineExecutionsPaginator.js +4 -0
- package/dist-es/pagination/ListPipelinesPaginator.js +4 -0
- package/dist-es/pagination/ListQueriesPaginator.js +4 -0
- package/dist-es/pagination/ListSearchesPaginator.js +4 -0
- package/dist-es/pagination/ListTasksPaginator.js +4 -0
- package/dist-es/pagination/ListWorkspacesPaginator.js +4 -0
- package/dist-es/pagination/index.js +14 -0
- package/dist-es/schemas/schemas_0.js +1544 -233
- package/dist-types/IoTSiteWise.d.ts +415 -0
- package/dist-types/IoTSiteWiseClient.d.ts +47 -2
- package/dist-types/commands/BatchAssociateDataSegmentsToDatasetCommand.d.ts +133 -0
- package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +7 -1
- package/dist-types/commands/BatchDeleteDatasetDataSegmentsCommand.d.ts +123 -0
- package/dist-types/commands/BatchDisassociateDataSegmentsFromDatasetCommand.d.ts +125 -0
- package/dist-types/commands/CancelEnrichmentJobCommand.d.ts +124 -0
- package/dist-types/commands/CancelPipelineExecutionCommand.d.ts +103 -0
- package/dist-types/commands/CancelQueryCommand.d.ts +96 -0
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +7 -1
- package/dist-types/commands/CreateApplicationCommand.d.ts +111 -0
- package/dist-types/commands/CreateAssetModelCommand.d.ts +2 -2
- package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +2 -1
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +28 -5
- package/dist-types/commands/CreateDashboardCommand.d.ts +7 -1
- package/dist-types/commands/CreateDatasetCommand.d.ts +20 -3
- package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +141 -0
- package/dist-types/commands/CreateEnrichmentJobCommand.d.ts +147 -0
- package/dist-types/commands/CreatePipelineCommand.d.ts +136 -0
- package/dist-types/commands/CreatePortalCommand.d.ts +7 -1
- package/dist-types/commands/CreateProjectCommand.d.ts +7 -1
- package/dist-types/commands/CreateTaskCommand.d.ts +133 -0
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +119 -0
- package/dist-types/commands/DeleteApplicationCommand.d.ts +93 -0
- package/dist-types/commands/DeleteAssetCommand.d.ts +1 -0
- package/dist-types/commands/DeleteAssetModelCommand.d.ts +1 -0
- package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +2 -1
- package/dist-types/commands/DeletePipelineCommand.d.ts +104 -0
- package/dist-types/commands/DeleteTaskCommand.d.ts +103 -0
- package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +3 -1
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +103 -0
- package/dist-types/commands/DescribeApplicationCommand.d.ts +100 -0
- package/dist-types/commands/DescribeAssetCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetModelCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +2 -2
- package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +23 -3
- package/dist-types/commands/DescribeDatasetCommand.d.ts +27 -2
- package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +138 -0
- package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +3 -0
- package/dist-types/commands/DescribeEnrichmentJobCommand.d.ts +151 -0
- package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +4 -2
- package/dist-types/commands/DescribePipelineCommand.d.ts +120 -0
- package/dist-types/commands/DescribePipelineExecutionCommand.d.ts +156 -0
- package/dist-types/commands/DescribeQueryCommand.d.ts +100 -0
- package/dist-types/commands/DescribeSearchCommand.d.ts +102 -0
- package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTaskCommand.d.ts +120 -0
- package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +4 -2
- package/dist-types/commands/DescribeWorkspaceCommand.d.ts +105 -0
- package/dist-types/commands/DisassociateAssetsCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +1 -1
- package/dist-types/commands/ExecuteActionCommand.d.ts +1 -1
- package/dist-types/commands/ExecuteQueryCommand.d.ts +1 -2
- package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +1 -1
- package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +1 -1
- package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +1 -1
- package/dist-types/commands/GetCaptureDataCommand.d.ts +116 -0
- package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +1 -1
- package/dist-types/commands/GetQueryResultsCommand.d.ts +104 -0
- package/dist-types/commands/GetSearchResultsCommand.d.ts +118 -0
- package/dist-types/commands/InvokeAssistantCommand.d.ts +1 -1
- package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListActionsCommand.d.ts +1 -1
- package/dist-types/commands/ListApplicationsCommand.d.ts +101 -0
- package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +2 -2
- package/dist-types/commands/ListAssetModelsCommand.d.ts +4 -1
- package/dist-types/commands/ListAssetPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +1 -1
- package/dist-types/commands/ListBulkImportJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
- package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
- package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListComputationModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListDatasetDataSegmentRelationshipsCommand.d.ts +107 -0
- package/dist-types/commands/ListDatasetDataSegmentsCommand.d.ts +111 -0
- package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +102 -0
- package/dist-types/commands/ListDatasetsCommand.d.ts +16 -2
- package/dist-types/commands/ListEnrichmentJobsCommand.d.ts +151 -0
- package/dist-types/commands/ListExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/ListGatewaysCommand.d.ts +1 -1
- package/dist-types/commands/ListPipelineExecutionsCommand.d.ts +126 -0
- package/dist-types/commands/ListPipelinesCommand.d.ts +109 -0
- package/dist-types/commands/ListQueriesCommand.d.ts +101 -0
- package/dist-types/commands/ListSearchesCommand.d.ts +119 -0
- package/dist-types/commands/ListTasksCommand.d.ts +109 -0
- package/dist-types/commands/ListTimeSeriesCommand.d.ts +3 -1
- package/dist-types/commands/ListWorkspacesCommand.d.ts +103 -0
- package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +3 -0
- package/dist-types/commands/PutLoggingOptionsCommand.d.ts +1 -0
- package/dist-types/commands/StartPipelineExecutionCommand.d.ts +118 -0
- package/dist-types/commands/StartQueryCommand.d.ts +97 -0
- package/dist-types/commands/StartSearchCommand.d.ts +131 -0
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +7 -1
- package/dist-types/commands/UpdateAssetCommand.d.ts +1 -0
- package/dist-types/commands/UpdateAssetModelCommand.d.ts +3 -2
- package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +7 -1
- package/dist-types/commands/UpdateDatasetCommand.d.ts +21 -2
- package/dist-types/commands/UpdatePipelineCommand.d.ts +127 -0
- package/dist-types/commands/UpdatePortalCommand.d.ts +7 -1
- package/dist-types/commands/UpdateProjectCommand.d.ts +7 -1
- package/dist-types/commands/UpdateTaskCommand.d.ts +120 -0
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +109 -0
- package/dist-types/commands/index.d.ts +45 -0
- package/dist-types/models/enums.d.ts +350 -4
- package/dist-types/models/models_0.d.ts +2607 -2755
- package/dist-types/models/models_1.d.ts +4139 -33
- package/dist-types/pagination/DescribePipelineExecutionPaginator.d.ts +7 -0
- package/dist-types/pagination/GetQueryResultsPaginator.d.ts +7 -0
- package/dist-types/pagination/GetSearchResultsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListApplicationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDatasetDataSegmentRelationshipsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDatasetDataSegmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDatasetExportJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEnrichmentJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPipelineExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListPipelinesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListQueriesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSearchesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTasksPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWorkspacesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +14 -0
- package/dist-types/schemas/schemas_0.d.ts +190 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +841 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +248 -2
- package/dist-types/ts3.4/commands/BatchAssociateDataSegmentsToDatasetCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/BatchDeleteDatasetDataSegmentsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/BatchDisassociateDataSegmentsFromDatasetCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CancelEnrichmentJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CancelPipelineExecutionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CancelQueryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateApplicationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateDatasetExportJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateEnrichmentJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreatePipelineCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateTaskCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteApplicationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeletePipelineCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteTaskCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteWorkspaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeApplicationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DescribeDatasetExportJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeEnrichmentJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DescribeLoggingOptionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribePipelineCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribePipelineExecutionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeQueryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeSearchCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTaskCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeTimeSeriesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeWorkspaceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DisassociateAssetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ExecuteActionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/GetAssetPropertyAggregatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAssetPropertyValueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAssetPropertyValueHistoryCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetCaptureDataCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetQueryResultsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetSearchResultsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/InvokeAssistantCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListApplicationsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetModelsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetRelationshipsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAssociatedAssetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBulkImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListComputationModelsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDatasetDataSegmentRelationshipsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListDatasetDataSegmentsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListDatasetExportJobsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListEnrichmentJobsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGatewaysCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPipelineExecutionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListQueriesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListSearchesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListWorkspacesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartPipelineExecutionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/StartQueryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartSearchCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdatePipelineCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateTaskCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateWorkspaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +45 -0
- package/dist-types/ts3.4/models/enums.d.ts +188 -4
- package/dist-types/ts3.4/models/models_0.d.ts +550 -614
- package/dist-types/ts3.4/models/models_1.d.ts +1048 -4
- package/dist-types/ts3.4/pagination/DescribePipelineExecutionPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetQueryResultsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetSearchResultsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListApplicationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDatasetDataSegmentRelationshipsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDatasetDataSegmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDatasetExportJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEnrichmentJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPipelineExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListPipelinesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListQueriesPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListSearchesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTasksPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListWorkspacesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +14 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +190 -0
- package/package.json +6 -6
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CancelEnrichmentJobRequest, CancelEnrichmentJobResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CancelEnrichmentJobCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CancelEnrichmentJobCommandInput extends CancelEnrichmentJobRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CancelEnrichmentJobCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelEnrichmentJobCommandOutput extends CancelEnrichmentJobResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CancelEnrichmentJobCommand_base: {
|
|
22
|
+
new (input: CancelEnrichmentJobCommandInput): import("@smithy/core/client").CommandImpl<CancelEnrichmentJobCommandInput, CancelEnrichmentJobCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CancelEnrichmentJobCommandInput): import("@smithy/core/client").CommandImpl<CancelEnrichmentJobCommandInput, CancelEnrichmentJobCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple
|
|
28
|
+
* times with the same jobId is safe and returns the current status.</p>
|
|
29
|
+
* <h2>Behavior</h2>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>Jobs in PENDING or RUNNING status transition to CANCELLED</li>
|
|
32
|
+
* <li>Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages</li>
|
|
33
|
+
* <li>Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled;
|
|
34
|
+
* the operation returns a ConflictingOperationException</li>
|
|
35
|
+
* <li>Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)</li>
|
|
36
|
+
* <li>The API responds immediately after recording the cancellation</li>
|
|
37
|
+
* <li>Cleanup of job resources happens asynchronously in the background</li>
|
|
38
|
+
* </ul>
|
|
39
|
+
* <h2>When to Cancel</h2>
|
|
40
|
+
* <p>Cancel a job when:</p>
|
|
41
|
+
* <ul>
|
|
42
|
+
* <li>The job is taking longer than expected</li>
|
|
43
|
+
* <li>The job was created with incorrect parameters</li>
|
|
44
|
+
* <li>You no longer need the results</li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* <h2>Idempotency</h2>
|
|
47
|
+
* <p>You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same
|
|
48
|
+
* job returns the current status without error as long as the job is not in a terminal state other
|
|
49
|
+
* than CANCELLED.</p>
|
|
50
|
+
* @example
|
|
51
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
52
|
+
* ```javascript
|
|
53
|
+
* import { IoTSiteWiseClient, CancelEnrichmentJobCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
54
|
+
* // const { IoTSiteWiseClient, CancelEnrichmentJobCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
55
|
+
* // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
|
|
56
|
+
* const config = {}; // type is IoTSiteWiseClientConfig
|
|
57
|
+
* const client = new IoTSiteWiseClient(config);
|
|
58
|
+
* const input = { // CancelEnrichmentJobRequest
|
|
59
|
+
* workspaceName: "STRING_VALUE", // required
|
|
60
|
+
* jobId: "STRING_VALUE", // required
|
|
61
|
+
* };
|
|
62
|
+
* const command = new CancelEnrichmentJobCommand(input);
|
|
63
|
+
* const response = await client.send(command);
|
|
64
|
+
* // { // CancelEnrichmentJobResponse
|
|
65
|
+
* // jobId: "STRING_VALUE", // required
|
|
66
|
+
* // status: "PENDING" || "RUNNING" || "COMPLETED" || "FAILED" || "TIMED_OUT" || "CANCELLED", // required
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
71
|
+
* @param CancelEnrichmentJobCommandInput - {@link CancelEnrichmentJobCommandInput}
|
|
72
|
+
* @returns {@link CancelEnrichmentJobCommandOutput}
|
|
73
|
+
* @see {@link CancelEnrichmentJobCommandInput} for command's `input` shape.
|
|
74
|
+
* @see {@link CancelEnrichmentJobCommandOutput} for command's `response` shape.
|
|
75
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
78
|
+
* <p>Access is denied.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
81
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
82
|
+
* than one operation on the same resource at the same time.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
85
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
88
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
89
|
+
* unsupported characters. Check your request and try again.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
92
|
+
* <p>You've reached the quota for a resource. For example, this can occur if you're trying to
|
|
93
|
+
* associate more than the allowed number of child assets or attempting to create more than the
|
|
94
|
+
* allowed number of properties for an asset model.</p>
|
|
95
|
+
* <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>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
98
|
+
* <p>The requested resource can't be found.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
101
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
102
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
103
|
+
* on.</p>
|
|
104
|
+
* <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>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
108
|
+
*
|
|
109
|
+
*
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
export declare class CancelEnrichmentJobCommand extends CancelEnrichmentJobCommand_base {
|
|
113
|
+
/** @internal type navigation helper, not in runtime. */
|
|
114
|
+
protected static __types: {
|
|
115
|
+
api: {
|
|
116
|
+
input: CancelEnrichmentJobRequest;
|
|
117
|
+
output: CancelEnrichmentJobResponse;
|
|
118
|
+
};
|
|
119
|
+
sdk: {
|
|
120
|
+
input: CancelEnrichmentJobCommandInput;
|
|
121
|
+
output: CancelEnrichmentJobCommandOutput;
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
}
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CancelPipelineExecutionRequest, CancelPipelineExecutionResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CancelPipelineExecutionCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CancelPipelineExecutionCommandInput extends CancelPipelineExecutionRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CancelPipelineExecutionCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelPipelineExecutionCommandOutput extends CancelPipelineExecutionResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CancelPipelineExecutionCommand_base: {
|
|
22
|
+
new (input: CancelPipelineExecutionCommandInput): import("@smithy/core/client").CommandImpl<CancelPipelineExecutionCommandInput, CancelPipelineExecutionCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CancelPipelineExecutionCommandInput): import("@smithy/core/client").CommandImpl<CancelPipelineExecutionCommandInput, CancelPipelineExecutionCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Cancels a pipeline execution in the specified workspace. If the execution
|
|
28
|
+
* is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to
|
|
29
|
+
* CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling
|
|
30
|
+
* it on an execution that is already CANCELLING or CANCELLED returns success with
|
|
31
|
+
* the current state. Calling it on a terminal execution (SUCCEEDED or FAILED)
|
|
32
|
+
* returns a conflict error. You can optionally provide a reason; it is returned in
|
|
33
|
+
* the stateDetails field when you describe the execution.</p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { IoTSiteWiseClient, CancelPipelineExecutionCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
38
|
+
* // const { IoTSiteWiseClient, CancelPipelineExecutionCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
39
|
+
* // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
|
|
40
|
+
* const config = {}; // type is IoTSiteWiseClientConfig
|
|
41
|
+
* const client = new IoTSiteWiseClient(config);
|
|
42
|
+
* const input = { // CancelPipelineExecutionRequest
|
|
43
|
+
* workspaceName: "STRING_VALUE", // required
|
|
44
|
+
* pipelineName: "STRING_VALUE", // required
|
|
45
|
+
* pipelineExecutionId: "STRING_VALUE", // required
|
|
46
|
+
* reason: "STRING_VALUE",
|
|
47
|
+
* };
|
|
48
|
+
* const command = new CancelPipelineExecutionCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // CancelPipelineExecutionResponse
|
|
51
|
+
* // state: "NOT_STARTED" || "RUNNING" || "SUCCEEDED" || "FAILED" || "CANCELLING" || "CANCELLED", // required
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param CancelPipelineExecutionCommandInput - {@link CancelPipelineExecutionCommandInput}
|
|
57
|
+
* @returns {@link CancelPipelineExecutionCommandOutput}
|
|
58
|
+
* @see {@link CancelPipelineExecutionCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link CancelPipelineExecutionCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>Access is denied.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
66
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
67
|
+
* than one operation on the same resource at the same time.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
70
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
73
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
74
|
+
* unsupported characters. Check your request and try again.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The requested resource can't be found.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
80
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
81
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
82
|
+
* on.</p>
|
|
83
|
+
* <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>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export declare class CancelPipelineExecutionCommand extends CancelPipelineExecutionCommand_base {
|
|
92
|
+
/** @internal type navigation helper, not in runtime. */
|
|
93
|
+
protected static __types: {
|
|
94
|
+
api: {
|
|
95
|
+
input: CancelPipelineExecutionRequest;
|
|
96
|
+
output: CancelPipelineExecutionResponse;
|
|
97
|
+
};
|
|
98
|
+
sdk: {
|
|
99
|
+
input: CancelPipelineExecutionCommandInput;
|
|
100
|
+
output: CancelPipelineExecutionCommandOutput;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CancelQueryRequest, CancelQueryResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CancelQueryCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CancelQueryCommandInput extends CancelQueryRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CancelQueryCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CancelQueryCommandOutput extends CancelQueryResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CancelQueryCommand_base: {
|
|
22
|
+
new (input: CancelQueryCommandInput): import("@smithy/core/client").CommandImpl<CancelQueryCommandInput, CancelQueryCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CancelQueryCommandInput): import("@smithy/core/client").CommandImpl<CancelQueryCommandInput, CancelQueryCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Cancels a running query.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { IoTSiteWiseClient, CancelQueryCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
32
|
+
* // const { IoTSiteWiseClient, CancelQueryCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
33
|
+
* // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
|
|
34
|
+
* const config = {}; // type is IoTSiteWiseClientConfig
|
|
35
|
+
* const client = new IoTSiteWiseClient(config);
|
|
36
|
+
* const input = { // CancelQueryRequest
|
|
37
|
+
* workspaceName: "STRING_VALUE", // required
|
|
38
|
+
* queryId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new CancelQueryCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // CancelQueryResponse
|
|
43
|
+
* // queryId: "STRING_VALUE", // required
|
|
44
|
+
* // status: "SUBMITTED" || "RUNNING" || "COMPLETED" || "FAILED" || "CANCELED" || "CANCELING", // required
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param CancelQueryCommandInput - {@link CancelQueryCommandInput}
|
|
50
|
+
* @returns {@link CancelQueryCommandOutput}
|
|
51
|
+
* @see {@link CancelQueryCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link CancelQueryCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>Access is denied.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
59
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
60
|
+
* than one operation on the same resource at the same time.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
63
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
66
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
67
|
+
* unsupported characters. Check your request and try again.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The requested resource can't be found.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
73
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
74
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
75
|
+
* on.</p>
|
|
76
|
+
* <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>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
80
|
+
*
|
|
81
|
+
*
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export declare class CancelQueryCommand extends CancelQueryCommand_base {
|
|
85
|
+
/** @internal type navigation helper, not in runtime. */
|
|
86
|
+
protected static __types: {
|
|
87
|
+
api: {
|
|
88
|
+
input: CancelQueryRequest;
|
|
89
|
+
output: CancelQueryResponse;
|
|
90
|
+
};
|
|
91
|
+
sdk: {
|
|
92
|
+
input: CancelQueryCommandInput;
|
|
93
|
+
output: CancelQueryCommandOutput;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
}
|
|
@@ -24,7 +24,13 @@ declare const CreateAccessPolicyCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>The IoT SiteWise Monitor feature will no longer be open to new
|
|
29
|
+
* customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can
|
|
30
|
+
* continue to use the service as normal. For more information, see
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html">IoT SiteWise Monitor availability change</a>.</p>
|
|
32
|
+
* </important>
|
|
33
|
+
* <p>Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or
|
|
28
34
|
* IAM user) access to the specified IoT SiteWise Monitor portal or project resource.</p>
|
|
29
35
|
* <note>
|
|
30
36
|
* <p>Support for access policies that use an SSO Group as the identity is not supported at this time.</p>
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { CreateApplicationRequest, CreateApplicationResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link CreateApplicationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface CreateApplicationCommandInput extends CreateApplicationRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link CreateApplicationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface CreateApplicationCommandOutput extends CreateApplicationResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const CreateApplicationCommand_base: {
|
|
22
|
+
new (input: CreateApplicationCommandInput): import("@smithy/core/client").CommandImpl<CreateApplicationCommandInput, CreateApplicationCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: CreateApplicationCommandInput): import("@smithy/core/client").CommandImpl<CreateApplicationCommandInput, CreateApplicationCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Creates a new application for the workspace and IdC application provided</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { IoTSiteWiseClient, CreateApplicationCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
32
|
+
* // const { IoTSiteWiseClient, CreateApplicationCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
33
|
+
* // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
|
|
34
|
+
* const config = {}; // type is IoTSiteWiseClientConfig
|
|
35
|
+
* const client = new IoTSiteWiseClient(config);
|
|
36
|
+
* const input = { // CreateApplicationRequest
|
|
37
|
+
* clientToken: "STRING_VALUE",
|
|
38
|
+
* idcInstanceArn: "STRING_VALUE", // required
|
|
39
|
+
* workspaceName: "STRING_VALUE", // required
|
|
40
|
+
* name: "STRING_VALUE", // required
|
|
41
|
+
* description: "STRING_VALUE",
|
|
42
|
+
* tags: { // TagMap
|
|
43
|
+
* "<keys>": "STRING_VALUE",
|
|
44
|
+
* },
|
|
45
|
+
* };
|
|
46
|
+
* const command = new CreateApplicationCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // CreateApplicationResponse
|
|
49
|
+
* // arn: "STRING_VALUE", // required
|
|
50
|
+
* // id: "STRING_VALUE", // required
|
|
51
|
+
* // dnsSubdomain: "STRING_VALUE", // required
|
|
52
|
+
* // name: "STRING_VALUE", // required
|
|
53
|
+
* // status: "CREATING" || "ACTIVE" || "DELETING", // required
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param CreateApplicationCommandInput - {@link CreateApplicationCommandInput}
|
|
59
|
+
* @returns {@link CreateApplicationCommandOutput}
|
|
60
|
+
* @see {@link CreateApplicationCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link CreateApplicationCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
* <p>Access is denied.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
68
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
69
|
+
* than one operation on the same resource at the same time.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
72
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
75
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
76
|
+
* unsupported characters. Check your request and try again.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
79
|
+
* <p>You've reached the quota for a resource. For example, this can occur if you're trying to
|
|
80
|
+
* associate more than the allowed number of child assets or attempting to create more than the
|
|
81
|
+
* allowed number of properties for an asset model.</p>
|
|
82
|
+
* <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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>The requested resource can't be found.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
89
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
90
|
+
* on.</p>
|
|
91
|
+
* <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>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class CreateApplicationCommand extends CreateApplicationCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: CreateApplicationRequest;
|
|
104
|
+
output: CreateApplicationResponse;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: CreateApplicationCommandInput;
|
|
108
|
+
output: CreateApplicationCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -69,7 +69,7 @@ declare const CreateAssetModelCommand_base: {
|
|
|
69
69
|
* id: "STRING_VALUE",
|
|
70
70
|
* externalId: "STRING_VALUE",
|
|
71
71
|
* name: "STRING_VALUE", // required
|
|
72
|
-
* dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
72
|
+
* dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
73
73
|
* dataTypeSpec: "STRING_VALUE",
|
|
74
74
|
* unit: "STRING_VALUE",
|
|
75
75
|
* type: { // PropertyType
|
|
@@ -157,7 +157,7 @@ declare const CreateAssetModelCommand_base: {
|
|
|
157
157
|
* id: "STRING_VALUE",
|
|
158
158
|
* externalId: "STRING_VALUE",
|
|
159
159
|
* name: "STRING_VALUE", // required
|
|
160
|
-
* dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
160
|
+
* dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
161
161
|
* dataTypeSpec: "STRING_VALUE",
|
|
162
162
|
* unit: "STRING_VALUE",
|
|
163
163
|
* type: {
|
|
@@ -64,7 +64,7 @@ declare const CreateAssetModelCompositeModelCommand_base: {
|
|
|
64
64
|
* id: "STRING_VALUE",
|
|
65
65
|
* externalId: "STRING_VALUE",
|
|
66
66
|
* name: "STRING_VALUE", // required
|
|
67
|
-
* dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
67
|
+
* dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
68
68
|
* dataTypeSpec: "STRING_VALUE",
|
|
69
69
|
* unit: "STRING_VALUE",
|
|
70
70
|
* type: { // PropertyType
|
|
@@ -159,6 +159,7 @@ declare const CreateAssetModelCompositeModelCommand_base: {
|
|
|
159
159
|
* // ],
|
|
160
160
|
* // },
|
|
161
161
|
* // },
|
|
162
|
+
* // assetModelId: "STRING_VALUE",
|
|
162
163
|
* // };
|
|
163
164
|
*
|
|
164
165
|
* ```
|
|
@@ -27,8 +27,12 @@ declare const CreateBulkImportJobCommand_base: {
|
|
|
27
27
|
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a
|
|
28
28
|
* bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
29
29
|
* <important>
|
|
30
|
-
* <p>Before you create a bulk import job
|
|
31
|
-
*
|
|
30
|
+
* <p>Before you create a bulk import job that ingests data into time series outside of a
|
|
31
|
+
* workspace, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how
|
|
32
|
+
* to configure storage settings, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>. This requirement doesn't apply to bulk import jobs that
|
|
33
|
+
* ingest data into a session dataset in a workspace (jobs that specify a
|
|
34
|
+
* <code>workspaceName</code> and <code>datasetId</code>). Those jobs don't use IoT SiteWise warm or
|
|
35
|
+
* cold tier storage.</p>
|
|
32
36
|
* <p>Bulk import is designed to store historical data to IoT SiteWise.</p>
|
|
33
37
|
* <ul>
|
|
34
38
|
* <li>
|
|
@@ -59,6 +63,21 @@ declare const CreateBulkImportJobCommand_base: {
|
|
|
59
63
|
* bucket: "STRING_VALUE", // required
|
|
60
64
|
* key: "STRING_VALUE", // required
|
|
61
65
|
* versionId: "STRING_VALUE",
|
|
66
|
+
* alias: "STRING_VALUE",
|
|
67
|
+
* startTime: { // TimeInNanos
|
|
68
|
+
* timeInSeconds: Number("long"), // required
|
|
69
|
+
* offsetInNanos: Number("int"),
|
|
70
|
+
* },
|
|
71
|
+
* fileFormat: { // FileFormat
|
|
72
|
+
* csv: { // Csv
|
|
73
|
+
* columnNames: [ // ColumnNames // required
|
|
74
|
+
* "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
|
|
75
|
+
* ],
|
|
76
|
+
* },
|
|
77
|
+
* parquet: {},
|
|
78
|
+
* mp4: {},
|
|
79
|
+
* annotation: {},
|
|
80
|
+
* },
|
|
62
81
|
* },
|
|
63
82
|
* ],
|
|
64
83
|
* errorReportLocation: { // ErrorReportLocation
|
|
@@ -66,17 +85,21 @@ declare const CreateBulkImportJobCommand_base: {
|
|
|
66
85
|
* prefix: "STRING_VALUE", // required
|
|
67
86
|
* },
|
|
68
87
|
* jobConfiguration: { // JobConfiguration
|
|
69
|
-
* fileFormat: {
|
|
70
|
-
* csv: {
|
|
71
|
-
* columnNames: [ //
|
|
88
|
+
* fileFormat: {
|
|
89
|
+
* csv: {
|
|
90
|
+
* columnNames: [ // required
|
|
72
91
|
* "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
|
|
73
92
|
* ],
|
|
74
93
|
* },
|
|
75
94
|
* parquet: {},
|
|
95
|
+
* mp4: {},
|
|
96
|
+
* annotation: {},
|
|
76
97
|
* },
|
|
77
98
|
* },
|
|
78
99
|
* adaptiveIngestion: true || false,
|
|
79
100
|
* deleteFilesAfterImport: true || false,
|
|
101
|
+
* datasetId: "STRING_VALUE",
|
|
102
|
+
* workspaceName: "STRING_VALUE",
|
|
80
103
|
* };
|
|
81
104
|
* const command = new CreateBulkImportJobCommand(input);
|
|
82
105
|
* const response = await client.send(command);
|
|
@@ -24,7 +24,13 @@ declare const CreateDashboardCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>The IoT SiteWise Monitor feature will no longer be open to new
|
|
29
|
+
* customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can
|
|
30
|
+
* continue to use the service as normal. For more information, see
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html">IoT SiteWise Monitor availability change</a>.</p>
|
|
32
|
+
* </important>
|
|
33
|
+
* <p>Creates a dashboard in an IoT SiteWise Monitor project.</p>
|
|
28
34
|
* @example
|
|
29
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
36
|
* ```javascript
|
|
@@ -24,7 +24,7 @@ declare const CreateDatasetCommand_base: {
|
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>Creates a dataset to
|
|
27
|
+
* <p>Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -37,9 +37,26 @@ declare const CreateDatasetCommand_base: {
|
|
|
37
37
|
* datasetId: "STRING_VALUE",
|
|
38
38
|
* datasetName: "STRING_VALUE", // required
|
|
39
39
|
* datasetDescription: "STRING_VALUE",
|
|
40
|
+
* datasetType: "SESSION" || "CURATED" || "EXTERNAL",
|
|
41
|
+
* datasetConfig: { // DatasetConfig
|
|
42
|
+
* session: { // SessionConfig
|
|
43
|
+
* sessionStartTimestamp: { // TimeInNanos
|
|
44
|
+
* timeInSeconds: Number("long"), // required
|
|
45
|
+
* offsetInNanos: Number("int"),
|
|
46
|
+
* },
|
|
47
|
+
* sessionEndTimestamp: {
|
|
48
|
+
* timeInSeconds: Number("long"), // required
|
|
49
|
+
* offsetInNanos: Number("int"),
|
|
50
|
+
* },
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* workspaceName: "STRING_VALUE",
|
|
54
|
+
* metadata: { // Metadata
|
|
55
|
+
* "<keys>": "STRING_VALUE",
|
|
56
|
+
* },
|
|
40
57
|
* datasetSource: { // DatasetSource
|
|
41
|
-
* sourceType: "KENDRA", // required
|
|
42
|
-
* sourceFormat: "KNOWLEDGE_BASE", // required
|
|
58
|
+
* sourceType: "KENDRA" || "SITEWISE", // required
|
|
59
|
+
* sourceFormat: "KNOWLEDGE_BASE" || "TIMESERIES", // required
|
|
43
60
|
* sourceDetail: { // SourceDetail
|
|
44
61
|
* kendra: { // KendraSourceDetail
|
|
45
62
|
* knowledgeBaseArn: "STRING_VALUE", // required
|