@aws-sdk/client-iotsitewise 3.128.0 → 3.135.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/CHANGELOG.md +30 -0
- package/dist-cjs/IoTSiteWise.js +45 -0
- package/dist-cjs/commands/CreateBulkImportJobCommand.js +36 -0
- package/dist-cjs/commands/DescribeBulkImportJobCommand.js +36 -0
- package/dist-cjs/commands/ListBulkImportJobsCommand.js +36 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +106 -4
- package/dist-cjs/pagination/ListBulkImportJobsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +414 -3
- package/dist-es/IoTSiteWise.js +45 -0
- package/dist-es/commands/CreateBulkImportJobCommand.js +39 -0
- package/dist-es/commands/DescribeBulkImportJobCommand.js +39 -0
- package/dist-es/commands/ListBulkImportJobsCommand.js +39 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +78 -0
- package/dist-es/pagination/ListBulkImportJobsPaginator.js +75 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +478 -0
- package/dist-types/IoTSiteWise.d.ts +44 -0
- package/dist-types/IoTSiteWiseClient.d.ts +5 -2
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +46 -0
- package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +41 -0
- package/dist-types/commands/ListBulkImportJobsCommand.d.ts +41 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +366 -0
- package/dist-types/pagination/ListBulkImportJobsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +15 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +5 -2
- package/dist-types/ts3.4/commands/CreateBulkImportJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeBulkImportJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListBulkImportJobsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +173 -0
- package/dist-types/ts3.4/pagination/ListBulkImportJobsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +9 -0
- package/package.json +7 -7
|
@@ -17,6 +17,7 @@ import { BatchPutAssetPropertyValueCommandInput, BatchPutAssetPropertyValueComma
|
|
|
17
17
|
import { CreateAccessPolicyCommandInput, CreateAccessPolicyCommandOutput } from "./commands/CreateAccessPolicyCommand";
|
|
18
18
|
import { CreateAssetCommandInput, CreateAssetCommandOutput } from "./commands/CreateAssetCommand";
|
|
19
19
|
import { CreateAssetModelCommandInput, CreateAssetModelCommandOutput } from "./commands/CreateAssetModelCommand";
|
|
20
|
+
import { CreateBulkImportJobCommandInput, CreateBulkImportJobCommandOutput } from "./commands/CreateBulkImportJobCommand";
|
|
20
21
|
import { CreateDashboardCommandInput, CreateDashboardCommandOutput } from "./commands/CreateDashboardCommand";
|
|
21
22
|
import { CreateGatewayCommandInput, CreateGatewayCommandOutput } from "./commands/CreateGatewayCommand";
|
|
22
23
|
import { CreatePortalCommandInput, CreatePortalCommandOutput } from "./commands/CreatePortalCommand";
|
|
@@ -33,6 +34,7 @@ import { DescribeAccessPolicyCommandInput, DescribeAccessPolicyCommandOutput } f
|
|
|
33
34
|
import { DescribeAssetCommandInput, DescribeAssetCommandOutput } from "./commands/DescribeAssetCommand";
|
|
34
35
|
import { DescribeAssetModelCommandInput, DescribeAssetModelCommandOutput } from "./commands/DescribeAssetModelCommand";
|
|
35
36
|
import { DescribeAssetPropertyCommandInput, DescribeAssetPropertyCommandOutput } from "./commands/DescribeAssetPropertyCommand";
|
|
37
|
+
import { DescribeBulkImportJobCommandInput, DescribeBulkImportJobCommandOutput } from "./commands/DescribeBulkImportJobCommand";
|
|
36
38
|
import { DescribeDashboardCommandInput, DescribeDashboardCommandOutput } from "./commands/DescribeDashboardCommand";
|
|
37
39
|
import { DescribeDefaultEncryptionConfigurationCommandInput, DescribeDefaultEncryptionConfigurationCommandOutput } from "./commands/DescribeDefaultEncryptionConfigurationCommand";
|
|
38
40
|
import { DescribeGatewayCapabilityConfigurationCommandInput, DescribeGatewayCapabilityConfigurationCommandOutput } from "./commands/DescribeGatewayCapabilityConfigurationCommand";
|
|
@@ -53,6 +55,7 @@ import { ListAssetModelsCommandInput, ListAssetModelsCommandOutput } from "./com
|
|
|
53
55
|
import { ListAssetRelationshipsCommandInput, ListAssetRelationshipsCommandOutput } from "./commands/ListAssetRelationshipsCommand";
|
|
54
56
|
import { ListAssetsCommandInput, ListAssetsCommandOutput } from "./commands/ListAssetsCommand";
|
|
55
57
|
import { ListAssociatedAssetsCommandInput, ListAssociatedAssetsCommandOutput } from "./commands/ListAssociatedAssetsCommand";
|
|
58
|
+
import { ListBulkImportJobsCommandInput, ListBulkImportJobsCommandOutput } from "./commands/ListBulkImportJobsCommand";
|
|
56
59
|
import { ListDashboardsCommandInput, ListDashboardsCommandOutput } from "./commands/ListDashboardsCommand";
|
|
57
60
|
import { ListGatewaysCommandInput, ListGatewaysCommandOutput } from "./commands/ListGatewaysCommand";
|
|
58
61
|
import { ListPortalsCommandInput, ListPortalsCommandOutput } from "./commands/ListPortalsCommand";
|
|
@@ -74,8 +77,8 @@ import { UpdateGatewayCapabilityConfigurationCommandInput, UpdateGatewayCapabili
|
|
|
74
77
|
import { UpdateGatewayCommandInput, UpdateGatewayCommandOutput } from "./commands/UpdateGatewayCommand";
|
|
75
78
|
import { UpdatePortalCommandInput, UpdatePortalCommandOutput } from "./commands/UpdatePortalCommand";
|
|
76
79
|
import { UpdateProjectCommandInput, UpdateProjectCommandOutput } from "./commands/UpdateProjectCommand";
|
|
77
|
-
export declare type ServiceInputTypes = AssociateAssetsCommandInput | AssociateTimeSeriesToAssetPropertyCommandInput | BatchAssociateProjectAssetsCommandInput | BatchDisassociateProjectAssetsCommandInput | BatchGetAssetPropertyAggregatesCommandInput | BatchGetAssetPropertyValueCommandInput | BatchGetAssetPropertyValueHistoryCommandInput | BatchPutAssetPropertyValueCommandInput | CreateAccessPolicyCommandInput | CreateAssetCommandInput | CreateAssetModelCommandInput | CreateDashboardCommandInput | CreateGatewayCommandInput | CreatePortalCommandInput | CreateProjectCommandInput | DeleteAccessPolicyCommandInput | DeleteAssetCommandInput | DeleteAssetModelCommandInput | DeleteDashboardCommandInput | DeleteGatewayCommandInput | DeletePortalCommandInput | DeleteProjectCommandInput | DeleteTimeSeriesCommandInput | DescribeAccessPolicyCommandInput | DescribeAssetCommandInput | DescribeAssetModelCommandInput | DescribeAssetPropertyCommandInput | DescribeDashboardCommandInput | DescribeDefaultEncryptionConfigurationCommandInput | DescribeGatewayCapabilityConfigurationCommandInput | DescribeGatewayCommandInput | DescribeLoggingOptionsCommandInput | DescribePortalCommandInput | DescribeProjectCommandInput | DescribeStorageConfigurationCommandInput | DescribeTimeSeriesCommandInput | DisassociateAssetsCommandInput | DisassociateTimeSeriesFromAssetPropertyCommandInput | GetAssetPropertyAggregatesCommandInput | GetAssetPropertyValueCommandInput | GetAssetPropertyValueHistoryCommandInput | GetInterpolatedAssetPropertyValuesCommandInput | ListAccessPoliciesCommandInput | ListAssetModelsCommandInput | ListAssetRelationshipsCommandInput | ListAssetsCommandInput | ListAssociatedAssetsCommandInput | ListDashboardsCommandInput | ListGatewaysCommandInput | ListPortalsCommandInput | ListProjectAssetsCommandInput | ListProjectsCommandInput | ListTagsForResourceCommandInput | ListTimeSeriesCommandInput | PutDefaultEncryptionConfigurationCommandInput | PutLoggingOptionsCommandInput | PutStorageConfigurationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessPolicyCommandInput | UpdateAssetCommandInput | UpdateAssetModelCommandInput | UpdateAssetPropertyCommandInput | UpdateDashboardCommandInput | UpdateGatewayCapabilityConfigurationCommandInput | UpdateGatewayCommandInput | UpdatePortalCommandInput | UpdateProjectCommandInput;
|
|
78
|
-
export declare type ServiceOutputTypes = AssociateAssetsCommandOutput | AssociateTimeSeriesToAssetPropertyCommandOutput | BatchAssociateProjectAssetsCommandOutput | BatchDisassociateProjectAssetsCommandOutput | BatchGetAssetPropertyAggregatesCommandOutput | BatchGetAssetPropertyValueCommandOutput | BatchGetAssetPropertyValueHistoryCommandOutput | BatchPutAssetPropertyValueCommandOutput | CreateAccessPolicyCommandOutput | CreateAssetCommandOutput | CreateAssetModelCommandOutput | CreateDashboardCommandOutput | CreateGatewayCommandOutput | CreatePortalCommandOutput | CreateProjectCommandOutput | DeleteAccessPolicyCommandOutput | DeleteAssetCommandOutput | DeleteAssetModelCommandOutput | DeleteDashboardCommandOutput | DeleteGatewayCommandOutput | DeletePortalCommandOutput | DeleteProjectCommandOutput | DeleteTimeSeriesCommandOutput | DescribeAccessPolicyCommandOutput | DescribeAssetCommandOutput | DescribeAssetModelCommandOutput | DescribeAssetPropertyCommandOutput | DescribeDashboardCommandOutput | DescribeDefaultEncryptionConfigurationCommandOutput | DescribeGatewayCapabilityConfigurationCommandOutput | DescribeGatewayCommandOutput | DescribeLoggingOptionsCommandOutput | DescribePortalCommandOutput | DescribeProjectCommandOutput | DescribeStorageConfigurationCommandOutput | DescribeTimeSeriesCommandOutput | DisassociateAssetsCommandOutput | DisassociateTimeSeriesFromAssetPropertyCommandOutput | GetAssetPropertyAggregatesCommandOutput | GetAssetPropertyValueCommandOutput | GetAssetPropertyValueHistoryCommandOutput | GetInterpolatedAssetPropertyValuesCommandOutput | ListAccessPoliciesCommandOutput | ListAssetModelsCommandOutput | ListAssetRelationshipsCommandOutput | ListAssetsCommandOutput | ListAssociatedAssetsCommandOutput | ListDashboardsCommandOutput | ListGatewaysCommandOutput | ListPortalsCommandOutput | ListProjectAssetsCommandOutput | ListProjectsCommandOutput | ListTagsForResourceCommandOutput | ListTimeSeriesCommandOutput | PutDefaultEncryptionConfigurationCommandOutput | PutLoggingOptionsCommandOutput | PutStorageConfigurationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessPolicyCommandOutput | UpdateAssetCommandOutput | UpdateAssetModelCommandOutput | UpdateAssetPropertyCommandOutput | UpdateDashboardCommandOutput | UpdateGatewayCapabilityConfigurationCommandOutput | UpdateGatewayCommandOutput | UpdatePortalCommandOutput | UpdateProjectCommandOutput;
|
|
80
|
+
export declare type ServiceInputTypes = AssociateAssetsCommandInput | AssociateTimeSeriesToAssetPropertyCommandInput | BatchAssociateProjectAssetsCommandInput | BatchDisassociateProjectAssetsCommandInput | BatchGetAssetPropertyAggregatesCommandInput | BatchGetAssetPropertyValueCommandInput | BatchGetAssetPropertyValueHistoryCommandInput | BatchPutAssetPropertyValueCommandInput | CreateAccessPolicyCommandInput | CreateAssetCommandInput | CreateAssetModelCommandInput | CreateBulkImportJobCommandInput | CreateDashboardCommandInput | CreateGatewayCommandInput | CreatePortalCommandInput | CreateProjectCommandInput | DeleteAccessPolicyCommandInput | DeleteAssetCommandInput | DeleteAssetModelCommandInput | DeleteDashboardCommandInput | DeleteGatewayCommandInput | DeletePortalCommandInput | DeleteProjectCommandInput | DeleteTimeSeriesCommandInput | DescribeAccessPolicyCommandInput | DescribeAssetCommandInput | DescribeAssetModelCommandInput | DescribeAssetPropertyCommandInput | DescribeBulkImportJobCommandInput | DescribeDashboardCommandInput | DescribeDefaultEncryptionConfigurationCommandInput | DescribeGatewayCapabilityConfigurationCommandInput | DescribeGatewayCommandInput | DescribeLoggingOptionsCommandInput | DescribePortalCommandInput | DescribeProjectCommandInput | DescribeStorageConfigurationCommandInput | DescribeTimeSeriesCommandInput | DisassociateAssetsCommandInput | DisassociateTimeSeriesFromAssetPropertyCommandInput | GetAssetPropertyAggregatesCommandInput | GetAssetPropertyValueCommandInput | GetAssetPropertyValueHistoryCommandInput | GetInterpolatedAssetPropertyValuesCommandInput | ListAccessPoliciesCommandInput | ListAssetModelsCommandInput | ListAssetRelationshipsCommandInput | ListAssetsCommandInput | ListAssociatedAssetsCommandInput | ListBulkImportJobsCommandInput | ListDashboardsCommandInput | ListGatewaysCommandInput | ListPortalsCommandInput | ListProjectAssetsCommandInput | ListProjectsCommandInput | ListTagsForResourceCommandInput | ListTimeSeriesCommandInput | PutDefaultEncryptionConfigurationCommandInput | PutLoggingOptionsCommandInput | PutStorageConfigurationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessPolicyCommandInput | UpdateAssetCommandInput | UpdateAssetModelCommandInput | UpdateAssetPropertyCommandInput | UpdateDashboardCommandInput | UpdateGatewayCapabilityConfigurationCommandInput | UpdateGatewayCommandInput | UpdatePortalCommandInput | UpdateProjectCommandInput;
|
|
81
|
+
export declare type ServiceOutputTypes = AssociateAssetsCommandOutput | AssociateTimeSeriesToAssetPropertyCommandOutput | BatchAssociateProjectAssetsCommandOutput | BatchDisassociateProjectAssetsCommandOutput | BatchGetAssetPropertyAggregatesCommandOutput | BatchGetAssetPropertyValueCommandOutput | BatchGetAssetPropertyValueHistoryCommandOutput | BatchPutAssetPropertyValueCommandOutput | CreateAccessPolicyCommandOutput | CreateAssetCommandOutput | CreateAssetModelCommandOutput | CreateBulkImportJobCommandOutput | CreateDashboardCommandOutput | CreateGatewayCommandOutput | CreatePortalCommandOutput | CreateProjectCommandOutput | DeleteAccessPolicyCommandOutput | DeleteAssetCommandOutput | DeleteAssetModelCommandOutput | DeleteDashboardCommandOutput | DeleteGatewayCommandOutput | DeletePortalCommandOutput | DeleteProjectCommandOutput | DeleteTimeSeriesCommandOutput | DescribeAccessPolicyCommandOutput | DescribeAssetCommandOutput | DescribeAssetModelCommandOutput | DescribeAssetPropertyCommandOutput | DescribeBulkImportJobCommandOutput | DescribeDashboardCommandOutput | DescribeDefaultEncryptionConfigurationCommandOutput | DescribeGatewayCapabilityConfigurationCommandOutput | DescribeGatewayCommandOutput | DescribeLoggingOptionsCommandOutput | DescribePortalCommandOutput | DescribeProjectCommandOutput | DescribeStorageConfigurationCommandOutput | DescribeTimeSeriesCommandOutput | DisassociateAssetsCommandOutput | DisassociateTimeSeriesFromAssetPropertyCommandOutput | GetAssetPropertyAggregatesCommandOutput | GetAssetPropertyValueCommandOutput | GetAssetPropertyValueHistoryCommandOutput | GetInterpolatedAssetPropertyValuesCommandOutput | ListAccessPoliciesCommandOutput | ListAssetModelsCommandOutput | ListAssetRelationshipsCommandOutput | ListAssetsCommandOutput | ListAssociatedAssetsCommandOutput | ListBulkImportJobsCommandOutput | ListDashboardsCommandOutput | ListGatewaysCommandOutput | ListPortalsCommandOutput | ListProjectAssetsCommandOutput | ListProjectsCommandOutput | ListTagsForResourceCommandOutput | ListTimeSeriesCommandOutput | PutDefaultEncryptionConfigurationCommandOutput | PutLoggingOptionsCommandOutput | PutStorageConfigurationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessPolicyCommandOutput | UpdateAssetCommandOutput | UpdateAssetModelCommandOutput | UpdateAssetPropertyCommandOutput | UpdateDashboardCommandOutput | UpdateGatewayCapabilityConfigurationCommandOutput | UpdateGatewayCommandOutput | UpdatePortalCommandOutput | UpdateProjectCommandOutput;
|
|
79
82
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
80
83
|
/**
|
|
81
84
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
+
import { CreateBulkImportJobRequest, CreateBulkImportJobResponse } from "../models/models_0";
|
|
5
|
+
export interface CreateBulkImportJobCommandInput extends CreateBulkImportJobRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <note>
|
|
11
|
+
* <p>This API operation is in preview release for IoT SiteWise and is subject to change.
|
|
12
|
+
* We recommend that you use this operation only with test data, and not in production environments.</p>
|
|
13
|
+
* </note>
|
|
14
|
+
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information,
|
|
15
|
+
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a bulk import job (CLI)</a>
|
|
16
|
+
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
17
|
+
* <important>
|
|
18
|
+
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job.
|
|
19
|
+
* For more information about how to configure storage settings,
|
|
20
|
+
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
|
|
21
|
+
* </important>
|
|
22
|
+
* @example
|
|
23
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
24
|
+
* ```javascript
|
|
25
|
+
* import { IoTSiteWiseClient, CreateBulkImportJobCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
26
|
+
* // const { IoTSiteWiseClient, CreateBulkImportJobCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
27
|
+
* const client = new IoTSiteWiseClient(config);
|
|
28
|
+
* const command = new CreateBulkImportJobCommand(input);
|
|
29
|
+
* const response = await client.send(command);
|
|
30
|
+
* ```
|
|
31
|
+
*
|
|
32
|
+
* @see {@link CreateBulkImportJobCommandInput} for command's `input` shape.
|
|
33
|
+
* @see {@link CreateBulkImportJobCommandOutput} for command's `response` shape.
|
|
34
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
35
|
+
*
|
|
36
|
+
*/
|
|
37
|
+
export declare class CreateBulkImportJobCommand extends $Command<CreateBulkImportJobCommandInput, CreateBulkImportJobCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
38
|
+
readonly input: CreateBulkImportJobCommandInput;
|
|
39
|
+
constructor(input: CreateBulkImportJobCommandInput);
|
|
40
|
+
/**
|
|
41
|
+
* @internal
|
|
42
|
+
*/
|
|
43
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBulkImportJobCommandInput, CreateBulkImportJobCommandOutput>;
|
|
44
|
+
private serialize;
|
|
45
|
+
private deserialize;
|
|
46
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
+
import { DescribeBulkImportJobRequest, DescribeBulkImportJobResponse } from "../models/models_0";
|
|
5
|
+
export interface DescribeBulkImportJobCommandInput extends DescribeBulkImportJobRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJobResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <note>
|
|
11
|
+
* <p>This API operation is in preview release for IoT SiteWise and is subject to change.
|
|
12
|
+
* We recommend that you use this operation only with test data, and not in production environments.</p>
|
|
13
|
+
* </note>
|
|
14
|
+
* <p>Retrieves information about a bulk import job request. For more information,
|
|
15
|
+
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html">Describe a bulk import job (CLI)</a>
|
|
16
|
+
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
17
|
+
* @example
|
|
18
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
19
|
+
* ```javascript
|
|
20
|
+
* import { IoTSiteWiseClient, DescribeBulkImportJobCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
21
|
+
* // const { IoTSiteWiseClient, DescribeBulkImportJobCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
22
|
+
* const client = new IoTSiteWiseClient(config);
|
|
23
|
+
* const command = new DescribeBulkImportJobCommand(input);
|
|
24
|
+
* const response = await client.send(command);
|
|
25
|
+
* ```
|
|
26
|
+
*
|
|
27
|
+
* @see {@link DescribeBulkImportJobCommandInput} for command's `input` shape.
|
|
28
|
+
* @see {@link DescribeBulkImportJobCommandOutput} for command's `response` shape.
|
|
29
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
export declare class DescribeBulkImportJobCommand extends $Command<DescribeBulkImportJobCommandInput, DescribeBulkImportJobCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
33
|
+
readonly input: DescribeBulkImportJobCommandInput;
|
|
34
|
+
constructor(input: DescribeBulkImportJobCommandInput);
|
|
35
|
+
/**
|
|
36
|
+
* @internal
|
|
37
|
+
*/
|
|
38
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBulkImportJobCommandInput, DescribeBulkImportJobCommandOutput>;
|
|
39
|
+
private serialize;
|
|
40
|
+
private deserialize;
|
|
41
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
4
|
+
import { ListBulkImportJobsRequest, ListBulkImportJobsResponse } from "../models/models_0";
|
|
5
|
+
export interface ListBulkImportJobsCommandInput extends ListBulkImportJobsRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListBulkImportJobsCommandOutput extends ListBulkImportJobsResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <note>
|
|
11
|
+
* <p>This API operation is in preview release for IoT SiteWise and is subject to change.
|
|
12
|
+
* We recommend that you use this operation only with test data, and not in production environments.</p>
|
|
13
|
+
* </note>
|
|
14
|
+
* <p>Retrieves a paginated list of bulk import job requests. For more information,
|
|
15
|
+
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html">List bulk import jobs (CLI)</a>
|
|
16
|
+
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
17
|
+
* @example
|
|
18
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
19
|
+
* ```javascript
|
|
20
|
+
* import { IoTSiteWiseClient, ListBulkImportJobsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
21
|
+
* // const { IoTSiteWiseClient, ListBulkImportJobsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
22
|
+
* const client = new IoTSiteWiseClient(config);
|
|
23
|
+
* const command = new ListBulkImportJobsCommand(input);
|
|
24
|
+
* const response = await client.send(command);
|
|
25
|
+
* ```
|
|
26
|
+
*
|
|
27
|
+
* @see {@link ListBulkImportJobsCommandInput} for command's `input` shape.
|
|
28
|
+
* @see {@link ListBulkImportJobsCommandOutput} for command's `response` shape.
|
|
29
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
export declare class ListBulkImportJobsCommand extends $Command<ListBulkImportJobsCommandInput, ListBulkImportJobsCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
33
|
+
readonly input: ListBulkImportJobsCommandInput;
|
|
34
|
+
constructor(input: ListBulkImportJobsCommandInput);
|
|
35
|
+
/**
|
|
36
|
+
* @internal
|
|
37
|
+
*/
|
|
38
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBulkImportJobsCommandInput, ListBulkImportJobsCommandOutput>;
|
|
39
|
+
private serialize;
|
|
40
|
+
private deserialize;
|
|
41
|
+
}
|
|
@@ -9,6 +9,7 @@ export * from "./BatchPutAssetPropertyValueCommand";
|
|
|
9
9
|
export * from "./CreateAccessPolicyCommand";
|
|
10
10
|
export * from "./CreateAssetCommand";
|
|
11
11
|
export * from "./CreateAssetModelCommand";
|
|
12
|
+
export * from "./CreateBulkImportJobCommand";
|
|
12
13
|
export * from "./CreateDashboardCommand";
|
|
13
14
|
export * from "./CreateGatewayCommand";
|
|
14
15
|
export * from "./CreatePortalCommand";
|
|
@@ -25,6 +26,7 @@ export * from "./DescribeAccessPolicyCommand";
|
|
|
25
26
|
export * from "./DescribeAssetCommand";
|
|
26
27
|
export * from "./DescribeAssetModelCommand";
|
|
27
28
|
export * from "./DescribeAssetPropertyCommand";
|
|
29
|
+
export * from "./DescribeBulkImportJobCommand";
|
|
28
30
|
export * from "./DescribeDashboardCommand";
|
|
29
31
|
export * from "./DescribeDefaultEncryptionConfigurationCommand";
|
|
30
32
|
export * from "./DescribeGatewayCapabilityConfigurationCommand";
|
|
@@ -45,6 +47,7 @@ export * from "./ListAssetModelsCommand";
|
|
|
45
47
|
export * from "./ListAssetRelationshipsCommand";
|
|
46
48
|
export * from "./ListAssetsCommand";
|
|
47
49
|
export * from "./ListAssociatedAssetsCommand";
|
|
50
|
+
export * from "./ListBulkImportJobsCommand";
|
|
48
51
|
export * from "./ListDashboardsCommand";
|
|
49
52
|
export * from "./ListGatewaysCommand";
|
|
50
53
|
export * from "./ListPortalsCommand";
|
|
@@ -2503,6 +2503,192 @@ export declare namespace CreateAssetModelResponse {
|
|
|
2503
2503
|
*/
|
|
2504
2504
|
const filterSensitiveLog: (obj: CreateAssetModelResponse) => any;
|
|
2505
2505
|
}
|
|
2506
|
+
/**
|
|
2507
|
+
* <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
|
|
2508
|
+
*/
|
|
2509
|
+
export interface ErrorReportLocation {
|
|
2510
|
+
/**
|
|
2511
|
+
* <p>The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.</p>
|
|
2512
|
+
*/
|
|
2513
|
+
bucket: string | undefined;
|
|
2514
|
+
/**
|
|
2515
|
+
* <p>Amazon S3 uses the prefix as a folder name to organize data in the bucket.
|
|
2516
|
+
* Each Amazon S3 object has a key that is its unique identifier in the bucket.
|
|
2517
|
+
* Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
|
|
2518
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>
|
|
2519
|
+
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
2520
|
+
*/
|
|
2521
|
+
prefix: string | undefined;
|
|
2522
|
+
}
|
|
2523
|
+
export declare namespace ErrorReportLocation {
|
|
2524
|
+
/**
|
|
2525
|
+
* @internal
|
|
2526
|
+
*/
|
|
2527
|
+
const filterSensitiveLog: (obj: ErrorReportLocation) => any;
|
|
2528
|
+
}
|
|
2529
|
+
/**
|
|
2530
|
+
* <p>The file in Amazon S3 where your data is saved. </p>
|
|
2531
|
+
*/
|
|
2532
|
+
export interface File {
|
|
2533
|
+
/**
|
|
2534
|
+
* <p>The name of the Amazon S3 bucket from which data is imported.</p>
|
|
2535
|
+
*/
|
|
2536
|
+
bucket: string | undefined;
|
|
2537
|
+
/**
|
|
2538
|
+
* <p>The key of the Amazon S3 object that contains your data. Each object has a key that is a
|
|
2539
|
+
* unique identifier. Each object has exactly one key.</p>
|
|
2540
|
+
*/
|
|
2541
|
+
key: string | undefined;
|
|
2542
|
+
/**
|
|
2543
|
+
* <p>The version ID to identify a specific version of the Amazon S3 object that contains your data.</p>
|
|
2544
|
+
*/
|
|
2545
|
+
versionId?: string;
|
|
2546
|
+
}
|
|
2547
|
+
export declare namespace File {
|
|
2548
|
+
/**
|
|
2549
|
+
* @internal
|
|
2550
|
+
*/
|
|
2551
|
+
const filterSensitiveLog: (obj: File) => any;
|
|
2552
|
+
}
|
|
2553
|
+
export declare enum ColumnName {
|
|
2554
|
+
ALIAS = "ALIAS",
|
|
2555
|
+
ASSET_ID = "ASSET_ID",
|
|
2556
|
+
DATA_TYPE = "DATA_TYPE",
|
|
2557
|
+
PROPERTY_ID = "PROPERTY_ID",
|
|
2558
|
+
QUALITY = "QUALITY",
|
|
2559
|
+
TIMESTAMP_NANO_OFFSET = "TIMESTAMP_NANO_OFFSET",
|
|
2560
|
+
TIMESTAMP_SECONDS = "TIMESTAMP_SECONDS",
|
|
2561
|
+
VALUE = "VALUE"
|
|
2562
|
+
}
|
|
2563
|
+
/**
|
|
2564
|
+
* <p>A .csv file.</p>
|
|
2565
|
+
*/
|
|
2566
|
+
export interface Csv {
|
|
2567
|
+
/**
|
|
2568
|
+
* <p>The column names specified in the .csv file.</p>
|
|
2569
|
+
*/
|
|
2570
|
+
columnNames?: (ColumnName | string)[];
|
|
2571
|
+
}
|
|
2572
|
+
export declare namespace Csv {
|
|
2573
|
+
/**
|
|
2574
|
+
* @internal
|
|
2575
|
+
*/
|
|
2576
|
+
const filterSensitiveLog: (obj: Csv) => any;
|
|
2577
|
+
}
|
|
2578
|
+
/**
|
|
2579
|
+
* <p>The file format of the data.</p>
|
|
2580
|
+
*/
|
|
2581
|
+
export interface FileFormat {
|
|
2582
|
+
/**
|
|
2583
|
+
* <p>The .csv file format.</p>
|
|
2584
|
+
*/
|
|
2585
|
+
csv?: Csv;
|
|
2586
|
+
}
|
|
2587
|
+
export declare namespace FileFormat {
|
|
2588
|
+
/**
|
|
2589
|
+
* @internal
|
|
2590
|
+
*/
|
|
2591
|
+
const filterSensitiveLog: (obj: FileFormat) => any;
|
|
2592
|
+
}
|
|
2593
|
+
/**
|
|
2594
|
+
* <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
|
|
2595
|
+
*/
|
|
2596
|
+
export interface JobConfiguration {
|
|
2597
|
+
/**
|
|
2598
|
+
* <p>The file format of the data in Amazon S3.</p>
|
|
2599
|
+
*/
|
|
2600
|
+
fileFormat: FileFormat | undefined;
|
|
2601
|
+
}
|
|
2602
|
+
export declare namespace JobConfiguration {
|
|
2603
|
+
/**
|
|
2604
|
+
* @internal
|
|
2605
|
+
*/
|
|
2606
|
+
const filterSensitiveLog: (obj: JobConfiguration) => any;
|
|
2607
|
+
}
|
|
2608
|
+
export interface CreateBulkImportJobRequest {
|
|
2609
|
+
/**
|
|
2610
|
+
* <p>The unique name that helps identify the job request.</p>
|
|
2611
|
+
*/
|
|
2612
|
+
jobName: string | undefined;
|
|
2613
|
+
/**
|
|
2614
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows IoT SiteWise to read Amazon S3 data.</p>
|
|
2615
|
+
*/
|
|
2616
|
+
jobRoleArn: string | undefined;
|
|
2617
|
+
/**
|
|
2618
|
+
* <p>The files in the specified Amazon S3 bucket that contain your data.</p>
|
|
2619
|
+
*/
|
|
2620
|
+
files: File[] | undefined;
|
|
2621
|
+
/**
|
|
2622
|
+
* <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
|
|
2623
|
+
*/
|
|
2624
|
+
errorReportLocation: ErrorReportLocation | undefined;
|
|
2625
|
+
/**
|
|
2626
|
+
* <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
|
|
2627
|
+
*/
|
|
2628
|
+
jobConfiguration: JobConfiguration | undefined;
|
|
2629
|
+
}
|
|
2630
|
+
export declare namespace CreateBulkImportJobRequest {
|
|
2631
|
+
/**
|
|
2632
|
+
* @internal
|
|
2633
|
+
*/
|
|
2634
|
+
const filterSensitiveLog: (obj: CreateBulkImportJobRequest) => any;
|
|
2635
|
+
}
|
|
2636
|
+
export declare enum JobStatus {
|
|
2637
|
+
CANCELLED = "CANCELLED",
|
|
2638
|
+
COMPLETED = "COMPLETED",
|
|
2639
|
+
COMPLETED_WITH_FAILURES = "COMPLETED_WITH_FAILURES",
|
|
2640
|
+
FAILED = "FAILED",
|
|
2641
|
+
PENDING = "PENDING",
|
|
2642
|
+
RUNNING = "RUNNING"
|
|
2643
|
+
}
|
|
2644
|
+
export interface CreateBulkImportJobResponse {
|
|
2645
|
+
/**
|
|
2646
|
+
* <p>The ID of the job.</p>
|
|
2647
|
+
*/
|
|
2648
|
+
jobId: string | undefined;
|
|
2649
|
+
/**
|
|
2650
|
+
* <p>The unique name that helps identify the job request.</p>
|
|
2651
|
+
*/
|
|
2652
|
+
jobName: string | undefined;
|
|
2653
|
+
/**
|
|
2654
|
+
* <p>The status of the bulk import job can be one of following values.</p>
|
|
2655
|
+
* <ul>
|
|
2656
|
+
* <li>
|
|
2657
|
+
* <p>
|
|
2658
|
+
* <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p>
|
|
2659
|
+
* </li>
|
|
2660
|
+
* <li>
|
|
2661
|
+
* <p>
|
|
2662
|
+
* <code>CANCELLED</code> – The bulk import job has been canceled.</p>
|
|
2663
|
+
* </li>
|
|
2664
|
+
* <li>
|
|
2665
|
+
* <p>
|
|
2666
|
+
* <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p>
|
|
2667
|
+
* </li>
|
|
2668
|
+
* <li>
|
|
2669
|
+
* <p>
|
|
2670
|
+
* <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p>
|
|
2671
|
+
* </li>
|
|
2672
|
+
* <li>
|
|
2673
|
+
* <p>
|
|
2674
|
+
* <code>FAILED</code> – IoT SiteWise couldn't process your request to import data from Amazon S3.
|
|
2675
|
+
* You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
|
|
2676
|
+
* </li>
|
|
2677
|
+
* <li>
|
|
2678
|
+
* <p>
|
|
2679
|
+
* <code>COMPLETED_WITH_FAILURES</code> – IoT SiteWise completed your request to import data from Amazon S3 with errors.
|
|
2680
|
+
* You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
|
|
2681
|
+
* </li>
|
|
2682
|
+
* </ul>
|
|
2683
|
+
*/
|
|
2684
|
+
jobStatus: JobStatus | string | undefined;
|
|
2685
|
+
}
|
|
2686
|
+
export declare namespace CreateBulkImportJobResponse {
|
|
2687
|
+
/**
|
|
2688
|
+
* @internal
|
|
2689
|
+
*/
|
|
2690
|
+
const filterSensitiveLog: (obj: CreateBulkImportJobResponse) => any;
|
|
2691
|
+
}
|
|
2506
2692
|
export interface CreateDashboardRequest {
|
|
2507
2693
|
/**
|
|
2508
2694
|
* <p>The ID of the project in which to create the dashboard.</p>
|
|
@@ -3390,6 +3576,90 @@ export declare namespace DescribeAssetPropertyResponse {
|
|
|
3390
3576
|
*/
|
|
3391
3577
|
const filterSensitiveLog: (obj: DescribeAssetPropertyResponse) => any;
|
|
3392
3578
|
}
|
|
3579
|
+
export interface DescribeBulkImportJobRequest {
|
|
3580
|
+
/**
|
|
3581
|
+
* <p>The ID of the job.</p>
|
|
3582
|
+
*/
|
|
3583
|
+
jobId: string | undefined;
|
|
3584
|
+
}
|
|
3585
|
+
export declare namespace DescribeBulkImportJobRequest {
|
|
3586
|
+
/**
|
|
3587
|
+
* @internal
|
|
3588
|
+
*/
|
|
3589
|
+
const filterSensitiveLog: (obj: DescribeBulkImportJobRequest) => any;
|
|
3590
|
+
}
|
|
3591
|
+
export interface DescribeBulkImportJobResponse {
|
|
3592
|
+
/**
|
|
3593
|
+
* <p>The ID of the job.</p>
|
|
3594
|
+
*/
|
|
3595
|
+
jobId: string | undefined;
|
|
3596
|
+
/**
|
|
3597
|
+
* <p>The unique name that helps identify the job request.</p>
|
|
3598
|
+
*/
|
|
3599
|
+
jobName: string | undefined;
|
|
3600
|
+
/**
|
|
3601
|
+
* <p>The status of the bulk import job can be one of following values.</p>
|
|
3602
|
+
* <ul>
|
|
3603
|
+
* <li>
|
|
3604
|
+
* <p>
|
|
3605
|
+
* <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p>
|
|
3606
|
+
* </li>
|
|
3607
|
+
* <li>
|
|
3608
|
+
* <p>
|
|
3609
|
+
* <code>CANCELLED</code> – The bulk import job has been canceled.</p>
|
|
3610
|
+
* </li>
|
|
3611
|
+
* <li>
|
|
3612
|
+
* <p>
|
|
3613
|
+
* <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p>
|
|
3614
|
+
* </li>
|
|
3615
|
+
* <li>
|
|
3616
|
+
* <p>
|
|
3617
|
+
* <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p>
|
|
3618
|
+
* </li>
|
|
3619
|
+
* <li>
|
|
3620
|
+
* <p>
|
|
3621
|
+
* <code>FAILED</code> – IoT SiteWise couldn't process your request to import data from Amazon S3.
|
|
3622
|
+
* You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
|
|
3623
|
+
* </li>
|
|
3624
|
+
* <li>
|
|
3625
|
+
* <p>
|
|
3626
|
+
* <code>COMPLETED_WITH_FAILURES</code> – IoT SiteWise completed your request to import data from Amazon S3 with errors.
|
|
3627
|
+
* You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
|
|
3628
|
+
* </li>
|
|
3629
|
+
* </ul>
|
|
3630
|
+
*/
|
|
3631
|
+
jobStatus: JobStatus | string | undefined;
|
|
3632
|
+
/**
|
|
3633
|
+
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IAM role that allows IoT SiteWise to read Amazon S3 data.</p>
|
|
3634
|
+
*/
|
|
3635
|
+
jobRoleArn: string | undefined;
|
|
3636
|
+
/**
|
|
3637
|
+
* <p>The files in the specified Amazon S3 bucket that contain your data.</p>
|
|
3638
|
+
*/
|
|
3639
|
+
files: File[] | undefined;
|
|
3640
|
+
/**
|
|
3641
|
+
* <p>The Amazon S3 destination where errors associated with the job creation request are saved.</p>
|
|
3642
|
+
*/
|
|
3643
|
+
errorReportLocation: ErrorReportLocation | undefined;
|
|
3644
|
+
/**
|
|
3645
|
+
* <p>Contains the configuration information of a job, such as the file format used to save data in Amazon S3.</p>
|
|
3646
|
+
*/
|
|
3647
|
+
jobConfiguration: JobConfiguration | undefined;
|
|
3648
|
+
/**
|
|
3649
|
+
* <p>The date the job was created, in Unix epoch TIME.</p>
|
|
3650
|
+
*/
|
|
3651
|
+
jobCreationDate: Date | undefined;
|
|
3652
|
+
/**
|
|
3653
|
+
* <p>The date the job was last updated, in Unix epoch time.</p>
|
|
3654
|
+
*/
|
|
3655
|
+
jobLastUpdateDate: Date | undefined;
|
|
3656
|
+
}
|
|
3657
|
+
export declare namespace DescribeBulkImportJobResponse {
|
|
3658
|
+
/**
|
|
3659
|
+
* @internal
|
|
3660
|
+
*/
|
|
3661
|
+
const filterSensitiveLog: (obj: DescribeBulkImportJobResponse) => any;
|
|
3662
|
+
}
|
|
3393
3663
|
export interface DescribeDashboardRequest {
|
|
3394
3664
|
/**
|
|
3395
3665
|
* <p>The ID of the dashboard.</p>
|
|
@@ -4741,6 +5011,102 @@ export declare namespace ListAssociatedAssetsResponse {
|
|
|
4741
5011
|
*/
|
|
4742
5012
|
const filterSensitiveLog: (obj: ListAssociatedAssetsResponse) => any;
|
|
4743
5013
|
}
|
|
5014
|
+
export declare enum ListBulkImportJobsFilter {
|
|
5015
|
+
ALL = "ALL",
|
|
5016
|
+
CANCELLED = "CANCELLED",
|
|
5017
|
+
COMPLETED = "COMPLETED",
|
|
5018
|
+
COMPLETED_WITH_FAILURES = "COMPLETED_WITH_FAILURES",
|
|
5019
|
+
FAILED = "FAILED",
|
|
5020
|
+
PENDING = "PENDING",
|
|
5021
|
+
RUNNING = "RUNNING"
|
|
5022
|
+
}
|
|
5023
|
+
export interface ListBulkImportJobsRequest {
|
|
5024
|
+
/**
|
|
5025
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
5026
|
+
*/
|
|
5027
|
+
nextToken?: string;
|
|
5028
|
+
/**
|
|
5029
|
+
* <p>The maximum number of results to return for each paginated request.</p>
|
|
5030
|
+
*/
|
|
5031
|
+
maxResults?: number;
|
|
5032
|
+
/**
|
|
5033
|
+
* <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
|
|
5034
|
+
*/
|
|
5035
|
+
filter?: ListBulkImportJobsFilter | string;
|
|
5036
|
+
}
|
|
5037
|
+
export declare namespace ListBulkImportJobsRequest {
|
|
5038
|
+
/**
|
|
5039
|
+
* @internal
|
|
5040
|
+
*/
|
|
5041
|
+
const filterSensitiveLog: (obj: ListBulkImportJobsRequest) => any;
|
|
5042
|
+
}
|
|
5043
|
+
/**
|
|
5044
|
+
* <p>Contains a job summary information.</p>
|
|
5045
|
+
*/
|
|
5046
|
+
export interface JobSummary {
|
|
5047
|
+
/**
|
|
5048
|
+
* <p>The ID of the job.</p>
|
|
5049
|
+
*/
|
|
5050
|
+
id: string | undefined;
|
|
5051
|
+
/**
|
|
5052
|
+
* <p>The unique name that helps identify the job request.</p>
|
|
5053
|
+
*/
|
|
5054
|
+
name: string | undefined;
|
|
5055
|
+
/**
|
|
5056
|
+
* <p>The status of the bulk import job can be one of following values.</p>
|
|
5057
|
+
* <ul>
|
|
5058
|
+
* <li>
|
|
5059
|
+
* <p>
|
|
5060
|
+
* <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p>
|
|
5061
|
+
* </li>
|
|
5062
|
+
* <li>
|
|
5063
|
+
* <p>
|
|
5064
|
+
* <code>CANCELLED</code> – The bulk import job has been canceled.</p>
|
|
5065
|
+
* </li>
|
|
5066
|
+
* <li>
|
|
5067
|
+
* <p>
|
|
5068
|
+
* <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p>
|
|
5069
|
+
* </li>
|
|
5070
|
+
* <li>
|
|
5071
|
+
* <p>
|
|
5072
|
+
* <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p>
|
|
5073
|
+
* </li>
|
|
5074
|
+
* <li>
|
|
5075
|
+
* <p>
|
|
5076
|
+
* <code>FAILED</code> – IoT SiteWise couldn't process your request to import data from Amazon S3.
|
|
5077
|
+
* You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
|
|
5078
|
+
* </li>
|
|
5079
|
+
* <li>
|
|
5080
|
+
* <p>
|
|
5081
|
+
* <code>COMPLETED_WITH_FAILURES</code> – IoT SiteWise completed your request to import data from Amazon S3 with errors.
|
|
5082
|
+
* You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
|
|
5083
|
+
* </li>
|
|
5084
|
+
* </ul>
|
|
5085
|
+
*/
|
|
5086
|
+
status: JobStatus | string | undefined;
|
|
5087
|
+
}
|
|
5088
|
+
export declare namespace JobSummary {
|
|
5089
|
+
/**
|
|
5090
|
+
* @internal
|
|
5091
|
+
*/
|
|
5092
|
+
const filterSensitiveLog: (obj: JobSummary) => any;
|
|
5093
|
+
}
|
|
5094
|
+
export interface ListBulkImportJobsResponse {
|
|
5095
|
+
/**
|
|
5096
|
+
* <p>One or more job summaries to list.</p>
|
|
5097
|
+
*/
|
|
5098
|
+
jobSummaries: JobSummary[] | undefined;
|
|
5099
|
+
/**
|
|
5100
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
5101
|
+
*/
|
|
5102
|
+
nextToken?: string;
|
|
5103
|
+
}
|
|
5104
|
+
export declare namespace ListBulkImportJobsResponse {
|
|
5105
|
+
/**
|
|
5106
|
+
* @internal
|
|
5107
|
+
*/
|
|
5108
|
+
const filterSensitiveLog: (obj: ListBulkImportJobsResponse) => any;
|
|
5109
|
+
}
|
|
4744
5110
|
export interface ListDashboardsRequest {
|
|
4745
5111
|
/**
|
|
4746
5112
|
* <p>The ID of the project.</p>
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ListBulkImportJobsCommandInput, ListBulkImportJobsCommandOutput } from "../commands/ListBulkImportJobsCommand";
|
|
3
|
+
import { IoTSiteWisePaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateListBulkImportJobs(config: IoTSiteWisePaginationConfiguration, input: ListBulkImportJobsCommandInput, ...additionalArguments: any): Paginator<ListBulkImportJobsCommandOutput>;
|
|
@@ -10,6 +10,7 @@ export * from "./ListAssetModelsPaginator";
|
|
|
10
10
|
export * from "./ListAssetRelationshipsPaginator";
|
|
11
11
|
export * from "./ListAssetsPaginator";
|
|
12
12
|
export * from "./ListAssociatedAssetsPaginator";
|
|
13
|
+
export * from "./ListBulkImportJobsPaginator";
|
|
13
14
|
export * from "./ListDashboardsPaginator";
|
|
14
15
|
export * from "./ListGatewaysPaginator";
|
|
15
16
|
export * from "./ListPortalsPaginator";
|