@aws-sdk/client-iotdeviceadvisor 3.295.0 → 3.297.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.
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IotDeviceAdvisorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IotDeviceAdvisorClient";
5
5
  import { StartSuiteRunRequest, StartSuiteRunResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartSuiteRunCommand}.
8
10
  */
9
11
  export interface StartSuiteRunCommandInput extends StartSuiteRunRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartSuiteRunCommand}.
13
17
  */
14
18
  export interface StartSuiteRunCommandOutput extends StartSuiteRunResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a Device Advisor test suite run.</p>
18
23
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartSuiteRun</a> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StartSuiteRunCommandOutput extends StartSuiteRunResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StartSuiteRunCommandInput - {@link StartSuiteRunCommandInput}
35
+ * @returns {@link StartSuiteRunCommandOutput}
29
36
  * @see {@link StartSuiteRunCommandInput} for command's `input` shape.
30
37
  * @see {@link StartSuiteRunCommandOutput} for command's `response` shape.
31
38
  * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for IotDeviceAdvisorClient's `config` shape.
@@ -44,11 +51,20 @@ export interface StartSuiteRunCommandOutput extends StartSuiteRunResponse, __Met
44
51
  export declare class StartSuiteRunCommand extends $Command<StartSuiteRunCommandInput, StartSuiteRunCommandOutput, IotDeviceAdvisorClientResolvedConfig> {
45
52
  readonly input: StartSuiteRunCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: StartSuiteRunCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IotDeviceAdvisorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSuiteRunCommandInput, StartSuiteRunCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IotDeviceAdvisorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IotDeviceAdvisorClient";
5
5
  import { StopSuiteRunRequest, StopSuiteRunResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StopSuiteRunCommand}.
8
10
  */
9
11
  export interface StopSuiteRunCommandInput extends StopSuiteRunRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StopSuiteRunCommand}.
13
17
  */
14
18
  export interface StopSuiteRunCommandOutput extends StopSuiteRunResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Stops a Device Advisor test suite run that is currently running.</p>
18
23
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StopSuiteRun</a> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StopSuiteRunCommandOutput extends StopSuiteRunResponse, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StopSuiteRunCommandInput - {@link StopSuiteRunCommandInput}
35
+ * @returns {@link StopSuiteRunCommandOutput}
29
36
  * @see {@link StopSuiteRunCommandInput} for command's `input` shape.
30
37
  * @see {@link StopSuiteRunCommandOutput} for command's `response` shape.
31
38
  * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for IotDeviceAdvisorClient's `config` shape.
