@aws-sdk/client-iotdeviceadvisor 3.533.0 → 3.540.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.
Files changed (39) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/IotDeviceAdvisor.d.ts +4 -1
  6. package/dist-types/IotDeviceAdvisorClient.d.ts +1 -1
  7. package/dist-types/commands/CreateSuiteDefinitionCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteSuiteDefinitionCommand.d.ts +2 -1
  9. package/dist-types/commands/GetEndpointCommand.d.ts +2 -1
  10. package/dist-types/commands/GetSuiteDefinitionCommand.d.ts +2 -1
  11. package/dist-types/commands/GetSuiteRunCommand.d.ts +2 -1
  12. package/dist-types/commands/GetSuiteRunReportCommand.d.ts +2 -1
  13. package/dist-types/commands/ListSuiteDefinitionsCommand.d.ts +2 -1
  14. package/dist-types/commands/ListSuiteRunsCommand.d.ts +2 -1
  15. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  16. package/dist-types/commands/StartSuiteRunCommand.d.ts +2 -1
  17. package/dist-types/commands/StopSuiteRunCommand.d.ts +2 -1
  18. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  19. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  20. package/dist-types/commands/UpdateSuiteDefinitionCommand.d.ts +2 -1
  21. package/dist-types/index.d.ts +0 -1
  22. package/dist-types/models/models_0.d.ts +134 -134
  23. package/dist-types/ts3.4/IotDeviceAdvisor.d.ts +3 -0
  24. package/dist-types/ts3.4/commands/CreateSuiteDefinitionCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/DeleteSuiteDefinitionCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/GetEndpointCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/GetSuiteDefinitionCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/GetSuiteRunCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/GetSuiteRunReportCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/ListSuiteDefinitionsCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/ListSuiteRunsCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/StartSuiteRunCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/StopSuiteRunCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/UpdateSuiteDefinitionCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/index.d.ts +0 -1
  39. package/package.json +40 -40
