@aws-sdk/client-iotsitewise 3.201.0 → 3.204.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/dist-cjs/IoTSiteWise.js +30 -0
- package/dist-cjs/commands/ListAssetModelPropertiesCommand.js +46 -0
- package/dist-cjs/commands/ListAssetPropertiesCommand.js +46 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +40 -6
- package/dist-cjs/pagination/ListAssetModelPropertiesPaginator.js +36 -0
- package/dist-cjs/pagination/ListAssetPropertiesPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +211 -3
- package/dist-cjs/runtimeConfig.browser.js +0 -3
- package/dist-cjs/runtimeConfig.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +3 -0
- package/dist-es/IoTSiteWise.js +30 -0
- package/dist-es/commands/ListAssetModelPropertiesCommand.js +42 -0
- package/dist-es/commands/ListAssetPropertiesCommand.js +42 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +28 -0
- package/dist-es/pagination/ListAssetModelPropertiesPaginator.js +32 -0
- package/dist-es/pagination/ListAssetPropertiesPaginator.js +32 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +204 -0
- package/dist-es/runtimeConfig.browser.js +0 -3
- package/dist-es/runtimeConfig.js +0 -3
- package/dist-es/runtimeConfig.shared.js +3 -0
- package/dist-types/IoTSiteWise.d.ts +35 -21
- package/dist-types/IoTSiteWiseClient.d.ts +4 -2
- package/dist-types/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +3 -3
- package/dist-types/commands/BatchGetAssetPropertyValueCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +2 -2
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/CreateBulkImportJobCommand.d.ts +4 -6
- package/dist-types/commands/CreatePortalCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +2 -3
- package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +39 -0
- package/dist-types/commands/ListAssetPropertiesCommand.d.ts +39 -0
- package/dist-types/commands/ListBulkImportJobsCommand.d.ts +2 -3
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +285 -72
- package/dist-types/pagination/ListAssetModelPropertiesPaginator.d.ts +4 -0
- package/dist-types/pagination/ListAssetPropertiesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +34 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +67 -0
- package/dist-types/ts3.4/pagination/ListAssetModelPropertiesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAssetPropertiesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
- package/package.json +6 -5
- package/CHANGELOG.md +0 -1489
|
@@ -8,13 +8,11 @@ export interface CreateBulkImportJobCommandInput extends CreateBulkImportJobRequ
|
|
|
8
8
|
export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information,
|
|
12
|
-
*
|
|
13
|
-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
11
|
+
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a
|
|
12
|
+
* bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
14
13
|
* <important>
|
|
15
|
-
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job.
|
|
16
|
-
*
|
|
17
|
-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
|
|
14
|
+
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For
|
|
15
|
+
* more information about how to configure storage settings, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
|
|
18
16
|
* </important>
|
|
19
17
|
* @example
|
|
20
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,7 @@ export interface CreatePortalCommandInput extends CreatePortalRequest {
|
|
|
8
8
|
export interface CreatePortalCommandOutput extends CreatePortalResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses
|
|
11
|
+
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM
|
|
12
12
|
* to authenticate portal users and manage user permissions.</p>
|
|
13
13
|
* <note>
|
|
14
14
|
* <p>Before you can sign in to a new portal, you must add at least one identity to that
|
|
@@ -8,9 +8,8 @@ export interface DescribeBulkImportJobCommandInput extends DescribeBulkImportJob
|
|
|
8
8
|
export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJobResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Retrieves information about a bulk import job request. For more information,
|
|
12
|
-
*
|
|
13
|
-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
11
|
+
* <p>Retrieves information about a bulk import job request. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html">Describe
|
|
12
|
+
* a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
14
13
|
* @example
|
|
15
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
15
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface ListAccessPoliciesCommandInput extends ListAccessPoliciesReques
|
|
|
8
8
|
export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Retrieves a paginated list of access policies for an identity (an
|
|
11
|
+
* <p>Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center
|
|
12
12
|
* group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
5
|
+
import { ListAssetModelPropertiesRequest, ListAssetModelPropertiesResponse } from "../models/models_0";
|
|
6
|
+
export interface ListAssetModelPropertiesCommandInput extends ListAssetModelPropertiesRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface ListAssetModelPropertiesCommandOutput extends ListAssetModelPropertiesResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Retrieves a paginated list of properties associated with an asset model.
|
|
12
|
+
* If you update properties associated with the model before you finish listing all the properties,
|
|
13
|
+
* you need to start all over again.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { IoTSiteWiseClient, ListAssetModelPropertiesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
18
|
+
* // const { IoTSiteWiseClient, ListAssetModelPropertiesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
19
|
+
* const client = new IoTSiteWiseClient(config);
|
|
20
|
+
* const command = new ListAssetModelPropertiesCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link ListAssetModelPropertiesCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link ListAssetModelPropertiesCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class ListAssetModelPropertiesCommand extends $Command<ListAssetModelPropertiesCommandInput, ListAssetModelPropertiesCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
30
|
+
readonly input: ListAssetModelPropertiesCommandInput;
|
|
31
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
32
|
+
constructor(input: ListAssetModelPropertiesCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAssetModelPropertiesCommandInput, ListAssetModelPropertiesCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { IoTSiteWiseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTSiteWiseClient";
|
|
5
|
+
import { ListAssetPropertiesRequest, ListAssetPropertiesResponse } from "../models/models_0";
|
|
6
|
+
export interface ListAssetPropertiesCommandInput extends ListAssetPropertiesRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface ListAssetPropertiesCommandOutput extends ListAssetPropertiesResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Retrieves a paginated list of properties associated with an asset.
|
|
12
|
+
* If you update properties associated with the model before you finish listing all the properties,
|
|
13
|
+
* you need to start all over again.</p>
|
|
14
|
+
* @example
|
|
15
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
+
* ```javascript
|
|
17
|
+
* import { IoTSiteWiseClient, ListAssetPropertiesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
|
|
18
|
+
* // const { IoTSiteWiseClient, ListAssetPropertiesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
|
|
19
|
+
* const client = new IoTSiteWiseClient(config);
|
|
20
|
+
* const command = new ListAssetPropertiesCommand(input);
|
|
21
|
+
* const response = await client.send(command);
|
|
22
|
+
* ```
|
|
23
|
+
*
|
|
24
|
+
* @see {@link ListAssetPropertiesCommandInput} for command's `input` shape.
|
|
25
|
+
* @see {@link ListAssetPropertiesCommandOutput} for command's `response` shape.
|
|
26
|
+
* @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare class ListAssetPropertiesCommand extends $Command<ListAssetPropertiesCommandInput, ListAssetPropertiesCommandOutput, IoTSiteWiseClientResolvedConfig> {
|
|
30
|
+
readonly input: ListAssetPropertiesCommandInput;
|
|
31
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
32
|
+
constructor(input: ListAssetPropertiesCommandInput);
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTSiteWiseClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAssetPropertiesCommandInput, ListAssetPropertiesCommandOutput>;
|
|
37
|
+
private serialize;
|
|
38
|
+
private deserialize;
|
|
39
|
+
}
|
|
@@ -8,9 +8,8 @@ export interface ListBulkImportJobsCommandInput extends ListBulkImportJobsReques
|
|
|
8
8
|
export interface ListBulkImportJobsCommandOutput extends ListBulkImportJobsResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Retrieves a paginated list of bulk import job requests. For more information,
|
|
12
|
-
*
|
|
13
|
-
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
11
|
+
* <p>Retrieves a paginated list of bulk import job requests. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html">List bulk
|
|
12
|
+
* import jobs (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
14
13
|
* @example
|
|
15
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
15
|
* ```javascript
|
|
@@ -43,7 +43,9 @@ export * from "./GetAssetPropertyValueCommand";
|
|
|
43
43
|
export * from "./GetAssetPropertyValueHistoryCommand";
|
|
44
44
|
export * from "./GetInterpolatedAssetPropertyValuesCommand";
|
|
45
45
|
export * from "./ListAccessPoliciesCommand";
|
|
46
|
+
export * from "./ListAssetModelPropertiesCommand";
|
|
46
47
|
export * from "./ListAssetModelsCommand";
|
|
48
|
+
export * from "./ListAssetPropertiesCommand";
|
|
47
49
|
export * from "./ListAssetRelationshipsCommand";
|
|
48
50
|
export * from "./ListAssetsCommand";
|
|
49
51
|
export * from "./ListAssociatedAssetsCommand";
|