@@ -44,11 +51,20 @@ export interface StopSuiteRunCommandOutput extends StopSuiteRunResponse, __Metad
44
51
  export declare class StopSuiteRunCommand extends $Command<StopSuiteRunCommandInput, StopSuiteRunCommandOutput, IotDeviceAdvisorClientResolvedConfig> {
45
52
  readonly input: StopSuiteRunCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: StopSuiteRunCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IotDeviceAdvisorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopSuiteRunCommandInput, StopSuiteRunCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IotDeviceAdvisorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IotDeviceAdvisorClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds to and modifies existing tags of an IoT Device Advisor resource.</p>
18
23
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TagResource</a> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
35
+ * @returns {@link TagResourceCommandOutput}
29
36
  * @see {@link TagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for IotDeviceAdvisorClient's `config` shape.
@@ -44,11 +51,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
44
51
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IotDeviceAdvisorClientResolvedConfig> {
45
52
  readonly input: TagResourceCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: TagResourceCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IotDeviceAdvisorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IotDeviceAdvisorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IotDeviceAdvisorClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes tags from an IoT Device Advisor resource.</p>
18
23
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UntagResource</a> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
35
+ * @returns {@link UntagResourceCommandOutput}
29
36
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
30
37
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
31
38
  * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for IotDeviceAdvisorClient's `config` shape.
@@ -44,11 +51,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
44
51
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IotDeviceAdvisorClientResolvedConfig> {
45
52
  readonly input: UntagResourceCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: UntagResourceCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IotDeviceAdvisorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IotDeviceAdvisorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IotDeviceAdvisorClient";
5
5
  import { UpdateSuiteDefinitionRequest, UpdateSuiteDefinitionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateSuiteDefinitionCommand}.
8
10
  */
9
11
  export interface UpdateSuiteDefinitionCommandInput extends UpdateSuiteDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateSuiteDefinitionCommand}.
13
17
  */
14
18
  export interface UpdateSuiteDefinitionCommandOutput extends UpdateSuiteDefinitionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates a Device Advisor test suite.</p>
18
23
  * <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateSuiteDefinition</a> action.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface UpdateSuiteDefinitionCommandOutput extends UpdateSuiteDefinitio
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param UpdateSuiteDefinitionCommandInput - {@link UpdateSuiteDefinitionCommandInput}
35
+ * @returns {@link UpdateSuiteDefinitionCommandOutput}
29
36
  * @see {@link UpdateSuiteDefinitionCommandInput} for command's `input` shape.
30
37
  * @see {@link UpdateSuiteDefinitionCommandOutput} for command's `response` shape.
31
38
  * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for IotDeviceAdvisorClient's `config` shape.
@@ -41,11 +48,20 @@ export interface UpdateSuiteDefinitionCommandOutput extends UpdateSuiteDefinitio
41
48
  export declare class UpdateSuiteDefinitionCommand extends $Command<UpdateSuiteDefinitionCommandInput, UpdateSuiteDefinitionCommandOutput, IotDeviceAdvisorClientResolvedConfig> {
42
49
  readonly input: UpdateSuiteDefinitionCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: UpdateSuiteDefinitionCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IotDeviceAdvisorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSuiteDefinitionCommandInput, UpdateSuiteDefinitionCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from IotDeviceAdvisor service.
4
6
  */
5
7
  export declare class IotDeviceAdvisorServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { IotDeviceAdvisorServiceException as __BaseException } from "./IotDeviceAdvisorServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Sends a Conflict Exception.</p>
5
6
  */
6
7
  export declare class ConflictException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class ConflictException extends __BaseException {
12
13
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
13
14
  }
14
15
  /**
16
+ * @public
15
17
  * <p>Information of a test device. A thing ARN or a certificate ARN is required.</p>
16
18
  */
17
19
  export interface DeviceUnderTest {
@@ -24,11 +26,15 @@ export interface DeviceUnderTest {
24
26
  */
25
27
  certificateArn?: string;
26
28
  }
29
+ /**
30
+ * @public
31
+ */
27
32
  export declare enum Protocol {
28
33
  MqttV3_1_1 = "MqttV3_1_1",
29
34
  MqttV5 = "MqttV5"
30
35
  }
31
36
  /**
37
+ * @public
32
38
  * <p>Gets the suite definition configuration.</p>
33
39
  */
34
40
  export interface SuiteDefinitionConfiguration {
@@ -61,6 +67,9 @@ export interface SuiteDefinitionConfiguration {
61
67
  */
62
68
  protocol?: Protocol | string;
63
69
  }
70
+ /**
71
+ * @public
72
+ */
64
73
  export interface CreateSuiteDefinitionRequest {
65
74
  /**
66
75
  * <p>Creates a Device Advisor test suite with suite definition configuration.</p>
@@ -71,6 +80,9 @@ export interface CreateSuiteDefinitionRequest {
71
80
  */
72
81
  tags?: Record<string, string>;
73
82
  }
83
+ /**
84
+ * @public
85
+ */
74
86
  export interface CreateSuiteDefinitionResponse {
75
87
  /**
76
88
  * <p>The UUID of the test suite created.</p>
@@ -90,6 +102,7 @@ export interface CreateSuiteDefinitionResponse {
90
102
  createdAt?: Date;
91
103
  }
92
104
  /**
105
+ * @public
93
106
  * <p>Sends an Internal Failure exception.</p>
94
107
  */
95
108
  export declare class InternalServerException extends __BaseException {
@@ -101,6 +114,7 @@ export declare class InternalServerException extends __BaseException {
101
114
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
102
115
  }
103
116
  /**
117
+ * @public
104
118
  * <p>Sends a validation exception.</p>
105
119
  */
106
120
  export declare class ValidationException extends __BaseException {
@@ -111,14 +125,23 @@ export declare class ValidationException extends __BaseException {
111
125
  */
112
126
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
113
127
  }
128
+ /**
129
+ * @public
130
+ */
114
131
  export interface DeleteSuiteDefinitionRequest {
115
132
  /**
116
133
  * <p>Suite definition ID of the test suite to be deleted.</p>
117
134
  */
118
135
  suiteDefinitionId: string | undefined;
119
136
  }
137
+ /**
138
+ * @public
139
+ */
120
140
  export interface DeleteSuiteDefinitionResponse {
121
141
  }
142
+ /**
143
+ * @public
144
+ */
122
145
  export interface GetEndpointRequest {
123
146
  /**
124
147
  * <p>The thing ARN of the device. This is an optional parameter.</p>
@@ -129,6 +152,9 @@ export interface GetEndpointRequest {
129
152
  */
130
153
  certificateArn?: string;
131
154
  }
155
+ /**
156
+ * @public
157
+ */
132
158
  export interface GetEndpointResponse {
133
159
  /**
134
160
  * <p>The response of an Device Advisor endpoint.</p>
@@ -136,6 +162,7 @@ export interface GetEndpointResponse {
136
162
  endpoint?: string;
137
163
  }
138
164
  /**
165
+ * @public
139
166
  * <p>Sends a Resource Not Found exception.</p>
140
167
  */
141
168
  export declare class ResourceNotFoundException extends __BaseException {
@@ -146,6 +173,9 @@ export declare class ResourceNotFoundException extends __BaseException {
146
173
  */
147
174
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
148
175
  }
176
+ /**
177
+ * @public
178
+ */
149
179
  export interface GetSuiteDefinitionRequest {
150
180
  /**
151
181
  * <p>Suite definition ID of the test suite to get.</p>
@@ -156,6 +186,9 @@ export interface GetSuiteDefinitionRequest {
156
186
  */
157
187
  suiteDefinitionVersion?: string;
158
188
  }
189
+ /**
190
+ * @public
191
+ */
159
192
  export interface GetSuiteDefinitionResponse {
160
193
  /**
161
194
  * <p>Suite definition ID of the suite definition.</p>
@@ -190,6 +223,9 @@ export interface GetSuiteDefinitionResponse {
190
223
  */
191
224
  tags?: Record<string, string>;
192
225
  }
226
+ /**
227
+ * @public
228
+ */
193
229
  export interface GetSuiteRunRequest {
194
230
  /**
195
231
  * <p>Suite definition ID for the test suite run.</p>
@@ -200,6 +236,9 @@ export interface GetSuiteRunRequest {
200
236
  */
201
237
  suiteRunId: string | undefined;
202
238
  }
239
+ /**
240
+ * @public
241
+ */
203
242
  export declare enum SuiteRunStatus {
204
243
  CANCELED = "CANCELED",
205
244
  ERROR = "ERROR",
@@ -212,6 +251,7 @@ export declare enum SuiteRunStatus {
212
251
  STOPPING = "STOPPING"
213
252
  }
214
253
  /**
254
+ * @public
215
255
  * <p>Gets suite run configuration.</p>
216
256
  */
217
257
  export interface SuiteRunConfiguration {
@@ -229,6 +269,9 @@ export interface SuiteRunConfiguration {
229
269
  */
230
270
  parallelRun?: boolean;
231
271
  }
272
+ /**
273
+ * @public
274
+ */
232
275
  export declare enum Status {
233
276
  CANCELED = "CANCELED",
234
277
  ERROR = "ERROR",
@@ -240,6 +283,9 @@ export declare enum Status {
240
283
  STOPPED = "STOPPED",
241
284
  STOPPING = "STOPPING"
242
285
  }
286
+ /**
287
+ * @public
288
+ */
243
289
  export declare enum TestCaseScenarioStatus {
244
290
  CANCELED = "CANCELED",
245
291
  ERROR = "ERROR",
@@ -251,11 +297,15 @@ export declare enum TestCaseScenarioStatus {
251
297
  STOPPED = "STOPPED",
252
298
  STOPPING = "STOPPING"
253
299
  }
300
+ /**
301
+ * @public
302
+ */
254
303
  export declare enum TestCaseScenarioType {
255
304
  Advanced = "Advanced",
256
305
  Basic = "Basic"
257
306
  }
258
307
  /**
308
+ * @public
259
309
  * <p>Provides test case scenario.</p>
260
310
  */
261
311
  export interface TestCaseScenario {
@@ -327,6 +377,7 @@ export interface TestCaseScenario {
327
377
  systemMessage?: string;
328
378
  }
329
379
  /**
380
+ * @public
330
381
  * <p>Provides the test case run.</p>
331
382
  */
332
383
  export interface TestCaseRun {
@@ -409,6 +460,7 @@ export interface TestCaseRun {
409
460
  testScenarios?: TestCaseScenario[];
410
461
  }
411
462
  /**
463
+ * @public
412
464
  * <p>Show Group Result.</p>
413
465
  */
414
466
  export interface GroupResult {
@@ -426,6 +478,7 @@ export interface GroupResult {
426
478
  tests?: TestCaseRun[];
427
479
  }
428
480
  /**
481
+ * @public
429
482
  * <p>Show each group result.</p>
430
483
  */
431
484
  export interface TestResult {
@@ -434,6 +487,9 @@ export interface TestResult {
434
487
  */
435
488
  groups?: GroupResult[];
436
489
  }
490
+ /**
491
+ * @public
492
+ */
437
493
  export interface GetSuiteRunResponse {
438
494
  /**
439
495
  * <p>Suite definition ID for the test suite run.</p>
@@ -480,6 +536,9 @@ export interface GetSuiteRunResponse {
480
536
  */
481
537
  tags?: Record<string, string>;
482
538
  }
539
+ /**
540
+ * @public
541
+ */
483
542
  export interface GetSuiteRunReportRequest {
484
543
  /**
485
544
  * <p>Suite definition ID of the test suite.</p>
@@ -490,12 +549,18 @@ export interface GetSuiteRunReportRequest {
490
549
  */
491
550
  suiteRunId: string | undefined;
492
551
  }
552
+ /**
553
+ * @public
554
+ */
493
555
  export interface GetSuiteRunReportResponse {
494
556
  /**
495
557
  * <p>Download URL of the qualification report.</p>
496
558
  */
497
559
  qualificationReportDownloadUrl?: string;
498
560
  }
561
+ /**
562
+ * @public
563
+ */
499
564
  export interface ListSuiteDefinitionsRequest {
500
565
  /**
501
566
  * <p>The maximum number of results to return at once.</p>
@@ -507,6 +572,7 @@ export interface ListSuiteDefinitionsRequest {
507
572
  nextToken?: string;
508
573
  }
509
574
  /**
575
+ * @public
510
576
  * <p>Information about the suite definition.</p>
511
577
  */
512
578
  export interface SuiteDefinitionInformation {
@@ -539,6 +605,9 @@ export interface SuiteDefinitionInformation {
539
605
  */
540
606
  createdAt?: Date;
541
607
  }
608
+ /**
609
+ * @public
610
+ */
542
611
  export interface ListSuiteDefinitionsResponse {
543
612
  /**
544
613
  * <p>An array of objects that provide summaries of information about the suite definitions
@@ -550,6 +619,9 @@ export interface ListSuiteDefinitionsResponse {
550
619
  */
551
620
  nextToken?: string;
552
621
  }
622
+ /**
623
+ * @public
624
+ */
553
625
  export interface ListSuiteRunsRequest {
554
626
  /**
555
627
  * <p>Lists the test suite runs of the specified test suite based on suite definition
@@ -571,6 +643,7 @@ export interface ListSuiteRunsRequest {
571
643
  nextToken?: string;
572
644
  }
573
645
  /**
646
+ * @public
574
647
  * <p>Information about the suite run.</p>
575
648
  * <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>
576
649
  */
@@ -616,6 +689,9 @@ export interface SuiteRunInformation {
616
689
  */
617
690
  failed?: number;
618
691
  }
692
+ /**
693
+ * @public
694
+ */
619
695
  export interface ListSuiteRunsResponse {
620
696
  /**
621
697
  * <p>An array of objects that provide summaries of information about the suite runs in the
@@ -627,6 +703,9 @@ export interface ListSuiteRunsResponse {
627
703
  */
628
704
  nextToken?: string;
629
705
  }
706
+ /**
707
+ * @public
708
+ */
630
709
  export interface ListTagsForResourceRequest {
631
710
  /**
632
711
  * <p>The resource ARN of the IoT Device Advisor resource.
@@ -634,12 +713,18 @@ export interface ListTagsForResourceRequest {
634
713
  */
635
714
  resourceArn: string | undefined;
636
715
  }
716
+ /**
717
+ * @public
718
+ */
637
719
  export interface ListTagsForResourceResponse {
638
720
  /**
639
721
  * <p>The tags attached to the IoT Device Advisor resource.</p>
640
722
  */
641
723
  tags?: Record<string, string>;
642
724
  }
725
+ /**
726
+ * @public
727
+ */
643
728
  export interface StartSuiteRunRequest {
644
729
  /**
645
730
  * <p>Suite definition ID of the test suite.</p>
@@ -658,6 +743,9 @@ export interface StartSuiteRunRequest {
658
743
  */
659
744
  tags?: Record<string, string>;
660
745
  }
746
+ /**
747
+ * @public
748
+ */
661
749
  export interface StartSuiteRunResponse {
662
750
  /**
663
751
  * <p>Suite Run ID of the started suite run.</p>
@@ -676,6 +764,9 @@ export interface StartSuiteRunResponse {
676
764
  */
677
765
  endpoint?: string;
678
766
  }
767
+ /**
768
+ * @public
769
+ */
679
770
  export interface StopSuiteRunRequest {
680
771
  /**
681
772
  * <p>Suite definition ID of the test suite run to be stopped.</p>
@@ -686,8 +777,14 @@ export interface StopSuiteRunRequest {
686
777
  */
687
778
  suiteRunId: string | undefined;
688
779
  }
780
+ /**
781
+ * @public
782
+ */
689
783
  export interface StopSuiteRunResponse {
690
784
  }
785
+ /**
786
+ * @public
787
+ */
691
788
  export interface TagResourceRequest {
692
789
  /**
693
790
  * <p>The resource ARN of an IoT Device Advisor resource.
@@ -699,8 +796,14 @@ export interface TagResourceRequest {
699
796
  */
700
797
  tags: Record<string, string> | undefined;
701
798
  }
799
+ /**
800
+ * @public
801
+ */
702
802
  export interface TagResourceResponse {
703
803
  }
804
+ /**
805
+ * @public
806
+ */
704
807
  export interface UntagResourceRequest {
705
808
  /**
706
809
  * <p>The resource ARN of an IoT Device Advisor resource.
@@ -712,8 +815,14 @@ export interface UntagResourceRequest {
712
815
  */
713
816
  tagKeys: string[] | undefined;
714
817
  }
818
+ /**
819
+ * @public
820
+ */
715
821
  export interface UntagResourceResponse {
716
822
  }
823
+ /**
824
+ * @public
825
+ */
717
826
  export interface UpdateSuiteDefinitionRequest {
718
827
  /**
719
828
  * <p>Suite definition ID of the test suite to be updated.</p>
@@ -724,6 +833,9 @@ export interface UpdateSuiteDefinitionRequest {
724
833
  */
725
834
  suiteDefinitionConfiguration: SuiteDefinitionConfiguration | undefined;
726
835
  }
836
+ /**
837
+ * @public
838
+ */
727
839
  export interface UpdateSuiteDefinitionResponse {
728
840
  /**
729
841
  * <p>Suite definition ID of the updated test suite.</p>
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { IotDeviceAdvisorClient } from "../IotDeviceAdvisorClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface IotDeviceAdvisorPaginationConfiguration extends PaginationConfiguration {
4
7
  client: IotDeviceAdvisorClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListSuiteDefinitionsCommandInput, ListSuiteDefinitionsCommandOutput } from "../commands/ListSuiteDefinitionsCommand";
3
3
  import { IotDeviceAdvisorPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListSuiteDefinitions(config: IotDeviceAdvisorPaginationConfiguration, input: ListSuiteDefinitionsCommandInput, ...additionalArguments: any): Paginator<ListSuiteDefinitionsCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListSuiteRunsCommandInput, ListSuiteRunsCommandOutput } from "../commands/ListSuiteRunsCommand";
3
3
  import { IotDeviceAdvisorPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListSuiteRuns(config: IotDeviceAdvisorPaginationConfiguration, input: ListSuiteRunsCommandInput, ...additionalArguments: any): Paginator<ListSuiteRunsCommandOutput>;