Skip to content

Commit 4081f69

Browse files
author
awstools
committed
feat(client-iotsitewise): This release adds the ListAssetModelProperties and ListAssetProperties APIs. You can list all properties that belong to a single asset model or asset using these two new APIs.
1 parent d3ccee7 commit 4081f69

20 files changed

+2403
-905
lines changed

‎clients/client-iotsitewise/src/IoTSiteWise.ts

Lines changed: 95 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,21 @@ import {
218218
ListAccessPoliciesCommandInput,
219219
ListAccessPoliciesCommandOutput,
220220
} from "./commands/ListAccessPoliciesCommand";
221+
import {
222+
ListAssetModelPropertiesCommand,
223+
ListAssetModelPropertiesCommandInput,
224+
ListAssetModelPropertiesCommandOutput,
225+
} from "./commands/ListAssetModelPropertiesCommand";
221226
import {
222227
ListAssetModelsCommand,
223228
ListAssetModelsCommandInput,
224229
ListAssetModelsCommandOutput,
225230
} from "./commands/ListAssetModelsCommand";
231+
import {
232+
ListAssetPropertiesCommand,
233+
ListAssetPropertiesCommandInput,
234+
ListAssetPropertiesCommandOutput,
235+
} from "./commands/ListAssetPropertiesCommand";
226236
import {
227237
ListAssetRelationshipsCommand,
228238
ListAssetRelationshipsCommandInput,
@@ -470,9 +480,9 @@ export class IoTSiteWise extends IoTSiteWiseClient {
470480
}
471481

472482
/**
473-
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
474-
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying
475-
* aggregates</a> in the <i>IoT SiteWise User Guide</i>.</p>
483+
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
484+
* properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying aggregates</a> in the
485+
* <i>IoT SiteWise User Guide</i>.</p>
476486
*/
477487
public batchGetAssetPropertyAggregates(
478488
args: BatchGetAssetPropertyAggregatesCommandInput,
@@ -505,7 +515,7 @@ export class IoTSiteWise extends IoTSiteWiseClient {
505515

506516
/**
507517
* <p>Gets the current value for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values">Querying
508-
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
518+
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
509519
*/
510520
public batchGetAssetPropertyValue(
511521
args: BatchGetAssetPropertyValueCommandInput,
@@ -537,8 +547,8 @@ export class IoTSiteWise extends IoTSiteWiseClient {
537547
}
538548

539549
/**
540-
* <p>Gets the historical values for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying
541-
* historical values</a> in the <i>IoT SiteWise User Guide</i>.</p>
550+
* <p>Gets the historical values for one or more asset properties. For more information, see
551+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying historical values</a> in the <i>IoT SiteWise User Guide</i>.</p>
542552
*/
543553
public batchGetAssetPropertyValueHistory(
544554
args: BatchGetAssetPropertyValueHistoryCommandInput,
@@ -626,7 +636,7 @@ export class IoTSiteWise extends IoTSiteWiseClient {
626636
}
627637

628638
/**
629-
* <p>Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or
639+
* <p>Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or
630640
* IAM user) access to the specified IoT SiteWise Monitor portal or project resource.</p>
631641
*/
632642
public createAccessPolicy(
@@ -722,13 +732,11 @@ export class IoTSiteWise extends IoTSiteWiseClient {
722732
}
723733

724734
/**
725-
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information,
726-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a bulk import job (CLI)</a>
727-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
735+
* <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
736+
* bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
728737
* <important>
729-
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job.
730-
* For more information about how to configure storage settings,
731-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
738+
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For
739+
* 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>
732740
* </important>
733741
*/
734742
public createBulkImportJob(
@@ -827,7 +835,7 @@ export class IoTSiteWise extends IoTSiteWiseClient {
827835
}
828836

829837
/**
830-
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM
838+
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM
831839
* to authenticate portal users and manage user permissions.</p>
832840
* <note>
833841
* <p>Before you can sign in to a new portal, you must add at least one identity to that
@@ -1314,9 +1322,8 @@ export class IoTSiteWise extends IoTSiteWiseClient {
13141322
}
13151323

13161324
/**
1317-
* <p>Retrieves information about a bulk import job request. For more information,
1318-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html">Describe a bulk import job (CLI)</a>
1319-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
1325+
* <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
1326+
* a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
13201327
*/
13211328
public describeBulkImportJob(
13221329
args: DescribeBulkImportJobCommandInput,
@@ -1907,7 +1914,7 @@ export class IoTSiteWise extends IoTSiteWiseClient {
19071914
}
19081915

19091916
/**
1910-
* <p>Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO
1917+
* <p>Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center
19111918
* group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).</p>
19121919
*/
19131920
public listAccessPolicies(
@@ -1939,6 +1946,40 @@ export class IoTSiteWise extends IoTSiteWiseClient {
19391946
}
19401947
}
19411948

1949+
/**
1950+
* <p>Retrieves a paginated list of properties associated with an asset model.
1951+
* If you update properties associated with the model before you finish listing all the properties,
1952+
* you need to start all over again.</p>
1953+
*/
1954+
public listAssetModelProperties(
1955+
args: ListAssetModelPropertiesCommandInput,
1956+
options?: __HttpHandlerOptions
1957+
): Promise<ListAssetModelPropertiesCommandOutput>;
1958+
public listAssetModelProperties(
1959+
args: ListAssetModelPropertiesCommandInput,
1960+
cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void
1961+
): void;
1962+
public listAssetModelProperties(
1963+
args: ListAssetModelPropertiesCommandInput,
1964+
options: __HttpHandlerOptions,
1965+
cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void
1966+
): void;
1967+
public listAssetModelProperties(
1968+
args: ListAssetModelPropertiesCommandInput,
1969+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetModelPropertiesCommandOutput) => void),
1970+
cb?: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void
1971+
): Promise<ListAssetModelPropertiesCommandOutput> | void {
1972+
const command = new ListAssetModelPropertiesCommand(args);
1973+
if (typeof optionsOrCb === "function") {
1974+
this.send(command, optionsOrCb);
1975+
} else if (typeof cb === "function") {
1976+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
1977+
this.send(command, optionsOrCb || {}, cb);
1978+
} else {
1979+
return this.send(command, optionsOrCb);
1980+
}
1981+
}
1982+
19421983
/**
19431984
* <p>Retrieves a paginated list of summaries of all asset models.</p>
19441985
*/
@@ -1971,6 +2012,40 @@ export class IoTSiteWise extends IoTSiteWiseClient {
19712012
}
19722013
}
19732014

2015+
/**
2016+
* <p>Retrieves a paginated list of properties associated with an asset.
2017+
* If you update properties associated with the model before you finish listing all the properties,
2018+
* you need to start all over again.</p>
2019+
*/
2020+
public listAssetProperties(
2021+
args: ListAssetPropertiesCommandInput,
2022+
options?: __HttpHandlerOptions
2023+
): Promise<ListAssetPropertiesCommandOutput>;
2024+
public listAssetProperties(
2025+
args: ListAssetPropertiesCommandInput,
2026+
cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void
2027+
): void;
2028+
public listAssetProperties(
2029+
args: ListAssetPropertiesCommandInput,
2030+
options: __HttpHandlerOptions,
2031+
cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void
2032+
): void;
2033+
public listAssetProperties(
2034+
args: ListAssetPropertiesCommandInput,
2035+
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListAssetPropertiesCommandOutput) => void),
2036+
cb?: (err: any, data?: ListAssetPropertiesCommandOutput) => void
2037+
): Promise<ListAssetPropertiesCommandOutput> | void {
2038+
const command = new ListAssetPropertiesCommand(args);
2039+
if (typeof optionsOrCb === "function") {
2040+
this.send(command, optionsOrCb);
2041+
} else if (typeof cb === "function") {
2042+
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
2043+
this.send(command, optionsOrCb || {}, cb);
2044+
} else {
2045+
return this.send(command, optionsOrCb);
2046+
}
2047+
}
2048+
19742049
/**
19752050
* <p>Retrieves a paginated list of asset relationships for an asset. You can use this operation
19762051
* to identify an asset's root asset and all associated assets between that asset and its
@@ -2085,9 +2160,8 @@ export class IoTSiteWise extends IoTSiteWiseClient {
20852160
}
20862161

20872162
/**
2088-
* <p>Retrieves a paginated list of bulk import job requests. For more information,
2089-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html">List bulk import jobs (CLI)</a>
2090-
* in the <i>IoT SiteWise User Guide</i>.</p>
2163+
* <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
2164+
* import jobs (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
20912165
*/
20922166
public listBulkImportJobs(
20932167
args: ListBulkImportJobsCommandInput,

‎clients/client-iotsitewise/src/IoTSiteWiseClient.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,15 @@ import {
152152
GetInterpolatedAssetPropertyValuesCommandOutput,
153153
} from "./commands/GetInterpolatedAssetPropertyValuesCommand";
154154
import { ListAccessPoliciesCommandInput, ListAccessPoliciesCommandOutput } from "./commands/ListAccessPoliciesCommand";
155+
import {
156+
ListAssetModelPropertiesCommandInput,
157+
ListAssetModelPropertiesCommandOutput,
158+
} from "./commands/ListAssetModelPropertiesCommand";
155159
import { ListAssetModelsCommandInput, ListAssetModelsCommandOutput } from "./commands/ListAssetModelsCommand";
160+
import {
161+
ListAssetPropertiesCommandInput,
162+
ListAssetPropertiesCommandOutput,
163+
} from "./commands/ListAssetPropertiesCommand";
156164
import {
157165
ListAssetRelationshipsCommandInput,
158166
ListAssetRelationshipsCommandOutput,
@@ -253,7 +261,9 @@ export type ServiceInputTypes =
253261
| GetAssetPropertyValueHistoryCommandInput
254262
| GetInterpolatedAssetPropertyValuesCommandInput
255263
| ListAccessPoliciesCommandInput
264+
| ListAssetModelPropertiesCommandInput
256265
| ListAssetModelsCommandInput
266+
| ListAssetPropertiesCommandInput
257267
| ListAssetRelationshipsCommandInput
258268
| ListAssetsCommandInput
259269
| ListAssociatedAssetsCommandInput
@@ -326,7 +336,9 @@ export type ServiceOutputTypes =
326336
| GetAssetPropertyValueHistoryCommandOutput
327337
| GetInterpolatedAssetPropertyValuesCommandOutput
328338
| ListAccessPoliciesCommandOutput
339+
| ListAssetModelPropertiesCommandOutput
329340
| ListAssetModelsCommandOutput
341+
| ListAssetPropertiesCommandOutput
330342
| ListAssetRelationshipsCommandOutput
331343
| ListAssetsCommandOutput
332344
| ListAssociatedAssetsCommandOutput

‎clients/client-iotsitewise/src/commands/BatchGetAssetPropertyAggregatesCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ export interface BatchGetAssetPropertyAggregatesCommandOutput
3131
__MetadataBearer {}
3232

3333
/**
34-
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
35-
* For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying
36-
* aggregates</a> in the <i>IoT SiteWise User Guide</i>.</p>
34+
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
35+
* properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates">Querying aggregates</a> in the
36+
* <i>IoT SiteWise User Guide</i>.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

‎clients/client-iotsitewise/src/commands/BatchGetAssetPropertyValueCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface BatchGetAssetPropertyValueCommandOutput extends BatchGetAssetPr
3030

3131
/**
3232
* <p>Gets the current value for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values">Querying
33-
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
33+
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

‎clients/client-iotsitewise/src/commands/BatchGetAssetPropertyValueHistoryCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export interface BatchGetAssetPropertyValueHistoryCommandOutput
3131
__MetadataBearer {}
3232

3333
/**
34-
* <p>Gets the historical values for one or more asset properties. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying
35-
* historical values</a> in the <i>IoT SiteWise User Guide</i>.</p>
34+
* <p>Gets the historical values for one or more asset properties. For more information, see
35+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values">Querying historical values</a> in the <i>IoT SiteWise User Guide</i>.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

‎clients/client-iotsitewise/src/commands/CreateAccessPolicyCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface CreateAccessPolicyCommandInput extends CreateAccessPolicyReques
2929
export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or
32+
* <p>Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or
3333
* IAM user) access to the specified IoT SiteWise Monitor portal or project resource.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotsitewise/src/commands/CreateBulkImportJobCommand.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,11 @@ export interface CreateBulkImportJobCommandInput extends CreateBulkImportJobRequ
2929
export interface CreateBulkImportJobCommandOutput extends CreateBulkImportJobResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information,
33-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html">Create a bulk import job (CLI)</a>
34-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
32+
* <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
33+
* bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
3534
* <important>
36-
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job.
37-
* For more information about how to configure storage settings,
38-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
35+
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For
36+
* 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>
3937
* </important>
4038
* @example
4139
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-iotsitewise/src/commands/CreatePortalCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface CreatePortalCommandInput extends CreatePortalRequest {}
2929
export interface CreatePortalCommandOutput extends CreatePortalResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM
32+
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM
3333
* to authenticate portal users and manage user permissions.</p>
3434
* <note>
3535
* <p>Before you can sign in to a new portal, you must add at least one identity to that

‎clients/client-iotsitewise/src/commands/DescribeBulkImportJobCommand.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@ export interface DescribeBulkImportJobCommandInput extends DescribeBulkImportJob
2929
export interface DescribeBulkImportJobCommandOutput extends DescribeBulkImportJobResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Retrieves information about a bulk import job request. For more information,
33-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html">Describe a bulk import job (CLI)</a>
34-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
32+
* <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
33+
* a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
3534
* @example
3635
* Use a bare-bones client and the command you need to make an API call.
3736
* ```javascript

‎clients/client-iotsitewise/src/commands/ListAccessPoliciesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface ListAccessPoliciesCommandInput extends ListAccessPoliciesReques
2929
export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO
32+
* <p>Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center
3333
* group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)