@aws-sdk/client-iotsitewise 3.201.0 → 3.202.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 +11 -0
- 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-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-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/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/package.json +4 -4
|
@@ -763,6 +763,9 @@ export const serializeAws_restJson1DescribeAssetCommand = async (input, context)
|
|
|
763
763
|
const headers = {};
|
|
764
764
|
let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/assets/{assetId}";
|
|
765
765
|
resolvedPath = __resolvedPath(resolvedPath, input, "assetId", () => input.assetId, "{assetId}", false);
|
|
766
|
+
const query = map({
|
|
767
|
+
excludeProperties: [() => input.excludeProperties !== void 0, () => input.excludeProperties.toString()],
|
|
768
|
+
});
|
|
766
769
|
let body;
|
|
767
770
|
let { hostname: resolvedHostname } = await context.endpoint();
|
|
768
771
|
if (context.disableHostPrefix !== true) {
|
|
@@ -778,6 +781,7 @@ export const serializeAws_restJson1DescribeAssetCommand = async (input, context)
|
|
|
778
781
|
method: "GET",
|
|
779
782
|
headers,
|
|
780
783
|
path: resolvedPath,
|
|
784
|
+
query,
|
|
781
785
|
body,
|
|
782
786
|
});
|
|
783
787
|
};
|
|
@@ -786,6 +790,9 @@ export const serializeAws_restJson1DescribeAssetModelCommand = async (input, con
|
|
|
786
790
|
const headers = {};
|
|
787
791
|
let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/asset-models/{assetModelId}";
|
|
788
792
|
resolvedPath = __resolvedPath(resolvedPath, input, "assetModelId", () => input.assetModelId, "{assetModelId}", false);
|
|
793
|
+
const query = map({
|
|
794
|
+
excludeProperties: [() => input.excludeProperties !== void 0, () => input.excludeProperties.toString()],
|
|
795
|
+
});
|
|
789
796
|
let body;
|
|
790
797
|
let { hostname: resolvedHostname } = await context.endpoint();
|
|
791
798
|
if (context.disableHostPrefix !== true) {
|
|
@@ -801,6 +808,7 @@ export const serializeAws_restJson1DescribeAssetModelCommand = async (input, con
|
|
|
801
808
|
method: "GET",
|
|
802
809
|
headers,
|
|
803
810
|
path: resolvedPath,
|
|
811
|
+
query,
|
|
804
812
|
body,
|
|
805
813
|
});
|
|
806
814
|
};
|
|
@@ -1317,6 +1325,35 @@ export const serializeAws_restJson1ListAccessPoliciesCommand = async (input, con
|
|
|
1317
1325
|
body,
|
|
1318
1326
|
});
|
|
1319
1327
|
};
|
|
1328
|
+
export const serializeAws_restJson1ListAssetModelPropertiesCommand = async (input, context) => {
|
|
1329
|
+
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
1330
|
+
const headers = {};
|
|
1331
|
+
let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/asset-models/{assetModelId}/properties";
|
|
1332
|
+
resolvedPath = __resolvedPath(resolvedPath, input, "assetModelId", () => input.assetModelId, "{assetModelId}", false);
|
|
1333
|
+
const query = map({
|
|
1334
|
+
nextToken: [, input.nextToken],
|
|
1335
|
+
maxResults: [() => input.maxResults !== void 0, () => input.maxResults.toString()],
|
|
1336
|
+
filter: [, input.filter],
|
|
1337
|
+
});
|
|
1338
|
+
let body;
|
|
1339
|
+
let { hostname: resolvedHostname } = await context.endpoint();
|
|
1340
|
+
if (context.disableHostPrefix !== true) {
|
|
1341
|
+
resolvedHostname = "api." + resolvedHostname;
|
|
1342
|
+
if (!__isValidHostname(resolvedHostname)) {
|
|
1343
|
+
throw new Error("ValidationError: prefixed hostname must be hostname compatible.");
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
return new __HttpRequest({
|
|
1347
|
+
protocol,
|
|
1348
|
+
hostname: resolvedHostname,
|
|
1349
|
+
port,
|
|
1350
|
+
method: "GET",
|
|
1351
|
+
headers,
|
|
1352
|
+
path: resolvedPath,
|
|
1353
|
+
query,
|
|
1354
|
+
body,
|
|
1355
|
+
});
|
|
1356
|
+
};
|
|
1320
1357
|
export const serializeAws_restJson1ListAssetModelsCommand = async (input, context) => {
|
|
1321
1358
|
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
1322
1359
|
const headers = {};
|
|
@@ -1344,6 +1381,35 @@ export const serializeAws_restJson1ListAssetModelsCommand = async (input, contex
|
|
|
1344
1381
|
body,
|
|
1345
1382
|
});
|
|
1346
1383
|
};
|
|
1384
|
+
export const serializeAws_restJson1ListAssetPropertiesCommand = async (input, context) => {
|
|
1385
|
+
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
1386
|
+
const headers = {};
|
|
1387
|
+
let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/assets/{assetId}/properties";
|
|
1388
|
+
resolvedPath = __resolvedPath(resolvedPath, input, "assetId", () => input.assetId, "{assetId}", false);
|
|
1389
|
+
const query = map({
|
|
1390
|
+
nextToken: [, input.nextToken],
|
|
1391
|
+
maxResults: [() => input.maxResults !== void 0, () => input.maxResults.toString()],
|
|
1392
|
+
filter: [, input.filter],
|
|
1393
|
+
});
|
|
1394
|
+
let body;
|
|
1395
|
+
let { hostname: resolvedHostname } = await context.endpoint();
|
|
1396
|
+
if (context.disableHostPrefix !== true) {
|
|
1397
|
+
resolvedHostname = "api." + resolvedHostname;
|
|
1398
|
+
if (!__isValidHostname(resolvedHostname)) {
|
|
1399
|
+
throw new Error("ValidationError: prefixed hostname must be hostname compatible.");
|
|
1400
|
+
}
|
|
1401
|
+
}
|
|
1402
|
+
return new __HttpRequest({
|
|
1403
|
+
protocol,
|
|
1404
|
+
hostname: resolvedHostname,
|
|
1405
|
+
port,
|
|
1406
|
+
method: "GET",
|
|
1407
|
+
headers,
|
|
1408
|
+
path: resolvedPath,
|
|
1409
|
+
query,
|
|
1410
|
+
body,
|
|
1411
|
+
});
|
|
1412
|
+
};
|
|
1347
1413
|
export const serializeAws_restJson1ListAssetRelationshipsCommand = async (input, context) => {
|
|
1348
1414
|
const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
|
|
1349
1415
|
const headers = {};
|
|
@@ -4395,6 +4461,51 @@ const deserializeAws_restJson1ListAccessPoliciesCommandError = async (output, co
|
|
|
4395
4461
|
});
|
|
4396
4462
|
}
|
|
4397
4463
|
};
|
|
4464
|
+
export const deserializeAws_restJson1ListAssetModelPropertiesCommand = async (output, context) => {
|
|
4465
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
4466
|
+
return deserializeAws_restJson1ListAssetModelPropertiesCommandError(output, context);
|
|
4467
|
+
}
|
|
4468
|
+
const contents = map({
|
|
4469
|
+
$metadata: deserializeMetadata(output),
|
|
4470
|
+
});
|
|
4471
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
4472
|
+
if (data.assetModelPropertySummaries != null) {
|
|
4473
|
+
contents.assetModelPropertySummaries = deserializeAws_restJson1AssetModelPropertySummaries(data.assetModelPropertySummaries, context);
|
|
4474
|
+
}
|
|
4475
|
+
if (data.nextToken != null) {
|
|
4476
|
+
contents.nextToken = __expectString(data.nextToken);
|
|
4477
|
+
}
|
|
4478
|
+
return contents;
|
|
4479
|
+
};
|
|
4480
|
+
const deserializeAws_restJson1ListAssetModelPropertiesCommandError = async (output, context) => {
|
|
4481
|
+
const parsedOutput = {
|
|
4482
|
+
...output,
|
|
4483
|
+
body: await parseErrorBody(output.body, context),
|
|
4484
|
+
};
|
|
4485
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
4486
|
+
switch (errorCode) {
|
|
4487
|
+
case "InternalFailureException":
|
|
4488
|
+
case "com.amazonaws.iotsitewise#InternalFailureException":
|
|
4489
|
+
throw await deserializeAws_restJson1InternalFailureExceptionResponse(parsedOutput, context);
|
|
4490
|
+
case "InvalidRequestException":
|
|
4491
|
+
case "com.amazonaws.iotsitewise#InvalidRequestException":
|
|
4492
|
+
throw await deserializeAws_restJson1InvalidRequestExceptionResponse(parsedOutput, context);
|
|
4493
|
+
case "ResourceNotFoundException":
|
|
4494
|
+
case "com.amazonaws.iotsitewise#ResourceNotFoundException":
|
|
4495
|
+
throw await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context);
|
|
4496
|
+
case "ThrottlingException":
|
|
4497
|
+
case "com.amazonaws.iotsitewise#ThrottlingException":
|
|
4498
|
+
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
4499
|
+
default:
|
|
4500
|
+
const parsedBody = parsedOutput.body;
|
|
4501
|
+
throwDefaultError({
|
|
4502
|
+
output,
|
|
4503
|
+
parsedBody,
|
|
4504
|
+
exceptionCtor: __BaseException,
|
|
4505
|
+
errorCode,
|
|
4506
|
+
});
|
|
4507
|
+
}
|
|
4508
|
+
};
|
|
4398
4509
|
export const deserializeAws_restJson1ListAssetModelsCommand = async (output, context) => {
|
|
4399
4510
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
4400
4511
|
return deserializeAws_restJson1ListAssetModelsCommandError(output, context);
|
|
@@ -4437,6 +4548,51 @@ const deserializeAws_restJson1ListAssetModelsCommandError = async (output, conte
|
|
|
4437
4548
|
});
|
|
4438
4549
|
}
|
|
4439
4550
|
};
|
|
4551
|
+
export const deserializeAws_restJson1ListAssetPropertiesCommand = async (output, context) => {
|
|
4552
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
4553
|
+
return deserializeAws_restJson1ListAssetPropertiesCommandError(output, context);
|
|
4554
|
+
}
|
|
4555
|
+
const contents = map({
|
|
4556
|
+
$metadata: deserializeMetadata(output),
|
|
4557
|
+
});
|
|
4558
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
4559
|
+
if (data.assetPropertySummaries != null) {
|
|
4560
|
+
contents.assetPropertySummaries = deserializeAws_restJson1AssetPropertySummaries(data.assetPropertySummaries, context);
|
|
4561
|
+
}
|
|
4562
|
+
if (data.nextToken != null) {
|
|
4563
|
+
contents.nextToken = __expectString(data.nextToken);
|
|
4564
|
+
}
|
|
4565
|
+
return contents;
|
|
4566
|
+
};
|
|
4567
|
+
const deserializeAws_restJson1ListAssetPropertiesCommandError = async (output, context) => {
|
|
4568
|
+
const parsedOutput = {
|
|
4569
|
+
...output,
|
|
4570
|
+
body: await parseErrorBody(output.body, context),
|
|
4571
|
+
};
|
|
4572
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
4573
|
+
switch (errorCode) {
|
|
4574
|
+
case "InternalFailureException":
|
|
4575
|
+
case "com.amazonaws.iotsitewise#InternalFailureException":
|
|
4576
|
+
throw await deserializeAws_restJson1InternalFailureExceptionResponse(parsedOutput, context);
|
|
4577
|
+
case "InvalidRequestException":
|
|
4578
|
+
case "com.amazonaws.iotsitewise#InvalidRequestException":
|
|
4579
|
+
throw await deserializeAws_restJson1InvalidRequestExceptionResponse(parsedOutput, context);
|
|
4580
|
+
case "ResourceNotFoundException":
|
|
4581
|
+
case "com.amazonaws.iotsitewise#ResourceNotFoundException":
|
|
4582
|
+
throw await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context);
|
|
4583
|
+
case "ThrottlingException":
|
|
4584
|
+
case "com.amazonaws.iotsitewise#ThrottlingException":
|
|
4585
|
+
throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
|
|
4586
|
+
default:
|
|
4587
|
+
const parsedBody = parsedOutput.body;
|
|
4588
|
+
throwDefaultError({
|
|
4589
|
+
output,
|
|
4590
|
+
parsedBody,
|
|
4591
|
+
exceptionCtor: __BaseException,
|
|
4592
|
+
errorCode,
|
|
4593
|
+
});
|
|
4594
|
+
}
|
|
4595
|
+
};
|
|
4440
4596
|
export const deserializeAws_restJson1ListAssetRelationshipsCommand = async (output, context) => {
|
|
4441
4597
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
4442
4598
|
return deserializeAws_restJson1ListAssetRelationshipsCommandError(output, context);
|
|
@@ -5726,6 +5882,7 @@ const serializeAws_restJson1Alarms = (input, context) => {
|
|
|
5726
5882
|
const serializeAws_restJson1AssetModelCompositeModel = (input, context) => {
|
|
5727
5883
|
return {
|
|
5728
5884
|
...(input.description != null && { description: input.description }),
|
|
5885
|
+
...(input.id != null && { id: input.id }),
|
|
5729
5886
|
...(input.name != null && { name: input.name }),
|
|
5730
5887
|
...(input.properties != null && {
|
|
5731
5888
|
properties: serializeAws_restJson1AssetModelProperties(input.properties, context),
|
|
@@ -6241,6 +6398,7 @@ const deserializeAws_restJson1Alarms = (output, context) => {
|
|
|
6241
6398
|
const deserializeAws_restJson1AssetCompositeModel = (output, context) => {
|
|
6242
6399
|
return {
|
|
6243
6400
|
description: __expectString(output.description),
|
|
6401
|
+
id: __expectString(output.id),
|
|
6244
6402
|
name: __expectString(output.name),
|
|
6245
6403
|
properties: output.properties != null ? deserializeAws_restJson1AssetProperties(output.properties, context) : undefined,
|
|
6246
6404
|
type: __expectString(output.type),
|
|
@@ -6301,6 +6459,7 @@ const deserializeAws_restJson1AssetIDs = (output, context) => {
|
|
|
6301
6459
|
const deserializeAws_restJson1AssetModelCompositeModel = (output, context) => {
|
|
6302
6460
|
return {
|
|
6303
6461
|
description: __expectString(output.description),
|
|
6462
|
+
id: __expectString(output.id),
|
|
6304
6463
|
name: __expectString(output.name),
|
|
6305
6464
|
properties: output.properties != null ? deserializeAws_restJson1AssetModelProperties(output.properties, context) : undefined,
|
|
6306
6465
|
type: __expectString(output.type),
|
|
@@ -6356,6 +6515,28 @@ const deserializeAws_restJson1AssetModelProperty = (output, context) => {
|
|
|
6356
6515
|
unit: __expectString(output.unit),
|
|
6357
6516
|
};
|
|
6358
6517
|
};
|
|
6518
|
+
const deserializeAws_restJson1AssetModelPropertySummaries = (output, context) => {
|
|
6519
|
+
const retVal = (output || [])
|
|
6520
|
+
.filter((e) => e != null)
|
|
6521
|
+
.map((entry) => {
|
|
6522
|
+
if (entry === null) {
|
|
6523
|
+
return null;
|
|
6524
|
+
}
|
|
6525
|
+
return deserializeAws_restJson1AssetModelPropertySummary(entry, context);
|
|
6526
|
+
});
|
|
6527
|
+
return retVal;
|
|
6528
|
+
};
|
|
6529
|
+
const deserializeAws_restJson1AssetModelPropertySummary = (output, context) => {
|
|
6530
|
+
return {
|
|
6531
|
+
assetModelCompositeModelId: __expectString(output.assetModelCompositeModelId),
|
|
6532
|
+
dataType: __expectString(output.dataType),
|
|
6533
|
+
dataTypeSpec: __expectString(output.dataTypeSpec),
|
|
6534
|
+
id: __expectString(output.id),
|
|
6535
|
+
name: __expectString(output.name),
|
|
6536
|
+
type: output.type != null ? deserializeAws_restJson1PropertyType(output.type, context) : undefined,
|
|
6537
|
+
unit: __expectString(output.unit),
|
|
6538
|
+
};
|
|
6539
|
+
};
|
|
6359
6540
|
const deserializeAws_restJson1AssetModelStatus = (output, context) => {
|
|
6360
6541
|
return {
|
|
6361
6542
|
error: output.error != null ? deserializeAws_restJson1ErrorDetails(output.error, context) : undefined,
|
|
@@ -6412,6 +6593,28 @@ const deserializeAws_restJson1AssetProperty = (output, context) => {
|
|
|
6412
6593
|
unit: __expectString(output.unit),
|
|
6413
6594
|
};
|
|
6414
6595
|
};
|
|
6596
|
+
const deserializeAws_restJson1AssetPropertySummaries = (output, context) => {
|
|
6597
|
+
const retVal = (output || [])
|
|
6598
|
+
.filter((e) => e != null)
|
|
6599
|
+
.map((entry) => {
|
|
6600
|
+
if (entry === null) {
|
|
6601
|
+
return null;
|
|
6602
|
+
}
|
|
6603
|
+
return deserializeAws_restJson1AssetPropertySummary(entry, context);
|
|
6604
|
+
});
|
|
6605
|
+
return retVal;
|
|
6606
|
+
};
|
|
6607
|
+
const deserializeAws_restJson1AssetPropertySummary = (output, context) => {
|
|
6608
|
+
return {
|
|
6609
|
+
alias: __expectString(output.alias),
|
|
6610
|
+
assetCompositeModelId: __expectString(output.assetCompositeModelId),
|
|
6611
|
+
id: __expectString(output.id),
|
|
6612
|
+
notification: output.notification != null
|
|
6613
|
+
? deserializeAws_restJson1PropertyNotification(output.notification, context)
|
|
6614
|
+
: undefined,
|
|
6615
|
+
unit: __expectString(output.unit),
|
|
6616
|
+
};
|
|
6617
|
+
};
|
|
6415
6618
|
const deserializeAws_restJson1AssetPropertyValue = (output, context) => {
|
|
6416
6619
|
return {
|
|
6417
6620
|
quality: __expectString(output.quality),
|
|
@@ -6782,6 +6985,7 @@ const deserializeAws_restJson1ColumnNames = (output, context) => {
|
|
|
6782
6985
|
const deserializeAws_restJson1CompositeModelProperty = (output, context) => {
|
|
6783
6986
|
return {
|
|
6784
6987
|
assetProperty: output.assetProperty != null ? deserializeAws_restJson1Property(output.assetProperty, context) : undefined,
|
|
6988
|
+
id: __expectString(output.id),
|
|
6785
6989
|
name: __expectString(output.name),
|
|
6786
6990
|
type: __expectString(output.type),
|
|
6787
6991
|
};
|
|
@@ -44,7 +44,9 @@ import { GetAssetPropertyValueCommandInput, GetAssetPropertyValueCommandOutput }
|
|
|
44
44
|
import { GetAssetPropertyValueHistoryCommandInput, GetAssetPropertyValueHistoryCommandOutput } from "./commands/GetAssetPropertyValueHistoryCommand";
|
|
45
45
|
import { GetInterpolatedAssetPropertyValuesCommandInput, GetInterpolatedAssetPropertyValuesCommandOutput } from "./commands/GetInterpolatedAssetPropertyValuesCommand";
|
|
46
46
|
import { ListAccessPoliciesCommandInput, ListAccessPoliciesCommandOutput } from "./commands/ListAccessPoliciesCommand";
|
|
47
|
+
import { ListAssetModelPropertiesCommandInput, ListAssetModelPropertiesCommandOutput } from "./commands/ListAssetModelPropertiesCommand";
|
|
47
48
|
import { ListAssetModelsCommandInput, ListAssetModelsCommandOutput } from "./commands/ListAssetModelsCommand";
|
|
49
|
+
import { ListAssetPropertiesCommandInput, ListAssetPropertiesCommandOutput } from "./commands/ListAssetPropertiesCommand";
|
|
48
50
|
import { ListAssetRelationshipsCommandInput, ListAssetRelationshipsCommandOutput } from "./commands/ListAssetRelationshipsCommand";
|
|
49
51
|
import { ListAssetsCommandInput, ListAssetsCommandOutput } from "./commands/ListAssetsCommand";
|
|
50
52
|
import { ListAssociatedAssetsCommandInput, ListAssociatedAssetsCommandOutput } from "./commands/ListAssociatedAssetsCommand";
|
|
@@ -103,23 +105,23 @@ export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
|
103
105
|
batchDisassociateProjectAssets(args: BatchDisassociateProjectAssetsCommandInput, cb: (err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void): void;
|
|
104
106
|
batchDisassociateProjectAssets(args: BatchDisassociateProjectAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDisassociateProjectAssetsCommandOutput) => void): void;
|
|
105
107
|
/**
|
|
106
|
-
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
|
|
107
|
-
*
|
|
108
|
-
*
|
|
108
|
+
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
|
|
109
|
+
* 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
|
|
110
|
+
* <i>IoT SiteWise User Guide</i>.</p>
|
|
109
111
|
*/
|
|
110
112
|
batchGetAssetPropertyAggregates(args: BatchGetAssetPropertyAggregatesCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetAssetPropertyAggregatesCommandOutput>;
|
|
111
113
|
batchGetAssetPropertyAggregates(args: BatchGetAssetPropertyAggregatesCommandInput, cb: (err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void): void;
|
|
112
114
|
batchGetAssetPropertyAggregates(args: BatchGetAssetPropertyAggregatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyAggregatesCommandOutput) => void): void;
|
|
113
115
|
/**
|
|
114
116
|
* <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
|
|
115
|
-
*
|
|
117
|
+
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
116
118
|
*/
|
|
117
119
|
batchGetAssetPropertyValue(args: BatchGetAssetPropertyValueCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetAssetPropertyValueCommandOutput>;
|
|
118
120
|
batchGetAssetPropertyValue(args: BatchGetAssetPropertyValueCommandInput, cb: (err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void): void;
|
|
119
121
|
batchGetAssetPropertyValue(args: BatchGetAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAssetPropertyValueCommandOutput) => void): void;
|
|
120
122
|
/**
|
|
121
|
-
* <p>Gets the historical values for one or more asset properties. For more information, see
|
|
122
|
-
*
|
|
123
|
+
* <p>Gets the historical values for one or more asset properties. For more information, see
|
|
124
|
+
* <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>
|
|
123
125
|
*/
|
|
124
126
|
batchGetAssetPropertyValueHistory(args: BatchGetAssetPropertyValueHistoryCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetAssetPropertyValueHistoryCommandOutput>;
|
|
125
127
|
batchGetAssetPropertyValueHistory(args: BatchGetAssetPropertyValueHistoryCommandInput, cb: (err: any, data?: BatchGetAssetPropertyValueHistoryCommandOutput) => void): void;
|
|
@@ -155,7 +157,7 @@ export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
|
155
157
|
batchPutAssetPropertyValue(args: BatchPutAssetPropertyValueCommandInput, cb: (err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void): void;
|
|
156
158
|
batchPutAssetPropertyValue(args: BatchPutAssetPropertyValueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutAssetPropertyValueCommandOutput) => void): void;
|
|
157
159
|
/**
|
|
158
|
-
* <p>Creates an access policy that grants the specified identity (
|
|
160
|
+
* <p>Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or
|
|
159
161
|
* IAM user) access to the specified IoT SiteWise Monitor portal or project resource.</p>
|
|
160
162
|
*/
|
|
161
163
|
createAccessPolicy(args: CreateAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessPolicyCommandOutput>;
|
|
@@ -179,13 +181,11 @@ export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
|
179
181
|
createAssetModel(args: CreateAssetModelCommandInput, cb: (err: any, data?: CreateAssetModelCommandOutput) => void): void;
|
|
180
182
|
createAssetModel(args: CreateAssetModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssetModelCommandOutput) => void): void;
|
|
181
183
|
/**
|
|
182
|
-
* <p>Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information,
|
|
183
|
-
*
|
|
184
|
-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
184
|
+
* <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
|
|
185
|
+
* bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
185
186
|
* <important>
|
|
186
|
-
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job.
|
|
187
|
-
*
|
|
188
|
-
* see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html">PutStorageConfiguration</a>.</p>
|
|
187
|
+
* <p>You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For
|
|
188
|
+
* 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>
|
|
189
189
|
* </important>
|
|
190
190
|
*/
|
|
191
191
|
createBulkImportJob(args: CreateBulkImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateBulkImportJobCommandOutput>;
|
|
@@ -206,7 +206,7 @@ export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
|
206
206
|
createGateway(args: CreateGatewayCommandInput, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
|
|
207
207
|
createGateway(args: CreateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
|
|
208
208
|
/**
|
|
209
|
-
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses
|
|
209
|
+
* <p>Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM
|
|
210
210
|
* to authenticate portal users and manage user permissions.</p>
|
|
211
211
|
* <note>
|
|
212
212
|
* <p>Before you can sign in to a new portal, you must add at least one identity to that
|
|
@@ -341,9 +341,8 @@ export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
|
341
341
|
describeAssetProperty(args: DescribeAssetPropertyCommandInput, cb: (err: any, data?: DescribeAssetPropertyCommandOutput) => void): void;
|
|
342
342
|
describeAssetProperty(args: DescribeAssetPropertyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAssetPropertyCommandOutput) => void): void;
|
|
343
343
|
/**
|
|
344
|
-
* <p>Retrieves information about a bulk import job request. For more information,
|
|
345
|
-
*
|
|
346
|
-
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
344
|
+
* <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
|
|
345
|
+
* a bulk import job (CLI)</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
347
346
|
*/
|
|
348
347
|
describeBulkImportJob(args: DescribeBulkImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBulkImportJobCommandOutput>;
|
|
349
348
|
describeBulkImportJob(args: DescribeBulkImportJobCommandInput, cb: (err: any, data?: DescribeBulkImportJobCommandOutput) => void): void;
|
|
@@ -512,18 +511,34 @@ export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
|
512
511
|
getInterpolatedAssetPropertyValues(args: GetInterpolatedAssetPropertyValuesCommandInput, cb: (err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void): void;
|
|
513
512
|
getInterpolatedAssetPropertyValues(args: GetInterpolatedAssetPropertyValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInterpolatedAssetPropertyValuesCommandOutput) => void): void;
|
|
514
513
|
/**
|
|
515
|
-
* <p>Retrieves a paginated list of access policies for an identity (an
|
|
514
|
+
* <p>Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center
|
|
516
515
|
* group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).</p>
|
|
517
516
|
*/
|
|
518
517
|
listAccessPolicies(args: ListAccessPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessPoliciesCommandOutput>;
|
|
519
518
|
listAccessPolicies(args: ListAccessPoliciesCommandInput, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void): void;
|
|
520
519
|
listAccessPolicies(args: ListAccessPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessPoliciesCommandOutput) => void): void;
|
|
520
|
+
/**
|
|
521
|
+
* <p>Retrieves a paginated list of properties associated with an asset model.
|
|
522
|
+
* If you update properties associated with the model before you finish listing all the properties,
|
|
523
|
+
* you need to start all over again.</p>
|
|
524
|
+
*/
|
|
525
|
+
listAssetModelProperties(args: ListAssetModelPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetModelPropertiesCommandOutput>;
|
|
526
|
+
listAssetModelProperties(args: ListAssetModelPropertiesCommandInput, cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void): void;
|
|
527
|
+
listAssetModelProperties(args: ListAssetModelPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetModelPropertiesCommandOutput) => void): void;
|
|
521
528
|
/**
|
|
522
529
|
* <p>Retrieves a paginated list of summaries of all asset models.</p>
|
|
523
530
|
*/
|
|
524
531
|
listAssetModels(args: ListAssetModelsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetModelsCommandOutput>;
|
|
525
532
|
listAssetModels(args: ListAssetModelsCommandInput, cb: (err: any, data?: ListAssetModelsCommandOutput) => void): void;
|
|
526
533
|
listAssetModels(args: ListAssetModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetModelsCommandOutput) => void): void;
|
|
534
|
+
/**
|
|
535
|
+
* <p>Retrieves a paginated list of properties associated with an asset.
|
|
536
|
+
* If you update properties associated with the model before you finish listing all the properties,
|
|
537
|
+
* you need to start all over again.</p>
|
|
538
|
+
*/
|
|
539
|
+
listAssetProperties(args: ListAssetPropertiesCommandInput, options?: __HttpHandlerOptions): Promise<ListAssetPropertiesCommandOutput>;
|
|
540
|
+
listAssetProperties(args: ListAssetPropertiesCommandInput, cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void): void;
|
|
541
|
+
listAssetProperties(args: ListAssetPropertiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssetPropertiesCommandOutput) => void): void;
|
|
527
542
|
/**
|
|
528
543
|
* <p>Retrieves a paginated list of asset relationships for an asset. You can use this operation
|
|
529
544
|
* to identify an asset's root asset and all associated assets between that asset and its
|
|
@@ -566,9 +581,8 @@ export declare class IoTSiteWise extends IoTSiteWiseClient {
|
|
|
566
581
|
listAssociatedAssets(args: ListAssociatedAssetsCommandInput, cb: (err: any, data?: ListAssociatedAssetsCommandOutput) => void): void;
|
|
567
582
|
listAssociatedAssets(args: ListAssociatedAssetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociatedAssetsCommandOutput) => void): void;
|
|
568
583
|
/**
|
|
569
|
-
* <p>Retrieves a paginated list of bulk import job requests. For more information,
|
|
570
|
-
*
|
|
571
|
-
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
584
|
+
* <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
|
|
585
|
+
* import jobs (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
572
586
|
*/
|
|
573
587
|
listBulkImportJobs(args: ListBulkImportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListBulkImportJobsCommandOutput>;
|
|
574
588
|
listBulkImportJobs(args: ListBulkImportJobsCommandInput, cb: (err: any, data?: ListBulkImportJobsCommandOutput) => void): void;
|
|
@@ -52,7 +52,9 @@ import { GetAssetPropertyValueCommandInput, GetAssetPropertyValueCommandOutput }
|
|
|
52
52
|
import { GetAssetPropertyValueHistoryCommandInput, GetAssetPropertyValueHistoryCommandOutput } from "./commands/GetAssetPropertyValueHistoryCommand";
|
|
53
53
|
import { GetInterpolatedAssetPropertyValuesCommandInput, GetInterpolatedAssetPropertyValuesCommandOutput } from "./commands/GetInterpolatedAssetPropertyValuesCommand";
|
|
54
54
|
import { ListAccessPoliciesCommandInput, ListAccessPoliciesCommandOutput } from "./commands/ListAccessPoliciesCommand";
|
|
55
|
+
import { ListAssetModelPropertiesCommandInput, ListAssetModelPropertiesCommandOutput } from "./commands/ListAssetModelPropertiesCommand";
|
|
55
56
|
import { ListAssetModelsCommandInput, ListAssetModelsCommandOutput } from "./commands/ListAssetModelsCommand";
|
|
57
|
+
import { ListAssetPropertiesCommandInput, ListAssetPropertiesCommandOutput } from "./commands/ListAssetPropertiesCommand";
|
|
56
58
|
import { ListAssetRelationshipsCommandInput, ListAssetRelationshipsCommandOutput } from "./commands/ListAssetRelationshipsCommand";
|
|
57
59
|
import { ListAssetsCommandInput, ListAssetsCommandOutput } from "./commands/ListAssetsCommand";
|
|
58
60
|
import { ListAssociatedAssetsCommandInput, ListAssociatedAssetsCommandOutput } from "./commands/ListAssociatedAssetsCommand";
|
|
@@ -79,8 +81,8 @@ import { UpdateGatewayCommandInput, UpdateGatewayCommandOutput } from "./command
|
|
|
79
81
|
import { UpdatePortalCommandInput, UpdatePortalCommandOutput } from "./commands/UpdatePortalCommand";
|
|
80
82
|
import { UpdateProjectCommandInput, UpdateProjectCommandOutput } from "./commands/UpdateProjectCommand";
|
|
81
83
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
82
|
-
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;
|
|
83
|
-
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;
|
|
84
|
+
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 | ListAssetModelPropertiesCommandInput | ListAssetModelsCommandInput | ListAssetPropertiesCommandInput | 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;
|
|
85
|
+
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 | ListAssetModelPropertiesCommandOutput | ListAssetModelsCommandOutput | ListAssetPropertiesCommandOutput | 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;
|
|
84
86
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
85
87
|
/**
|
|
86
88
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -8,9 +8,9 @@ export interface BatchGetAssetPropertyAggregatesCommandInput extends BatchGetAss
|
|
|
8
8
|
export interface BatchGetAssetPropertyAggregatesCommandOutput extends BatchGetAssetPropertyAggregatesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>Gets aggregated values (for example, average, minimum, and maximum) for one or more asset
|
|
12
|
+
* 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
|
|
13
|
+
* <i>IoT SiteWise User Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface BatchGetAssetPropertyValueCommandOutput extends BatchGetAssetPr
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <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
|
|
12
|
-
*
|
|
12
|
+
* current values</a> in the <i>IoT SiteWise User Guide</i>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -8,8 +8,8 @@ export interface BatchGetAssetPropertyValueHistoryCommandInput extends BatchGetA
|
|
|
8
8
|
export interface BatchGetAssetPropertyValueHistoryCommandOutput extends BatchGetAssetPropertyValueHistoryResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Gets the historical values for one or more asset properties. For more information, see
|
|
12
|
-
*
|
|
11
|
+
* <p>Gets the historical values for one or more asset properties. For more information, see
|
|
12
|
+
* <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>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface CreateAccessPolicyCommandInput extends CreateAccessPolicyReques
|
|
|
8
8
|
export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Creates an access policy that grants the specified identity (
|
|
11
|
+
* <p>Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or
|
|
12
12
|
* IAM user) access to the specified IoT SiteWise Monitor portal or project resource.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -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
|
+
}
|