@@ -13,8 +13,8 @@ export declare const AuthenticationMethod: {
13
13
  */
14
14
  export type AuthenticationMethod = (typeof AuthenticationMethod)[keyof typeof AuthenticationMethod];
15
15
  /**
16
- * @public
17
16
  * <p>Sends a Conflict Exception.</p>
17
+ * @public
18
18
  */
19
19
  export declare class ConflictException extends __BaseException {
20
20
  readonly name: "ConflictException";
@@ -25,24 +25,24 @@ export declare class ConflictException extends __BaseException {
25
25
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
26
26
  }
27
27
  /**
28
- * @public
29
28
  * <p>Information of a test device. A thing ARN, certificate ARN
30
29
  * or device role ARN is required.</p>
30
+ * @public
31
31
  */
32
32
  export interface DeviceUnderTest {
33
33
  /**
34
- * @public
35
34
  * <p>Lists device's thing ARN.</p>
35
+ * @public
36
36
  */
37
37
  thingArn?: string;
38
38
  /**
39
- * @public
40
39
  * <p>Lists device's certificate ARN.</p>
40
+ * @public
41
41
  */
42
42
  certificateArn?: string;
43
43
  /**
44
- * @public
45
44
  * <p>Lists device's role ARN.</p>
45
+ * @public
46
46
  */
47
47
  deviceRoleArn?: string;
48
48
  }
@@ -61,32 +61,31 @@ export declare const Protocol: {
61
61
  */
62
62
  export type Protocol = (typeof Protocol)[keyof typeof Protocol];
63
63
  /**
64
- * @public
65
64
  * <p>Gets the suite definition configuration.</p>
65
+ * @public
66
66
  */
67
67
  export interface SuiteDefinitionConfiguration {
68
68
  /**
69
- * @public
70
69
  * <p>Gets the suite definition name. This is a required parameter.</p>
70
+ * @public
71
71
  */
72
72
  suiteDefinitionName: string | undefined;
73
73
  /**
74
- * @public
75
74
  * <p>Gets the devices configured.</p>
75
+ * @public
76
76
  */
77
77
  devices?: DeviceUnderTest[];
78
78
  /**
79
- * @public
80
79
  * <p>Gets the tests intended for qualification in a suite.</p>
80
+ * @public
81
81
  */
82
82
  intendedForQualification?: boolean;
83
83
  /**
84
- * @public
85
84
  * <p>Verifies if the test suite is a long duration test.</p>
85
+ * @public
86
86
  */
87
87
  isLongDurationTest?: boolean;
88
88
  /**
89
- * @public
90
89
  * <p>Gets the test suite root group. This is a required parameter.
91
90
  * For updating or creating the latest qualification suite,
92
91
  * if <code>intendedForQualification</code> is set to true,
@@ -99,16 +98,17 @@ export interface SuiteDefinitionConfiguration {
99
98
  * For a qualification suite, the minimum length is 0, and the maximum is 2048. For a
100
99
  * non-qualification suite, the minimum length is 1, and the maximum is 2048.
101
100
  * </p>
101
+ * @public
102
102
  */
103
103
  rootGroup: string | undefined;
104
104
  /**
105
- * @public
106
105
  * <p>Gets the device permission ARN. This is a required parameter.</p>
106
+ * @public
107
107
  */
108
108
  devicePermissionRoleArn: string | undefined;
109
109
  /**
110
- * @public
111
110
  * <p>Sets the MQTT protocol that is configured in the suite definition.</p>
111
+ * @public
112
112
  */
113
113
  protocol?: Protocol;
114
114
  }
@@ -117,13 +117,13 @@ export interface SuiteDefinitionConfiguration {
117
117
  */
118
118
  export interface CreateSuiteDefinitionRequest {
119
119
  /**
120
- * @public
121
120
  * <p>Creates a Device Advisor test suite with suite definition configuration.</p>
121
+ * @public
122
122
  */
123
123
  suiteDefinitionConfiguration: SuiteDefinitionConfiguration | undefined;
124
124
  /**
125
- * @public
126
125
  * <p>The tags to be attached to the suite definition.</p>
126
+ * @public
127
127
  */
128
128
  tags?: Record<string, string>;
129
129
  }
@@ -132,29 +132,29 @@ export interface CreateSuiteDefinitionRequest {
132
132
  */
133
133
  export interface CreateSuiteDefinitionResponse {
134
134
  /**
135
- * @public
136
135
  * <p>The UUID of the test suite created.</p>
136
+ * @public
137
137
  */
138
138
  suiteDefinitionId?: string;
139
139
  /**
140
- * @public
141
140
  * <p>The Amazon Resource Name (ARN) of the test suite.</p>
141
+ * @public
142
142
  */
143
143
  suiteDefinitionArn?: string;
144
144
  /**
145
- * @public
146
145
  * <p>The suite definition name of the test suite. This is a required parameter.</p>
146
+ * @public
147
147
  */
148
148
  suiteDefinitionName?: string;
149
149
  /**
150
- * @public
151
150
  * <p>The timestamp of when the test suite was created.</p>
151
+ * @public
152
152
  */
153
153
  createdAt?: Date;
154
154
  }
155
155
  /**
156
- * @public
157
156
  * <p>Sends an Internal Failure exception.</p>
157
+ * @public
158
158
  */
159
159
  export declare class InternalServerException extends __BaseException {
160
160
  readonly name: "InternalServerException";
@@ -165,8 +165,8 @@ export declare class InternalServerException extends __BaseException {
165
165
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
166
166
  }
167
167
  /**
168
- * @public
169
168
  * <p>Sends a validation exception.</p>
169
+ * @public
170
170
  */
171
171
  export declare class ValidationException extends __BaseException {
172
172
  readonly name: "ValidationException";
@@ -181,8 +181,8 @@ export declare class ValidationException extends __BaseException {
181
181
  */
182
182
  export interface DeleteSuiteDefinitionRequest {
183
183
  /**
184
- * @public
185
184
  * <p>Suite definition ID of the test suite to be deleted.</p>
185
+ * @public
186
186
  */
187
187
  suiteDefinitionId: string | undefined;
188
188
  }
@@ -196,23 +196,23 @@ export interface DeleteSuiteDefinitionResponse {
196
196
  */
197
197
  export interface GetEndpointRequest {
198
198
  /**
199
- * @public
200
199
  * <p>The thing ARN of the device. This is an optional parameter.</p>
200
+ * @public
201
201
  */
202
202
  thingArn?: string;
203
203
  /**
204
- * @public
205
204
  * <p>The certificate ARN of the device. This is an optional parameter.</p>
205
+ * @public
206
206
  */
207
207
  certificateArn?: string;
208
208
  /**
209
- * @public
210
209
  * <p>The device role ARN of the device. This is an optional parameter.</p>
210
+ * @public
211
211
  */
212
212
  deviceRoleArn?: string;
213
213
  /**
214
- * @public
215
214
  * <p>The authentication method used during the device connection.</p>
215
+ * @public
216
216
  */
217
217
  authenticationMethod?: AuthenticationMethod;
218
218
  }
@@ -221,14 +221,14 @@ export interface GetEndpointRequest {
221
221
  */
222
222
  export interface GetEndpointResponse {
223
223
  /**
224
- * @public
225
224
  * <p>The response of an Device Advisor endpoint.</p>
225
+ * @public
226
226
  */
227
227
  endpoint?: string;
228
228
  }
229
229
  /**
230
- * @public
231
230
  * <p>Sends a Resource Not Found exception.</p>
231
+ * @public
232
232
  */
233
233
  export declare class ResourceNotFoundException extends __BaseException {
234
234
  readonly name: "ResourceNotFoundException";
@@ -243,13 +243,13 @@ export declare class ResourceNotFoundException extends __BaseException {
243
243
  */
244
244
  export interface GetSuiteDefinitionRequest {
245
245
  /**
246
- * @public
247
246
  * <p>Suite definition ID of the test suite to get.</p>
247
+ * @public
248
248
  */
249
249
  suiteDefinitionId: string | undefined;
250
250
  /**
251
- * @public
252
251
  * <p>Suite definition version of the test suite to get.</p>
252
+ * @public
253
253
  */
254
254
  suiteDefinitionVersion?: string;
255
255
  }
@@ -258,43 +258,43 @@ export interface GetSuiteDefinitionRequest {
258
258
  */
259
259
  export interface GetSuiteDefinitionResponse {
260
260
  /**
261
- * @public
262
261
  * <p>Suite definition ID of the suite definition.</p>
262
+ * @public
263
263
  */
264
264
  suiteDefinitionId?: string;
265
265
  /**
266
- * @public
267
266
  * <p>The ARN of the suite definition.</p>
267
+ * @public
268
268
  */
269
269
  suiteDefinitionArn?: string;
270
270
  /**
271
- * @public
272
271
  * <p>Suite definition version of the suite definition.</p>
272
+ * @public
273
273
  */
274
274
  suiteDefinitionVersion?: string;
275
275
  /**
276
- * @public
277
276
  * <p>Latest suite definition version of the suite definition.</p>
277
+ * @public
278
278
  */
279
279
  latestVersion?: string;
280
280
  /**
281
- * @public
282
281
  * <p>Suite configuration of the suite definition.</p>
282
+ * @public
283
283
  */
284
284
  suiteDefinitionConfiguration?: SuiteDefinitionConfiguration;
285
285
  /**
286
- * @public
287
286
  * <p>Date (in Unix epoch time) when the suite definition was created.</p>
287
+ * @public
288
288
  */
289
289
  createdAt?: Date;
290
290
  /**
291
- * @public
292
291
  * <p>Date (in Unix epoch time) when the suite definition was last modified.</p>
292
+ * @public
293
293
  */
294
294
  lastModifiedAt?: Date;
295
295
  /**
296
- * @public
297
296
  * <p>Tags attached to the suite definition.</p>
297
+ * @public
298
298
  */
299
299
  tags?: Record<string, string>;
300
300
  }
@@ -303,13 +303,13 @@ export interface GetSuiteDefinitionResponse {
303
303
  */
304
304
  export interface GetSuiteRunRequest {
305
305
  /**
306
- * @public
307
306
  * <p>Suite definition ID for the test suite run.</p>
307
+ * @public
308
308
  */
309
309
  suiteDefinitionId: string | undefined;
310
310
  /**
311
- * @public
312
311
  * <p>Suite run ID for the test suite run.</p>
312
+ * @public
313
313
  */
314
314
  suiteRunId: string | undefined;
315
315
  }
@@ -333,24 +333,24 @@ export declare const SuiteRunStatus: {
333
333
  */
334
334
  export type SuiteRunStatus = (typeof SuiteRunStatus)[keyof typeof SuiteRunStatus];
335
335
  /**
336
- * @public
337
336
  * <p>Gets suite run configuration.</p>
337
+ * @public
338
338
  */
339
339
  export interface SuiteRunConfiguration {
340
340
  /**
341
- * @public
342
341
  * <p>Sets the primary device for the test suite run. This requires a thing ARN or a
343
342
  * certificate ARN.</p>
343
+ * @public
344
344
  */
345
345
  primaryDevice: DeviceUnderTest | undefined;
346
346
  /**
347
- * @public
348
347
  * <p>Sets test case list.</p>
348
+ * @public
349
349
  */
350
350
  selectedTestList?: string[];
351
351
  /**
352
- * @public
353
352
  * <p>TRUE if multiple test suites run in parallel.</p>
353
+ * @public
354
354
  */
355
355
  parallelRun?: boolean;
356
356
  }
@@ -405,17 +405,16 @@ export declare const TestCaseScenarioType: {
405
405
  */
406
406
  export type TestCaseScenarioType = (typeof TestCaseScenarioType)[keyof typeof TestCaseScenarioType];
407
407
  /**
408
- * @public
409
408
  * <p>Provides test case scenario.</p>
409
+ * @public
410
410
  */
411
411
  export interface TestCaseScenario {
412
412
  /**
413
- * @public
414
413
  * <p>Provides test case scenario ID.</p>
414
+ * @public
415
415
  */
416
416
  testCaseScenarioId?: string;
417
417
  /**
418
- * @public
419
418
  * <p>Provides test case scenario type. Type is one of the following:</p>
420
419
  * <ul>
421
420
  * <li>
@@ -425,10 +424,10 @@ export interface TestCaseScenario {
425
424
  * <p>Basic</p>
426
425
  * </li>
427
426
  * </ul>
427
+ * @public
428
428
  */
429
429
  testCaseScenarioType?: TestCaseScenarioType;
430
430
  /**
431
- * @public
432
431
  * <p>Provides the test case scenario status. Status is one of the following:</p>
433
432
  * <ul>
434
433
  * <li>
@@ -467,41 +466,41 @@ export interface TestCaseScenario {
467
466
  * issue.</p>
468
467
  * </li>
469
468
  * </ul>
469
+ * @public
470
470
  */
471
471
  status?: TestCaseScenarioStatus;
472
472
  /**
473
- * @public
474
473
  * <p>Provides test case scenario failure result.</p>
474
+ * @public
475
475
  */
476
476
  failure?: string;
477
477
  /**
478
- * @public
479
478
  * <p>Provides test case scenario system messages if any.</p>
479
+ * @public
480
480
  */
481
481
  systemMessage?: string;
482
482
  }
483
483
  /**
484
- * @public
485
484
  * <p>Provides the test case run.</p>
485
+ * @public
486
486
  */
487
487
  export interface TestCaseRun {
488
488
  /**
489
- * @public
490
489
  * <p>Provides the test case run ID.</p>
490
+ * @public
491
491
  */
492
492
  testCaseRunId?: string;
493
493
  /**
494
- * @public
495
494
  * <p>Provides the test case run definition ID.</p>
495
+ * @public
496
496
  */
497
497
  testCaseDefinitionId?: string;
498
498
  /**
499
- * @public
500
499
  * <p>Provides the test case run definition name.</p>
500
+ * @public
501
501
  */
502
502
  testCaseDefinitionName?: string;
503
503
  /**
504
- * @public
505
504
  * <p>Provides the test case run status. Status is one of the following:</p>
506
505
  * <ul>
507
506
  * <li>
@@ -540,68 +539,69 @@ export interface TestCaseRun {
540
539
  * issue.</p>
541
540
  * </li>
542
541
  * </ul>
542
+ * @public
543
543
  */
544
544
  status?: Status;
545
545
  /**
546
- * @public
547
546
  * <p>Provides test case run start time.</p>
547
+ * @public
548
548
  */
549
549
  startTime?: Date;
550
550
  /**
551
- * @public
552
551
  * <p>Provides test case run end time.</p>
552
+ * @public
553
553
  */
554
554
  endTime?: Date;
555
555
  /**
556
- * @public
557
556
  * <p>Provides test case run log URL.</p>
557
+ * @public
558
558
  */
559
559
  logUrl?: string;
560
560
  /**
561
- * @public
562
561
  * <p>Provides test case run warnings.</p>
562
+ * @public
563
563
  */
564
564
  warnings?: string;
565
565
  /**
566
- * @public
567
566
  * <p>Provides test case run failure result.</p>
567
+ * @public
568
568
  */
569
569
  failure?: string;
570
570
  /**
571
- * @public
572
571
  * <p> Provides the test scenarios for the test case run. </p>
572
+ * @public
573
573
  */
574
574
  testScenarios?: TestCaseScenario[];
575
575
  }
576
576
  /**
577
- * @public
578
577
  * <p>Show Group Result.</p>
578
+ * @public
579
579
  */
580
580
  export interface GroupResult {
581
581
  /**
582
- * @public
583
582
  * <p>Group result ID.</p>
583
+ * @public
584
584
  */
585
585
  groupId?: string;
586
586
  /**
587
- * @public
588
587
  * <p>Group Result Name.</p>
588
+ * @public
589
589
  */
590
590
  groupName?: string;
591
591
  /**
592
- * @public
593
592
  * <p>Tests under Group Result.</p>
593
+ * @public
594
594
  */
595
595
  tests?: TestCaseRun[];
596
596
  }
597
597
  /**
598
- * @public
599
598
  * <p>Show each group result.</p>
599
+ * @public
600
600
  */
601
601
  export interface TestResult {
602
602
  /**
603
- * @public
604
603
  * <p>Show each group of test results.</p>
604
+ * @public
605
605
  */
606
606
  groups?: GroupResult[];
607
607
  }
@@ -610,58 +610,58 @@ export interface TestResult {
610
610
  */
611
611
  export interface GetSuiteRunResponse {
612
612
  /**
613
- * @public
614
613
  * <p>Suite definition ID for the test suite run.</p>
614
+ * @public
615
615
  */
616
616
  suiteDefinitionId?: string;
617
617
  /**
618
- * @public
619
618
  * <p>Suite definition version for the test suite run.</p>
619
+ * @public
620
620
  */
621
621
  suiteDefinitionVersion?: string;
622
622
  /**
623
- * @public
624
623
  * <p>Suite run ID for the test suite run.</p>
624
+ * @public
625
625
  */
626
626
  suiteRunId?: string;
627
627
  /**
628
- * @public
629
628
  * <p>The ARN of the suite run.</p>
629
+ * @public
630
630
  */
631
631
  suiteRunArn?: string;
632
632
  /**
633
- * @public
634
633
  * <p>Suite run configuration for the test suite run.</p>
634
+ * @public
635
635
  */
636
636
  suiteRunConfiguration?: SuiteRunConfiguration;
637
637
  /**
638
- * @public
639
638
  * <p>Test results for the test suite run.</p>
639
+ * @public
640
640
  */
641
641
  testResult?: TestResult;
642
642
  /**
643
- * @public
644
643
  * <p>Date (in Unix epoch time) when the test suite run started.</p>
644
+ * @public
645
645
  */
646
646
  startTime?: Date;
647
647
  /**
648
- * @public
649
648
  * <p>Date (in Unix epoch time) when the test suite run ended.</p>
649
+ * @public
650
650
  */
651
651
  endTime?: Date;
652
652
  /**
653
- * @public
654
653
  * <p>Status for the test suite run.</p>
654
+ * @public
655
655
  */
656
656
  status?: SuiteRunStatus;
657
657
  /**
658
- * @public
659
658
  * <p>Error reason for any test suite run failure.</p>
659
+ * @public
660
660
  */
661
661
  errorReason?: string;
662
662
  /**
663
- * @public
664
663
  * <p>The tags attached to the suite run.</p>
664
+ * @public
665
665
  */
666
666
  tags?: Record<string, string>;
667
667
  }
@@ -670,13 +670,13 @@ export interface GetSuiteRunResponse {
670
670
  */
671
671
  export interface GetSuiteRunReportRequest {
672
672
  /**
673
- * @public
674
673
  * <p>Suite definition ID of the test suite.</p>
674
+ * @public
675
675
  */
676
676
  suiteDefinitionId: string | undefined;
677
677
  /**
678
- * @public
679
678
  * <p>Suite run ID of the test suite run.</p>
679
+ * @public
680
680
  */
681
681
  suiteRunId: string | undefined;
682
682
  }
@@ -685,8 +685,8 @@ export interface GetSuiteRunReportRequest {
685
685
  */
686
686
  export interface GetSuiteRunReportResponse {
687
687
  /**
688
- * @public
689
688
  * <p>Download URL of the qualification report.</p>
689
+ * @public
690
690
  */
691
691
  qualificationReportDownloadUrl?: string;
692
692
  }
@@ -695,54 +695,54 @@ export interface GetSuiteRunReportResponse {
695
695
  */
696
696
  export interface ListSuiteDefinitionsRequest {
697
697
  /**
698
- * @public
699
698
  * <p>The maximum number of results to return at once.</p>
699
+ * @public
700
700
  */
701
701
  maxResults?: number;
702
702
  /**
703
- * @public
704
703
  * <p>A token used to get the next set of results.</p>
704
+ * @public
705
705
  */
706
706
  nextToken?: string;
707
707
  }
708
708
  /**
709
- * @public
710
709
  * <p>Information about the suite definition.</p>
710
+ * @public
711
711
  */
712
712
  export interface SuiteDefinitionInformation {
713
713
  /**
714
- * @public
715
714
  * <p>Suite definition ID of the test suite.</p>
715
+ * @public
716
716
  */
717
717
  suiteDefinitionId?: string;
718
718
  /**
719
- * @public
720
719
  * <p>Suite name of the test suite.</p>
720
+ * @public
721
721
  */
722
722
  suiteDefinitionName?: string;
723
723
  /**
724
- * @public
725
724
  * <p>Specifies the devices that are under test for the test suite.</p>
725
+ * @public
726
726
  */
727
727
  defaultDevices?: DeviceUnderTest[];
728
728
  /**
729
- * @public
730
729
  * <p>Specifies if the test suite is intended for qualification.</p>
730
+ * @public
731
731
  */
732
732
  intendedForQualification?: boolean;
733
733
  /**
734
- * @public
735
734
  * <p>Verifies if the test suite is a long duration test.</p>
735
+ * @public
736
736
  */
737
737
  isLongDurationTest?: boolean;
738
738
  /**
739
- * @public
740
739
  * <p>Gets the MQTT protocol that is configured in the suite definition.</p>
740
+ * @public
741
741
  */
742
742
  protocol?: Protocol;
743
743
  /**
744
- * @public
745
744
  * <p>Date (in Unix epoch time) when the test suite was created.</p>
745
+ * @public
746
746
  */
747
747
  createdAt?: Date;
748
748
  }
@@ -751,14 +751,14 @@ export interface SuiteDefinitionInformation {
751
751
  */
752
752
  export interface ListSuiteDefinitionsResponse {
753
753
  /**
754
- * @public
755
754
  * <p>An array of objects that provide summaries of information about the suite definitions
756
755
  * in the list.</p>
756
+ * @public
757
757
  */
758
758
  suiteDefinitionInformationList?: SuiteDefinitionInformation[];
759
759
  /**
760
- * @public
761
760
  * <p>A token used to get the next set of results.</p>
761
+ * @public
762
762
  */
763
763
  nextToken?: string;
764
764
  }
@@ -767,82 +767,82 @@ export interface ListSuiteDefinitionsResponse {
767
767
  */
768
768
  export interface ListSuiteRunsRequest {
769
769
  /**
770
- * @public
771
770
  * <p>Lists the test suite runs of the specified test suite based on suite definition
772
771
  * ID.</p>
772
+ * @public
773
773
  */
774
774
  suiteDefinitionId?: string;
775
775
  /**
776
- * @public
777
776
  * <p>Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of
778
777
  * the specified test suite based on suite definition version.</p>
778
+ * @public
779
779
  */
780
780
  suiteDefinitionVersion?: string;
781
781
  /**
782
- * @public
783
782
  * <p>The maximum number of results to return at once.</p>
783
+ * @public
784
784
  */
785
785
  maxResults?: number;
786
786
  /**
787
- * @public
788
787
  * <p>A token to retrieve the next set of results.</p>
788
+ * @public
789
789
  */
790
790
  nextToken?: string;
791
791
  }
792
792
  /**
793
- * @public
794
793
  * <p>Information about the suite run.</p>
795
794
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">SuiteRunInformation</a> action.</p>
795
+ * @public
796
796
  */
797
797
  export interface SuiteRunInformation {
798
798
  /**
799
- * @public
800
799
  * <p>Suite definition ID of the suite run.</p>
800
+ * @public
801
801
  */
802
802
  suiteDefinitionId?: string;
803
803
  /**
804
- * @public
805
804
  * <p>Suite definition version of the suite run.</p>
805
+ * @public
806
806
  */
807
807
  suiteDefinitionVersion?: string;
808
808
  /**
809
- * @public
810
809
  * <p>Suite definition name of the suite run.</p>
810
+ * @public
811
811
  */
812
812
  suiteDefinitionName?: string;
813
813
  /**
814
- * @public
815
814
  * <p>Suite run ID of the suite run.</p>
815
+ * @public
816
816
  */
817
817
  suiteRunId?: string;
818
818
  /**
819
- * @public
820
819
  * <p>Date (in Unix epoch time) when the suite run was created.</p>
820
+ * @public
821
821
  */
822
822
  createdAt?: Date;
823
823
  /**
824
- * @public
825
824
  * <p>Date (in Unix epoch time) when the suite run was started.</p>
825
+ * @public
826
826
  */
827
827
  startedAt?: Date;
828
828
  /**
829
- * @public
830
829
  * <p>Date (in Unix epoch time) when the suite run ended.</p>
830
+ * @public
831
831
  */
832
832
  endAt?: Date;
833
833
  /**
834
- * @public
835
834
  * <p>Status of the suite run.</p>
835
+ * @public
836
836
  */
837
837
  status?: SuiteRunStatus;
838
838
  /**
839
- * @public
840
839
  * <p>Number of test cases that passed in the suite run.</p>
840
+ * @public
841
841
  */
842
842
  passed?: number;
843
843
  /**
844
- * @public
845
844
  * <p>Number of test cases that failed in the suite run.</p>
845
+ * @public
846
846
  */
847
847
  failed?: number;
848
848
  }
@@ -851,14 +851,14 @@ export interface SuiteRunInformation {
851
851
  */
852
852
  export interface ListSuiteRunsResponse {
853
853
  /**
854
- * @public
855
854
  * <p>An array of objects that provide summaries of information about the suite runs in the
856
855
  * list.</p>
856
+ * @public
857
857
  */
858
858
  suiteRunsList?: SuiteRunInformation[];
859
859
  /**
860
- * @public
861
860
  * <p>A token to retrieve the next set of results.</p>
861
+ * @public
862
862
  */
863
863
  nextToken?: string;
864
864
  }
@@ -867,9 +867,9 @@ export interface ListSuiteRunsResponse {
867
867
  */
868
868
  export interface ListTagsForResourceRequest {
869
869
  /**
870
- * @public
871
870
  * <p>The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or
872
871
  * SuiteRun ARN.</p>
872
+ * @public
873
873
  */
874
874
  resourceArn: string | undefined;
875
875
  }
@@ -878,8 +878,8 @@ export interface ListTagsForResourceRequest {
878
878
  */
879
879
  export interface ListTagsForResourceResponse {
880
880
  /**
881
- * @public
882
881
  * <p>The tags attached to the IoT Device Advisor resource.</p>
882
+ * @public
883
883
  */
884
884
  tags?: Record<string, string>;
885
885
  }
@@ -888,23 +888,23 @@ export interface ListTagsForResourceResponse {
888
888
  */
889
889
  export interface StartSuiteRunRequest {
890
890
  /**
891
- * @public
892
891
  * <p>Suite definition ID of the test suite.</p>
892
+ * @public
893
893
  */
894
894
  suiteDefinitionId: string | undefined;
895
895
  /**
896
- * @public
897
896
  * <p>Suite definition version of the test suite.</p>
897
+ * @public
898
898
  */
899
899
  suiteDefinitionVersion?: string;
900
900
  /**
901
- * @public
902
901
  * <p>Suite run configuration.</p>
902
+ * @public
903
903
  */
904
904
  suiteRunConfiguration: SuiteRunConfiguration | undefined;
905
905
  /**
906
- * @public
907
906
  * <p>The tags to be attached to the suite run.</p>
907
+ * @public
908
908
  */
909
909
  tags?: Record<string, string>;
910
910
  }
@@ -913,23 +913,23 @@ export interface StartSuiteRunRequest {
913
913
  */
914
914
  export interface StartSuiteRunResponse {
915
915
  /**
916
- * @public
917
916
  * <p>Suite Run ID of the started suite run.</p>
917
+ * @public
918
918
  */
919
919
  suiteRunId?: string;
920
920
  /**
921
- * @public
922
921
  * <p>Amazon Resource Name (ARN) of the started suite run.</p>
922
+ * @public
923
923
  */
924
924
  suiteRunArn?: string;
925
925
  /**
926
- * @public
927
926
  * <p>Starts a Device Advisor test suite run based on suite create time.</p>
927
+ * @public
928
928
  */
929
929
  createdAt?: Date;
930
930
  /**
931
- * @public
932
931
  * <p>The response of an Device Advisor test endpoint.</p>
932
+ * @public
933
933
  */
934
934
  endpoint?: string;
935
935
  }
@@ -938,13 +938,13 @@ export interface StartSuiteRunResponse {
938
938
  */
939
939
  export interface StopSuiteRunRequest {
940
940
  /**
941
- * @public
942
941
  * <p>Suite definition ID of the test suite run to be stopped.</p>
942
+ * @public
943
943
  */
944
944
  suiteDefinitionId: string | undefined;
945
945
  /**
946
- * @public
947
946
  * <p>Suite run ID of the test suite run to be stopped.</p>
947
+ * @public
948
948
  */
949
949
  suiteRunId: string | undefined;
950
950
  }
@@ -958,14 +958,14 @@ export interface StopSuiteRunResponse {
958
958
  */
959
959
  export interface TagResourceRequest {
960
960
  /**
961
- * @public
962
961
  * <p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or
963
962
  * SuiteRun ARN.</p>
963
+ * @public
964
964
  */
965
965
  resourceArn: string | undefined;
966
966
  /**
967
- * @public
968
967
  * <p>The tags to be attached to the IoT Device Advisor resource.</p>
968
+ * @public
969
969
  */
970
970
  tags: Record<string, string> | undefined;
971
971
  }
@@ -979,14 +979,14 @@ export interface TagResourceResponse {
979
979
  */
980
980
  export interface UntagResourceRequest {
981
981
  /**
982
- * @public
983
982
  * <p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or
984
983
  * SuiteRun ARN.</p>
984
+ * @public
985
985
  */
986
986
  resourceArn: string | undefined;
987
987
  /**
988
- * @public
989
988
  * <p>List of tag keys to remove from the IoT Device Advisor resource.</p>
989
+ * @public
990
990
  */
991
991
  tagKeys: string[] | undefined;
992
992
  }
@@ -1000,13 +1000,13 @@ export interface UntagResourceResponse {
1000
1000
  */
1001
1001
  export interface UpdateSuiteDefinitionRequest {
1002
1002
  /**
1003
- * @public
1004
1003
  * <p>Suite definition ID of the test suite to be updated.</p>
1004
+ * @public
1005
1005
  */
1006
1006
  suiteDefinitionId: string | undefined;
1007
1007
  /**
1008
- * @public
1009
1008
  * <p>Updates a Device Advisor test suite with suite definition configuration.</p>
1009
+ * @public
1010
1010
  */
1011
1011
  suiteDefinitionConfiguration: SuiteDefinitionConfiguration | undefined;
1012
1012
  }
@@ -1015,33 +1015,33 @@ export interface UpdateSuiteDefinitionRequest {
1015
1015
  */
1016
1016
  export interface UpdateSuiteDefinitionResponse {
1017
1017
  /**
1018
- * @public
1019
1018
  * <p>Suite definition ID of the updated test suite.</p>
1019
+ * @public
1020
1020
  */
1021
1021
  suiteDefinitionId?: string;
1022
1022
  /**
1023
- * @public
1024
1023
  * <p>Amazon Resource Name (ARN) of the updated test suite.</p>
1024
+ * @public
1025
1025
  */
1026
1026
  suiteDefinitionArn?: string;
1027
1027
  /**
1028
- * @public
1029
1028
  * <p>Updates the suite definition name. This is a required parameter.</p>
1029
+ * @public
1030
1030
  */
1031
1031
  suiteDefinitionName?: string;
1032
1032
  /**
1033
- * @public
1034
1033
  * <p>Suite definition version of the updated test suite.</p>
1034
+ * @public
1035
1035
  */
1036
1036
  suiteDefinitionVersion?: string;
1037
1037
  /**
1038
- * @public
1039
1038
  * <p>Timestamp of when the test suite was created.</p>
1039
+ * @public
1040
1040
  */
1041
1041
  createdAt?: Date;
1042
1042
  /**
1043
- * @public
1044
1043
  * <p>Timestamp of when the test suite was updated.</p>
1044
+ * @public
1045
1045
  */
1046
1046
  lastUpdatedAt?: Date;
1047
1047
  }