@aws-sdk/client-iotsitewise 3.1096.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,100 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeApplicationRequest, DescribeApplicationResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeApplicationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeApplicationCommandInput extends DescribeApplicationRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeApplicationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeApplicationCommandOutput extends DescribeApplicationResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeApplicationCommand_base: {
|
|
22
|
+
new (input: DescribeApplicationCommandInput): import("@smithy/core/client").CommandImpl<DescribeApplicationCommandInput, DescribeApplicationCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeApplicationCommandInput): import("@smithy/core/client").CommandImpl<DescribeApplicationCommandInput, DescribeApplicationCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves Application details based on the ID</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { IoTSiteWiseClient, DescribeApplicationCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
32
|
+
* // const { IoTSiteWiseClient, DescribeApplicationCommand } = 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 = { // DescribeApplicationRequest
|
|
37
|
+
* workspaceName: "STRING_VALUE", // required
|
|
38
|
+
* id: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeApplicationCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeApplicationResponse
|
|
43
|
+
* // arn: "STRING_VALUE", // required
|
|
44
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // dnsSubdomain: "STRING_VALUE", // required
|
|
46
|
+
* // description: "STRING_VALUE",
|
|
47
|
+
* // id: "STRING_VALUE", // required
|
|
48
|
+
* // idcApplicationArn: "STRING_VALUE", // required
|
|
49
|
+
* // name: "STRING_VALUE", // required
|
|
50
|
+
* // status: "CREATING" || "ACTIVE" || "DELETING", // required
|
|
51
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // workspaceName: "STRING_VALUE", // required
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param DescribeApplicationCommandInput - {@link DescribeApplicationCommandInput}
|
|
58
|
+
* @returns {@link DescribeApplicationCommandOutput}
|
|
59
|
+
* @see {@link DescribeApplicationCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link DescribeApplicationCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>Access is denied.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
67
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
70
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
71
|
+
* unsupported characters. Check your request and try again.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The requested resource can't be found.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
78
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
79
|
+
* on.</p>
|
|
80
|
+
* <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>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class DescribeApplicationCommand extends DescribeApplicationCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: DescribeApplicationRequest;
|
|
93
|
+
output: DescribeApplicationResponse;
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: DescribeApplicationCommandInput;
|
|
97
|
+
output: DescribeApplicationCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|
|
@@ -55,7 +55,7 @@ declare const DescribeAssetCommand_base: {
|
|
|
55
55
|
* // topic: "STRING_VALUE", // required
|
|
56
56
|
* // state: "ENABLED" || "DISABLED", // required
|
|
57
57
|
* // },
|
|
58
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
58
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
59
59
|
* // dataTypeSpec: "STRING_VALUE",
|
|
60
60
|
* // unit: "STRING_VALUE",
|
|
61
61
|
* // path: [ // AssetPropertyPath
|
|
@@ -88,7 +88,7 @@ declare const DescribeAssetCommand_base: {
|
|
|
88
88
|
* // topic: "STRING_VALUE", // required
|
|
89
89
|
* // state: "ENABLED" || "DISABLED", // required
|
|
90
90
|
* // },
|
|
91
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
91
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
92
92
|
* // dataTypeSpec: "STRING_VALUE",
|
|
93
93
|
* // unit: "STRING_VALUE",
|
|
94
94
|
* // path: [
|
|
@@ -65,7 +65,7 @@ declare const DescribeAssetCompositeModelCommand_base: {
|
|
|
65
65
|
* // topic: "STRING_VALUE", // required
|
|
66
66
|
* // state: "ENABLED" || "DISABLED", // required
|
|
67
67
|
* // },
|
|
68
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
68
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
69
69
|
* // dataTypeSpec: "STRING_VALUE",
|
|
70
70
|
* // unit: "STRING_VALUE",
|
|
71
71
|
* // path: [ // AssetPropertyPath
|
|
@@ -54,7 +54,7 @@ declare const DescribeAssetModelCommand_base: {
|
|
|
54
54
|
* // id: "STRING_VALUE",
|
|
55
55
|
* // externalId: "STRING_VALUE",
|
|
56
56
|
* // name: "STRING_VALUE", // required
|
|
57
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
57
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
58
58
|
* // dataTypeSpec: "STRING_VALUE",
|
|
59
59
|
* // unit: "STRING_VALUE",
|
|
60
60
|
* // type: { // PropertyType
|
|
@@ -146,7 +146,7 @@ declare const DescribeAssetModelCommand_base: {
|
|
|
146
146
|
* // id: "STRING_VALUE",
|
|
147
147
|
* // externalId: "STRING_VALUE",
|
|
148
148
|
* // name: "STRING_VALUE", // required
|
|
149
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
149
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
150
150
|
* // dataTypeSpec: "STRING_VALUE",
|
|
151
151
|
* // unit: "STRING_VALUE",
|
|
152
152
|
* // type: {
|
|
@@ -60,7 +60,7 @@ declare const DescribeAssetModelCompositeModelCommand_base: {
|
|
|
60
60
|
* // id: "STRING_VALUE",
|
|
61
61
|
* // externalId: "STRING_VALUE",
|
|
62
62
|
* // name: "STRING_VALUE", // required
|
|
63
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
63
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
64
64
|
* // dataTypeSpec: "STRING_VALUE",
|
|
65
65
|
* // unit: "STRING_VALUE",
|
|
66
66
|
* // type: { // PropertyType
|
|
@@ -60,7 +60,7 @@ declare const DescribeAssetPropertyCommand_base: {
|
|
|
60
60
|
* // topic: "STRING_VALUE", // required
|
|
61
61
|
* // state: "ENABLED" || "DISABLED", // required
|
|
62
62
|
* // },
|
|
63
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
63
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
64
64
|
* // unit: "STRING_VALUE",
|
|
65
65
|
* // type: { // PropertyType
|
|
66
66
|
* // attribute: { // Attribute
|
|
@@ -144,7 +144,7 @@ declare const DescribeAssetPropertyCommand_base: {
|
|
|
144
144
|
* // topic: "STRING_VALUE", // required
|
|
145
145
|
* // state: "ENABLED" || "DISABLED", // required
|
|
146
146
|
* // },
|
|
147
|
-
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
|
|
147
|
+
* // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
|
|
148
148
|
* // unit: "STRING_VALUE",
|
|
149
149
|
* // type: {
|
|
150
150
|
* // attribute: {
|
|
@@ -36,6 +36,7 @@ declare const DescribeBulkImportJobCommand_base: {
|
|
|
36
36
|
* const client = new IoTSiteWiseClient(config);
|
|
37
37
|
* const input = { // DescribeBulkImportJobRequest
|
|
38
38
|
* jobId: "STRING_VALUE", // required
|
|
39
|
+
* workspaceName: "STRING_VALUE",
|
|
39
40
|
* };
|
|
40
41
|
* const command = new DescribeBulkImportJobCommand(input);
|
|
41
42
|
* const response = await client.send(command);
|
|
@@ -49,6 +50,21 @@ declare const DescribeBulkImportJobCommand_base: {
|
|
|
49
50
|
* // bucket: "STRING_VALUE", // required
|
|
50
51
|
* // key: "STRING_VALUE", // required
|
|
51
52
|
* // versionId: "STRING_VALUE",
|
|
53
|
+
* // alias: "STRING_VALUE",
|
|
54
|
+
* // startTime: { // TimeInNanos
|
|
55
|
+
* // timeInSeconds: Number("long"), // required
|
|
56
|
+
* // offsetInNanos: Number("int"),
|
|
57
|
+
* // },
|
|
58
|
+
* // fileFormat: { // FileFormat
|
|
59
|
+
* // csv: { // Csv
|
|
60
|
+
* // columnNames: [ // ColumnNames // required
|
|
61
|
+
* // "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // parquet: {},
|
|
65
|
+
* // mp4: {},
|
|
66
|
+
* // annotation: {},
|
|
67
|
+
* // },
|
|
52
68
|
* // },
|
|
53
69
|
* // ],
|
|
54
70
|
* // errorReportLocation: { // ErrorReportLocation
|
|
@@ -56,19 +72,23 @@ declare const DescribeBulkImportJobCommand_base: {
|
|
|
56
72
|
* // prefix: "STRING_VALUE", // required
|
|
57
73
|
* // },
|
|
58
74
|
* // jobConfiguration: { // JobConfiguration
|
|
59
|
-
* // fileFormat: {
|
|
60
|
-
* // csv: {
|
|
61
|
-
* // columnNames: [ //
|
|
75
|
+
* // fileFormat: {
|
|
76
|
+
* // csv: {
|
|
77
|
+
* // columnNames: [ // required
|
|
62
78
|
* // "ALIAS" || "ASSET_ID" || "PROPERTY_ID" || "DATA_TYPE" || "TIMESTAMP_SECONDS" || "TIMESTAMP_NANO_OFFSET" || "QUALITY" || "VALUE",
|
|
63
79
|
* // ],
|
|
64
80
|
* // },
|
|
65
81
|
* // parquet: {},
|
|
82
|
+
* // mp4: {},
|
|
83
|
+
* // annotation: {},
|
|
66
84
|
* // },
|
|
67
85
|
* // },
|
|
68
86
|
* // jobCreationDate: new Date("TIMESTAMP"), // required
|
|
69
87
|
* // jobLastUpdateDate: new Date("TIMESTAMP"), // required
|
|
70
88
|
* // adaptiveIngestion: true || false,
|
|
71
89
|
* // deleteFilesAfterImport: true || false,
|
|
90
|
+
* // datasetId: "STRING_VALUE",
|
|
91
|
+
* // workspaceName: "STRING_VALUE",
|
|
72
92
|
* // };
|
|
73
93
|
*
|
|
74
94
|
* ```
|
|
@@ -35,6 +35,8 @@ declare const DescribeDatasetCommand_base: {
|
|
|
35
35
|
* const client = new IoTSiteWiseClient(config);
|
|
36
36
|
* const input = { // DescribeDatasetRequest
|
|
37
37
|
* datasetId: "STRING_VALUE", // required
|
|
38
|
+
* workspaceName: "STRING_VALUE",
|
|
39
|
+
* datasetVersion: "STRING_VALUE",
|
|
38
40
|
* };
|
|
39
41
|
* const command = new DescribeDatasetCommand(input);
|
|
40
42
|
* const response = await client.send(command);
|
|
@@ -43,9 +45,26 @@ declare const DescribeDatasetCommand_base: {
|
|
|
43
45
|
* // datasetArn: "STRING_VALUE", // required
|
|
44
46
|
* // datasetName: "STRING_VALUE", // required
|
|
45
47
|
* // datasetDescription: "STRING_VALUE", // required
|
|
48
|
+
* // datasetType: "SESSION" || "CURATED" || "EXTERNAL",
|
|
49
|
+
* // datasetConfig: { // DatasetConfig
|
|
50
|
+
* // session: { // SessionConfig
|
|
51
|
+
* // sessionStartTimestamp: { // TimeInNanos
|
|
52
|
+
* // timeInSeconds: Number("long"), // required
|
|
53
|
+
* // offsetInNanos: Number("int"),
|
|
54
|
+
* // },
|
|
55
|
+
* // sessionEndTimestamp: {
|
|
56
|
+
* // timeInSeconds: Number("long"), // required
|
|
57
|
+
* // offsetInNanos: Number("int"),
|
|
58
|
+
* // },
|
|
59
|
+
* // },
|
|
60
|
+
* // },
|
|
61
|
+
* // workspaceName: "STRING_VALUE",
|
|
62
|
+
* // metadata: { // Metadata
|
|
63
|
+
* // "<keys>": "STRING_VALUE",
|
|
64
|
+
* // },
|
|
46
65
|
* // datasetSource: { // DatasetSource
|
|
47
|
-
* // sourceType: "KENDRA", // required
|
|
48
|
-
* // sourceFormat: "KNOWLEDGE_BASE", // required
|
|
66
|
+
* // sourceType: "KENDRA" || "SITEWISE", // required
|
|
67
|
+
* // sourceFormat: "KNOWLEDGE_BASE" || "TIMESERIES", // required
|
|
49
68
|
* // sourceDetail: { // SourceDetail
|
|
50
69
|
* // kendra: { // KendraSourceDetail
|
|
51
70
|
* // knowledgeBaseArn: "STRING_VALUE", // required
|
|
@@ -69,6 +88,12 @@ declare const DescribeDatasetCommand_base: {
|
|
|
69
88
|
* // datasetCreationDate: new Date("TIMESTAMP"), // required
|
|
70
89
|
* // datasetLastUpdateDate: new Date("TIMESTAMP"), // required
|
|
71
90
|
* // datasetVersion: "STRING_VALUE",
|
|
91
|
+
* // enrichmentStatus: { // DatasetEnrichment
|
|
92
|
+
* // video: { // DatasetEnrichmentEntry
|
|
93
|
+
* // status: "FULLY_ENRICHED" || "PARTIALLY_ENRICHED" || "NOT_ENRICHED", // required
|
|
94
|
+
* // lastEnrichedAt: new Date("TIMESTAMP"),
|
|
95
|
+
* // },
|
|
96
|
+
* // },
|
|
72
97
|
* // };
|
|
73
98
|
*
|
|
74
99
|
* ```
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeDatasetExportJobRequest, DescribeDatasetExportJobResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeDatasetExportJobCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeDatasetExportJobCommandInput extends DescribeDatasetExportJobRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeDatasetExportJobCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeDatasetExportJobCommandOutput extends DescribeDatasetExportJobResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeDatasetExportJobCommand_base: {
|
|
22
|
+
new (input: DescribeDatasetExportJobCommandInput): import("@smithy/core/client").CommandImpl<DescribeDatasetExportJobCommandInput, DescribeDatasetExportJobCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeDatasetExportJobCommandInput): import("@smithy/core/client").CommandImpl<DescribeDatasetExportJobCommandInput, DescribeDatasetExportJobCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves information about a dataset export job.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { IoTSiteWiseClient, DescribeDatasetExportJobCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
32
|
+
* // const { IoTSiteWiseClient, DescribeDatasetExportJobCommand } = 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 = { // DescribeDatasetExportJobRequest
|
|
37
|
+
* workspaceName: "STRING_VALUE", // required
|
|
38
|
+
* jobId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DescribeDatasetExportJobCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DescribeDatasetExportJobResponse
|
|
43
|
+
* // jobId: "STRING_VALUE", // required
|
|
44
|
+
* // workspaceName: "STRING_VALUE", // required
|
|
45
|
+
* // status: "SUBMITTED" || "RUNNING" || "COMPLETED" || "COMPLETED_WITH_ERRORS" || "FAILED", // required
|
|
46
|
+
* // startedAt: new Date("TIMESTAMP"), // required
|
|
47
|
+
* // completedAt: new Date("TIMESTAMP"),
|
|
48
|
+
* // destinationS3Uri: "STRING_VALUE", // required
|
|
49
|
+
* // errorReportLocation: { // ExportErrorReportLocation
|
|
50
|
+
* // s3Uri: "STRING_VALUE", // required
|
|
51
|
+
* // },
|
|
52
|
+
* // input: { // ProcessingInput Union: only one key present
|
|
53
|
+
* // timeseries: [ // TimeseriesList
|
|
54
|
+
* // { // TimeseriesItem
|
|
55
|
+
* // timeSeriesId: "STRING_VALUE",
|
|
56
|
+
* // propertyAlias: "STRING_VALUE",
|
|
57
|
+
* // trimSettings: { // TrimSettings
|
|
58
|
+
* // startTime: { // TimeInNanos
|
|
59
|
+
* // timeInSeconds: Number("long"), // required
|
|
60
|
+
* // offsetInNanos: Number("int"),
|
|
61
|
+
* // },
|
|
62
|
+
* // endTime: {
|
|
63
|
+
* // timeInSeconds: Number("long"), // required
|
|
64
|
+
* // offsetInNanos: Number("int"),
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // formatSettings: { // FormatSettings
|
|
68
|
+
* // framesPerSecond: Number("int"),
|
|
69
|
+
* // widthInPixels: Number("int"),
|
|
70
|
+
* // heightInPixels: Number("int"),
|
|
71
|
+
* // },
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // dataset: { // DatasetItem
|
|
75
|
+
* // datasetId: "STRING_VALUE", // required
|
|
76
|
+
* // trimSettings: {
|
|
77
|
+
* // startTime: {
|
|
78
|
+
* // timeInSeconds: Number("long"), // required
|
|
79
|
+
* // offsetInNanos: Number("int"),
|
|
80
|
+
* // },
|
|
81
|
+
* // endTime: {
|
|
82
|
+
* // timeInSeconds: Number("long"), // required
|
|
83
|
+
* // offsetInNanos: Number("int"),
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // exportDataTypes: [ // ExportDataTypeList
|
|
87
|
+
* // "VIDEO" || "TELEMETRY" || "ANNOTATION",
|
|
88
|
+
* // ],
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
91
|
+
* // };
|
|
92
|
+
*
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
95
|
+
* @param DescribeDatasetExportJobCommandInput - {@link DescribeDatasetExportJobCommandInput}
|
|
96
|
+
* @returns {@link DescribeDatasetExportJobCommandOutput}
|
|
97
|
+
* @see {@link DescribeDatasetExportJobCommandInput} for command's `input` shape.
|
|
98
|
+
* @see {@link DescribeDatasetExportJobCommandOutput} for command's `response` shape.
|
|
99
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
102
|
+
* <p>Access is denied.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
105
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
108
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
109
|
+
* unsupported characters. Check your request and try again.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
112
|
+
* <p>The requested resource can't be found.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
115
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
116
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
117
|
+
* on.</p>
|
|
118
|
+
* <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>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
121
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
122
|
+
*
|
|
123
|
+
*
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export declare class DescribeDatasetExportJobCommand extends DescribeDatasetExportJobCommand_base {
|
|
127
|
+
/** @internal type navigation helper, not in runtime. */
|
|
128
|
+
protected static __types: {
|
|
129
|
+
api: {
|
|
130
|
+
input: DescribeDatasetExportJobRequest;
|
|
131
|
+
output: DescribeDatasetExportJobResponse;
|
|
132
|
+
};
|
|
133
|
+
sdk: {
|
|
134
|
+
input: DescribeDatasetExportJobCommandInput;
|
|
135
|
+
output: DescribeDatasetExportJobCommandOutput;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -65,6 +65,9 @@ declare const DescribeDefaultEncryptionConfigurationCommand_base: {
|
|
|
65
65
|
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
66
66
|
* unsupported characters. Check your request and try again.</p>
|
|
67
67
|
*
|
|
68
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
69
|
+
* <p>The requested resource can't be found.</p>
|
|
70
|
+
*
|
|
68
71
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
72
|
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
70
73
|
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { DescribeEnrichmentJobRequest, DescribeEnrichmentJobResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link DescribeEnrichmentJobCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface DescribeEnrichmentJobCommandInput extends DescribeEnrichmentJobRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link DescribeEnrichmentJobCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface DescribeEnrichmentJobCommandOutput extends DescribeEnrichmentJobResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const DescribeEnrichmentJobCommand_base: {
|
|
22
|
+
new (input: DescribeEnrichmentJobCommandInput): import("@smithy/core/client").CommandImpl<DescribeEnrichmentJobCommandInput, DescribeEnrichmentJobCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: DescribeEnrichmentJobCommandInput): import("@smithy/core/client").CommandImpl<DescribeEnrichmentJobCommandInput, DescribeEnrichmentJobCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Retrieves detailed information about a specific enrichment job, including its current status,
|
|
28
|
+
* configuration, and timestamps.</p>
|
|
29
|
+
* <h2>Use Cases</h2>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>Monitor job progress by checking status updates with DescribeEnrichmentJob</li>
|
|
32
|
+
* <li>Retrieve the complete job configuration submitted during creation</li>
|
|
33
|
+
* <li>Debug failed jobs by examining the failureMessage field</li>
|
|
34
|
+
* <li>Track job lifecycle with creation, update, completion, and cancellation timestamps</li>
|
|
35
|
+
* </ul>
|
|
36
|
+
* <h2>Status Monitoring</h2>
|
|
37
|
+
* <p>Jobs progress through statuses: PENDING → RUNNING → terminal state</p>
|
|
38
|
+
* <p>Terminal states:</p>
|
|
39
|
+
* <ul>
|
|
40
|
+
* <li>COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results</li>
|
|
41
|
+
* <li>FAILED: Job encountered an error; check failureMessage for details</li>
|
|
42
|
+
* <li>TIMED_OUT: Job exceeded maximum processing time</li>
|
|
43
|
+
* <li>CANCELLED: Job was cancelled via CancelEnrichmentJob</li>
|
|
44
|
+
* </ul>
|
|
45
|
+
* <h2>Response Fields</h2>
|
|
46
|
+
* <p>The response includes:</p>
|
|
47
|
+
* <ul>
|
|
48
|
+
* <li>Current job status and type</li>
|
|
49
|
+
* <li>Full job configuration as originally submitted</li>
|
|
50
|
+
* <li>Lifecycle timestamps (created, updated, completed, cancelled)</li>
|
|
51
|
+
* <li>Failure details if status is FAILED</li>
|
|
52
|
+
* </ul>
|
|
53
|
+
* @example
|
|
54
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
55
|
+
* ```javascript
|
|
56
|
+
* import { IoTSiteWiseClient, DescribeEnrichmentJobCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
57
|
+
* // const { IoTSiteWiseClient, DescribeEnrichmentJobCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
58
|
+
* // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
|
|
59
|
+
* const config = {}; // type is IoTSiteWiseClientConfig
|
|
60
|
+
* const client = new IoTSiteWiseClient(config);
|
|
61
|
+
* const input = { // DescribeEnrichmentJobRequest
|
|
62
|
+
* workspaceName: "STRING_VALUE", // required
|
|
63
|
+
* jobId: "STRING_VALUE", // required
|
|
64
|
+
* };
|
|
65
|
+
* const command = new DescribeEnrichmentJobCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* // { // DescribeEnrichmentJobResponse
|
|
68
|
+
* // jobId: "STRING_VALUE", // required
|
|
69
|
+
* // status: "PENDING" || "RUNNING" || "COMPLETED" || "FAILED" || "TIMED_OUT" || "CANCELLED", // required
|
|
70
|
+
* // workspaceName: "STRING_VALUE", // required
|
|
71
|
+
* // jobType: "EVENT_DETECTION", // required
|
|
72
|
+
* // jobConfiguration: { // EnrichmentJobConfiguration Union: only one key present
|
|
73
|
+
* // eventDetection: { // EventDetection
|
|
74
|
+
* // datasetId: "STRING_VALUE", // required
|
|
75
|
+
* // timeSeriesId: "STRING_VALUE",
|
|
76
|
+
* // propertyAlias: "STRING_VALUE",
|
|
77
|
+
* // trimSettings: { // EnrichmentTrimSettings
|
|
78
|
+
* // startTime: { // TimeInNanos
|
|
79
|
+
* // timeInSeconds: Number("long"), // required
|
|
80
|
+
* // offsetInNanos: Number("int"),
|
|
81
|
+
* // },
|
|
82
|
+
* // endTime: {
|
|
83
|
+
* // timeInSeconds: Number("long"), // required
|
|
84
|
+
* // offsetInNanos: Number("int"),
|
|
85
|
+
* // },
|
|
86
|
+
* // },
|
|
87
|
+
* // },
|
|
88
|
+
* // },
|
|
89
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
90
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
91
|
+
* // completedAt: new Date("TIMESTAMP"),
|
|
92
|
+
* // cancelledAt: new Date("TIMESTAMP"),
|
|
93
|
+
* // failureMessage: "STRING_VALUE",
|
|
94
|
+
* // };
|
|
95
|
+
*
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
98
|
+
* @param DescribeEnrichmentJobCommandInput - {@link DescribeEnrichmentJobCommandInput}
|
|
99
|
+
* @returns {@link DescribeEnrichmentJobCommandOutput}
|
|
100
|
+
* @see {@link DescribeEnrichmentJobCommandInput} for command's `input` shape.
|
|
101
|
+
* @see {@link DescribeEnrichmentJobCommandOutput} for command's `response` shape.
|
|
102
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
105
|
+
* <p>Access is denied.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ConflictingOperationException} (client fault)
|
|
108
|
+
* <p>Your request has conflicting operations. This can occur if you're trying to perform more
|
|
109
|
+
* than one operation on the same resource at the same time.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link InternalFailureException} (server fault)
|
|
112
|
+
* <p>IoT SiteWise can't process your request right now. Try again later.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
115
|
+
* <p>The request isn't valid. This can occur if your request contains malformed JSON or
|
|
116
|
+
* unsupported characters. Check your request and try again.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
119
|
+
* <p>You've reached the quota for a resource. For example, this can occur if you're trying to
|
|
120
|
+
* associate more than the allowed number of child assets or attempting to create more than the
|
|
121
|
+
* allowed number of properties for an asset model.</p>
|
|
122
|
+
* <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>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
125
|
+
* <p>The requested resource can't be found.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
128
|
+
* <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
|
|
129
|
+
* IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
|
|
130
|
+
* on.</p>
|
|
131
|
+
* <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>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link IoTSiteWiseServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
|
|
135
|
+
*
|
|
136
|
+
*
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare class DescribeEnrichmentJobCommand extends DescribeEnrichmentJobCommand_base {
|
|
140
|
+
/** @internal type navigation helper, not in runtime. */
|
|
141
|
+
protected static __types: {
|
|
142
|
+
api: {
|
|
143
|
+
input: DescribeEnrichmentJobRequest;
|
|
144
|
+
output: DescribeEnrichmentJobResponse;
|
|
145
|
+
};
|
|
146
|
+
sdk: {
|
|
147
|
+
input: DescribeEnrichmentJobCommandInput;
|
|
148
|
+
output: DescribeEnrichmentJobCommandOutput;
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
}
|
|
@@ -33,7 +33,9 @@ declare const DescribeLoggingOptionsCommand_base: {
|
|
|
33
33
|
* // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
|
|
34
34
|
* const config = {}; // type is IoTSiteWiseClientConfig
|
|
35
35
|
* const client = new IoTSiteWiseClient(config);
|
|
36
|
-
* const input = {
|
|
36
|
+
* const input = { // DescribeLoggingOptionsRequest
|
|
37
|
+
* workspaceName: "STRING_VALUE",
|
|
38
|
+
* };
|
|
37
39
|
* const command = new DescribeLoggingOptionsCommand(input);
|
|
38
40
|
* const response = await client.send(command);
|
|
39
41
|
* // { // DescribeLoggingOptionsResponse
|
|
@@ -76,7 +78,7 @@ export declare class DescribeLoggingOptionsCommand extends DescribeLoggingOption
|
|
|
76
78
|
/** @internal type navigation helper, not in runtime. */
|
|
77
79
|
protected static __types: {
|
|
78
80
|
api: {
|
|
79
|
-
input:
|
|
81
|
+
input: DescribeLoggingOptionsRequest;
|
|
80
82
|
output: DescribeLoggingOptionsResponse;
|
|
81
83
|
};
|
|
82
84
|
sdk: {
|