Skip to content

Commit 6efc758

Browse files
author
awstools
committed
feat(client-iotsitewise): This release adds the following new optional field to the IoT SiteWise asset resource: assetDescription.
1 parent 973cdd0 commit 6efc758

File tree

3 files changed

+71
-6
lines changed

3 files changed

+71
-6
lines changed

‎clients/client-iotsitewise/src/models/models_0.ts‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1588,6 +1588,11 @@ export interface AssetSummary {
15881588
* <p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>
15891589
*/
15901590
hierarchies: AssetHierarchy[] | undefined;
1591+
1592+
/**
1593+
* <p>A description for the asset.</p>
1594+
*/
1595+
description?: string;
15911596
}
15921597

15931598
export namespace AssetSummary {
@@ -1812,6 +1817,11 @@ export interface AssociatedAssetsSummary {
18121817
* <p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>
18131818
*/
18141819
hierarchies: AssetHierarchy[] | undefined;
1820+
1821+
/**
1822+
* <p>A description for the asset.</p>
1823+
*/
1824+
description?: string;
18151825
}
18161826

18171827
export namespace AssociatedAssetsSummary {
@@ -2948,6 +2958,11 @@ export interface CreateAssetRequest {
29482958
* resources</a> in the <i>IoT SiteWise User Guide</i>.</p>
29492959
*/
29502960
tags?: { [key: string]: string };
2961+
2962+
/**
2963+
* <p>A description for the asset.</p>
2964+
*/
2965+
assetDescription?: string;
29512966
}
29522967

29532968
export namespace CreateAssetRequest {
@@ -3983,6 +3998,11 @@ export interface DescribeAssetResponse {
39833998
* <p>The current status of the asset, which contains a state and any error message.</p>
39843999
*/
39854000
assetStatus: AssetStatus | undefined;
4001+
4002+
/**
4003+
* <p>A description for the asset.</p>
4004+
*/
4005+
assetDescription?: string;
39864006
}
39874007

39884008
export namespace DescribeAssetResponse {
@@ -4940,7 +4960,7 @@ export interface DescribeStorageConfigurationResponse {
49404960
* </li>
49414961
* <li>
49424962
* <p>
4943-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier.
4963+
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier.
49444964
* The cold tier is a customer-managed Amazon S3 bucket.</p>
49454965
* </li>
49464966
* </ul>
@@ -6580,7 +6600,7 @@ export interface PutStorageConfigurationRequest {
65806600
* </li>
65816601
* <li>
65826602
* <p>
6583-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier.
6603+
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier.
65846604
* The cold tier is a customer-managed Amazon S3 bucket.</p>
65856605
* </li>
65866606
* </ul>
@@ -6641,7 +6661,7 @@ export interface PutStorageConfigurationResponse {
66416661
* </li>
66426662
* <li>
66436663
* <p>
6644-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier.
6664+
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier.
66456665
* The cold tier is a customer-managed Amazon S3 bucket.</p>
66466666
* </li>
66476667
* </ul>
@@ -6849,6 +6869,11 @@ export interface UpdateAssetRequest {
68496869
* <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
68506870
*/
68516871
clientToken?: string;
6872+
6873+
/**
6874+
* <p>A description for the asset.</p>
6875+
*/
6876+
assetDescription?: string;
68526877
}
68536878

68546879
export namespace UpdateAssetRequest {

‎clients/client-iotsitewise/src/protocols/Aws_restJson1.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -636,6 +636,8 @@ export const serializeAws_restJson1CreateAssetCommand = async (
636636
const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/assets";
637637
let body: any;
638638
body = JSON.stringify({
639+
...(input.assetDescription !== undefined &&
640+
input.assetDescription !== null && { assetDescription: input.assetDescription }),
639641
...(input.assetModelId !== undefined && input.assetModelId !== null && { assetModelId: input.assetModelId }),
640642
...(input.assetName !== undefined && input.assetName !== null && { assetName: input.assetName }),
641643
clientToken: input.clientToken ?? generateIdempotencyToken(),
@@ -2545,6 +2547,8 @@ export const serializeAws_restJson1UpdateAssetCommand = async (
25452547
}
25462548
let body: any;
25472549
body = JSON.stringify({
2550+
...(input.assetDescription !== undefined &&
2551+
input.assetDescription !== null && { assetDescription: input.assetDescription }),
25482552
...(input.assetName !== undefined && input.assetName !== null && { assetName: input.assetName }),
25492553
clientToken: input.clientToken ?? generateIdempotencyToken(),
25502554
});
@@ -4365,6 +4369,7 @@ export const deserializeAws_restJson1DescribeAssetCommand = async (
43654369
assetArn: undefined,
43664370
assetCompositeModels: undefined,
43674371
assetCreationDate: undefined,
4372+
assetDescription: undefined,
43684373
assetHierarchies: undefined,
43694374
assetId: undefined,
43704375
assetLastUpdateDate: undefined,
@@ -4383,6 +4388,9 @@ export const deserializeAws_restJson1DescribeAssetCommand = async (
43834388
if (data.assetCreationDate !== undefined && data.assetCreationDate !== null) {
43844389
contents.assetCreationDate = __expectNonNull(__parseEpochTimestamp(__expectNumber(data.assetCreationDate)));
43854390
}
4391+
if (data.assetDescription !== undefined && data.assetDescription !== null) {
4392+
contents.assetDescription = __expectString(data.assetDescription);
4393+
}
43864394
if (data.assetHierarchies !== undefined && data.assetHierarchies !== null) {
43874395
contents.assetHierarchies = deserializeAws_restJson1AssetHierarchies(data.assetHierarchies, context);
43884396
}
@@ -8309,6 +8317,7 @@ const deserializeAws_restJson1AssetSummary = (output: any, context: __SerdeConte
83098317
output.creationDate !== undefined && output.creationDate !== null
83108318
? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.creationDate)))
83118319
: undefined,
8320+
description: __expectString(output.description),
83128321
hierarchies:
83138322
output.hierarchies !== undefined && output.hierarchies !== null
83148323
? deserializeAws_restJson1AssetHierarchies(output.hierarchies, context)
@@ -8352,6 +8361,7 @@ const deserializeAws_restJson1AssociatedAssetsSummary = (
83528361
output.creationDate !== undefined && output.creationDate !== null
83538362
? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.creationDate)))
83548363
: undefined,
8364+
description: __expectString(output.description),
83558365
hierarchies:
83568366
output.hierarchies !== undefined && output.hierarchies !== null
83578367
? deserializeAws_restJson1AssetHierarchies(output.hierarchies, context)

‎codegen/sdk-codegen/aws-models/iotsitewise.json‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,6 +1227,12 @@
12271227
"smithy.api#documentation": "<p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>",
12281228
"smithy.api#required": {}
12291229
}
1230+
},
1231+
"description": {
1232+
"target": "com.amazonaws.iotsitewise#Description",
1233+
"traits": {
1234+
"smithy.api#documentation": "<p>A description for the asset.</p>"
1235+
}
12301236
}
12311237
},
12321238
"traits": {
@@ -1444,6 +1450,12 @@
14441450
"smithy.api#documentation": "<p>A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships.</p>",
14451451
"smithy.api#required": {}
14461452
}
1453+
},
1454+
"description": {
1455+
"target": "com.amazonaws.iotsitewise#Description",
1456+
"traits": {
1457+
"smithy.api#documentation": "<p>A description for the asset.</p>"
1458+
}
14471459
}
14481460
},
14491461
"traits": {
@@ -3194,6 +3206,12 @@
31943206
"traits": {
31953207
"smithy.api#documentation": "<p>A list of key-value pairs that contain metadata for the asset. For more information, see\n <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html\">Tagging your IoT SiteWise\n resources</a> in the <i>IoT SiteWise User Guide</i>.</p>"
31963208
}
3209+
},
3210+
"assetDescription": {
3211+
"target": "com.amazonaws.iotsitewise#Description",
3212+
"traits": {
3213+
"smithy.api#documentation": "<p>A description for the asset.</p>"
3214+
}
31973215
}
31983216
}
31993217
},
@@ -4746,6 +4764,12 @@
47464764
"smithy.api#documentation": "<p>The current status of the asset, which contains a state and any error message.</p>",
47474765
"smithy.api#required": {}
47484766
}
4767+
},
4768+
"assetDescription": {
4769+
"target": "com.amazonaws.iotsitewise#Description",
4770+
"traits": {
4771+
"smithy.api#documentation": "<p>A description for the asset.</p>"
4772+
}
47494773
}
47504774
}
47514775
},
@@ -5483,7 +5507,7 @@
54835507
"storageType": {
54845508
"target": "com.amazonaws.iotsitewise#StorageType",
54855509
"traits": {
5486-
"smithy.api#documentation": "<p>The storage tier that you specified for your data. \n The <code>storageType</code> parameter can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.</p>\n </li>\n <li>\n <p>\n <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.</p>\n </li>\n </ul>",
5510+
"smithy.api#documentation": "<p>The storage tier that you specified for your data. \n The <code>storageType</code> parameter can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.</p>\n </li>\n <li>\n <p>\n <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier. \n The cold tier is a customer-managed Amazon S3 bucket.</p>\n </li>\n </ul>",
54875511
"smithy.api#required": {}
54885512
}
54895513
},
@@ -8922,7 +8946,7 @@
89228946
"storageType": {
89238947
"target": "com.amazonaws.iotsitewise#StorageType",
89248948
"traits": {
8925-
"smithy.api#documentation": "<p>The storage tier that you specified for your data. \n The <code>storageType</code> parameter can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.</p>\n </li>\n <li>\n <p>\n <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.</p>\n </li>\n </ul>",
8949+
"smithy.api#documentation": "<p>The storage tier that you specified for your data. \n The <code>storageType</code> parameter can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.</p>\n </li>\n <li>\n <p>\n <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier. \n The cold tier is a customer-managed Amazon S3 bucket.</p>\n </li>\n </ul>",
89268950
"smithy.api#required": {}
89278951
}
89288952
},
@@ -8949,7 +8973,7 @@
89498973
"storageType": {
89508974
"target": "com.amazonaws.iotsitewise#StorageType",
89518975
"traits": {
8952-
"smithy.api#documentation": "<p>The storage tier that you specified for your data. \n The <code>storageType</code> parameter can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.</p>\n </li>\n <li>\n <p>\n <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.</p>\n </li>\n </ul>",
8976+
"smithy.api#documentation": "<p>The storage tier that you specified for your data. \n The <code>storageType</code> parameter can be one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.</p>\n </li>\n <li>\n <p>\n <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier. \n The cold tier is a customer-managed Amazon S3 bucket.</p>\n </li>\n </ul>",
89538977
"smithy.api#required": {}
89548978
}
89558979
},
@@ -9954,6 +9978,12 @@
99549978
"smithy.api#documentation": "<p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>",
99559979
"smithy.api#idempotencyToken": {}
99569980
}
9981+
},
9982+
"assetDescription": {
9983+
"target": "com.amazonaws.iotsitewise#Description",
9984+
"traits": {
9985+
"smithy.api#documentation": "<p>A description for the asset.</p>"
9986+
}
99579987
}
99589988
}
99599989
},

0 commit comments

Comments
 (0)