Skip to content

Commit 1f9abd0

Browse files
author
awstools
committed
feat(client-iotdeviceadvisor): AWS IoT Core Device Advisor now supports new Qualification Suite test case list. With this update, customers can more easily create new qualification test suite with an empty rootGroup input.
1 parent f96195b commit 1f9abd0

File tree

2 files changed

+28
-18
lines changed

2 files changed

+28
-18
lines changed

clients/client-iotdeviceadvisor/src/models/models_0.ts

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,18 @@ export interface SuiteDefinitionConfiguration {
101101
isLongDurationTest?: boolean;
102102

103103
/**
104-
* <p>Gets the test suite root group. This is a required parameter.</p>
104+
* <p>Gets the test suite root group. This is a required parameter.
105+
* For updating or creating the latest qualification suite,
106+
* if <code>intendedForQualification</code> is set to true,
107+
* <code>rootGroup</code> can be an empty string. If <code>intendedForQualification</code> is false,
108+
* <code>rootGroup</code> cannot be an empty string.
109+
* If <code>rootGroup</code> is empty, and
110+
* <code>intendedForQualification</code> is set to true,
111+
* all the qualification tests are included, and the configuration is default.</p>
112+
* <p>
113+
* For a qualification suite, the minimum length is 0, and the maximum is 2048. For a
114+
* non-qualification suite, the minimum length is 1, and the maximum is 2048.
115+
* </p>
105116
*/
106117
rootGroup: string | undefined;
107118

@@ -368,8 +379,8 @@ export type SuiteRunStatus = (typeof SuiteRunStatus)[keyof typeof SuiteRunStatus
368379
*/
369380
export interface SuiteRunConfiguration {
370381
/**
371-
* <p>Sets the primary device for the test suite run. This requires
372-
* a thing ARN or a certificate ARN.</p>
382+
* <p>Sets the primary device for the test suite run. This requires a thing ARN or a
383+
* certificate ARN.</p>
373384
*/
374385
primaryDevice: DeviceUnderTest | undefined;
375386

@@ -511,8 +522,7 @@ export interface TestCaseScenario {
511522
failure?: string;
512523

513524
/**
514-
* <p>
515-
* </p>
525+
* <p>Provides test case scenario system messages if any.</p>
516526
*/
517527
systemMessage?: string;
518528
}
@@ -904,8 +914,8 @@ export interface ListSuiteRunsResponse {
904914
*/
905915
export interface ListTagsForResourceRequest {
906916
/**
907-
* <p>The resource ARN of the IoT Device Advisor resource.
908-
* This can be SuiteDefinition ARN or SuiteRun ARN.</p>
917+
* <p>The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or
918+
* SuiteRun ARN.</p>
909919
*/
910920
resourceArn: string | undefined;
911921
}
@@ -995,8 +1005,8 @@ export interface StopSuiteRunResponse {}
9951005
*/
9961006
export interface TagResourceRequest {
9971007
/**
998-
* <p>The resource ARN of an IoT Device Advisor resource.
999-
* This can be SuiteDefinition ARN or SuiteRun ARN.</p>
1008+
* <p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or
1009+
* SuiteRun ARN.</p>
10001010
*/
10011011
resourceArn: string | undefined;
10021012

@@ -1016,8 +1026,8 @@ export interface TagResourceResponse {}
10161026
*/
10171027
export interface UntagResourceRequest {
10181028
/**
1019-
* <p>The resource ARN of an IoT Device Advisor resource.
1020-
* This can be SuiteDefinition ARN or SuiteRun ARN.</p>
1029+
* <p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or
1030+
* SuiteRun ARN.</p>
10211031
*/
10221032
resourceArn: string | undefined;
10231033

codegen/sdk-codegen/aws-models/iotdeviceadvisor.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1653,7 +1653,7 @@
16531653
"resourceArn": {
16541654
"target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName",
16551655
"traits": {
1656-
"smithy.api#documentation": "<p>The resource ARN of the IoT Device Advisor resource.\n This can be SuiteDefinition ARN or SuiteRun ARN.</p>",
1656+
"smithy.api#documentation": "<p>The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.</p>",
16571657
"smithy.api#httpLabel": {},
16581658
"smithy.api#required": {}
16591659
}
@@ -1757,7 +1757,7 @@
17571757
"type": "string",
17581758
"traits": {
17591759
"smithy.api#length": {
1760-
"min": 1,
1760+
"min": 0,
17611761
"max": 2048
17621762
}
17631763
}
@@ -2038,7 +2038,7 @@
20382038
"rootGroup": {
20392039
"target": "com.amazonaws.iotdeviceadvisor#RootGroup",
20402040
"traits": {
2041-
"smithy.api#documentation": "<p>Gets the test suite root group. This is a required parameter.</p>",
2041+
"smithy.api#documentation": "<p>Gets the test suite root group. This is a required parameter.\n For updating or creating the latest qualification suite, \n if <code>intendedForQualification</code> is set to true, \n <code>rootGroup</code> can be an empty string. If <code>intendedForQualification</code> is false, \n <code>rootGroup</code> cannot be an empty string.\n If <code>rootGroup</code> is empty, and \n <code>intendedForQualification</code> is set to true, \n all the qualification tests are included, and the configuration is default.</p>\n <p>\n For a qualification suite, the minimum length is 0, and the maximum is 2048. For a \n non-qualification suite, the minimum length is 1, and the maximum is 2048.\n </p>",
20422042
"smithy.api#required": {}
20432043
}
20442044
},
@@ -2142,7 +2142,7 @@
21422142
"primaryDevice": {
21432143
"target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTest",
21442144
"traits": {
2145-
"smithy.api#documentation": "<p>Sets the primary device for the test suite run. This requires\n a thing ARN or a certificate ARN.</p>",
2145+
"smithy.api#documentation": "<p>Sets the primary device for the test suite run. This requires a thing ARN or a\n certificate ARN.</p>",
21462146
"smithy.api#required": {}
21472147
}
21482148
},
@@ -2373,7 +2373,7 @@
23732373
"resourceArn": {
23742374
"target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName",
23752375
"traits": {
2376-
"smithy.api#documentation": "<p>The resource ARN of an IoT Device Advisor resource. \n This can be SuiteDefinition ARN or SuiteRun ARN.</p>",
2376+
"smithy.api#documentation": "<p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.</p>",
23772377
"smithy.api#httpLabel": {},
23782378
"smithy.api#required": {}
23792379
}
@@ -2507,7 +2507,7 @@
25072507
"systemMessage": {
25082508
"target": "com.amazonaws.iotdeviceadvisor#SystemMessage",
25092509
"traits": {
2510-
"smithy.api#documentation": "<p>\n </p>"
2510+
"smithy.api#documentation": "<p>Provides test case scenario system messages if any.</p>"
25112511
}
25122512
}
25132513
},
@@ -2669,7 +2669,7 @@
26692669
"resourceArn": {
26702670
"target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName",
26712671
"traits": {
2672-
"smithy.api#documentation": "<p>The resource ARN of an IoT Device Advisor resource.\n This can be SuiteDefinition ARN or SuiteRun ARN.</p>",
2672+
"smithy.api#documentation": "<p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.</p>",
26732673
"smithy.api#httpLabel": {},
26742674
"smithy.api#required": {}
26752675
}

0 commit comments

Comments
 (0)