aws-sdk-iotdeviceadvisor 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::IoTDeviceAdvisor
11
+
12
+ # When IoTDeviceAdvisor returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::IoTDeviceAdvisor::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all IoTDeviceAdvisor errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::IoTDeviceAdvisor::Errors::ServiceError
20
+ # # rescues all IoTDeviceAdvisor API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {ConflictException}
31
+ # * {InternalServerException}
32
+ # * {ResourceNotFoundException}
33
+ # * {ValidationException}
34
+ #
35
+ # Additionally, error classes are dynamically generated for service errors based on the error code
36
+ # if they are not defined above.
37
+ module Errors
38
+
39
+ extend Aws::Errors::DynamicErrors
40
+
41
+ class ConflictException < ServiceError
42
+
43
+ # @param [Seahorse::Client::RequestContext] context
44
+ # @param [String] message
45
+ # @param [Aws::IoTDeviceAdvisor::Types::ConflictException] data
46
+ def initialize(context, message, data = Aws::EmptyStructure.new)
47
+ super(context, message, data)
48
+ end
49
+
50
+ # @return [String]
51
+ def message
52
+ @message || @data[:message]
53
+ end
54
+ end
55
+
56
+ class InternalServerException < ServiceError
57
+
58
+ # @param [Seahorse::Client::RequestContext] context
59
+ # @param [String] message
60
+ # @param [Aws::IoTDeviceAdvisor::Types::InternalServerException] data
61
+ def initialize(context, message, data = Aws::EmptyStructure.new)
62
+ super(context, message, data)
63
+ end
64
+
65
+ # @return [String]
66
+ def message
67
+ @message || @data[:message]
68
+ end
69
+ end
70
+
71
+ class ResourceNotFoundException < ServiceError
72
+
73
+ # @param [Seahorse::Client::RequestContext] context
74
+ # @param [String] message
75
+ # @param [Aws::IoTDeviceAdvisor::Types::ResourceNotFoundException] data
76
+ def initialize(context, message, data = Aws::EmptyStructure.new)
77
+ super(context, message, data)
78
+ end
79
+
80
+ # @return [String]
81
+ def message
82
+ @message || @data[:message]
83
+ end
84
+ end
85
+
86
+ class ValidationException < ServiceError
87
+
88
+ # @param [Seahorse::Client::RequestContext] context
89
+ # @param [String] message
90
+ # @param [Aws::IoTDeviceAdvisor::Types::ValidationException] data
91
+ def initialize(context, message, data = Aws::EmptyStructure.new)
92
+ super(context, message, data)
93
+ end
94
+
95
+ # @return [String]
96
+ def message
97
+ @message || @data[:message]
98
+ end
99
+ end
100
+
101
+ end
102
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::IoTDeviceAdvisor
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,1045 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::IoTDeviceAdvisor
11
+ module Types
12
+
13
+ # Sends Conflict Exception.
14
+ #
15
+ # @!attribute [rw] message
16
+ # Sends Conflict Exception message.
17
+ # @return [String]
18
+ #
19
+ class ConflictException < Struct.new(
20
+ :message)
21
+ SENSITIVE = []
22
+ include Aws::Structure
23
+ end
24
+
25
+ # @note When making an API call, you may pass CreateSuiteDefinitionRequest
26
+ # data as a hash:
27
+ #
28
+ # {
29
+ # suite_definition_configuration: {
30
+ # suite_definition_name: "SuiteDefinitionName",
31
+ # devices: [
32
+ # {
33
+ # thing_arn: "AmazonResourceName",
34
+ # certificate_arn: "AmazonResourceName",
35
+ # },
36
+ # ],
37
+ # intended_for_qualification: false,
38
+ # root_group: "RootGroup",
39
+ # device_permission_role_arn: "AmazonResourceName",
40
+ # },
41
+ # tags: {
42
+ # "String128" => "String256",
43
+ # },
44
+ # }
45
+ #
46
+ # @!attribute [rw] suite_definition_configuration
47
+ # Creates a Device Advisor test suite with suite definition
48
+ # configuration.
49
+ # @return [Types::SuiteDefinitionConfiguration]
50
+ #
51
+ # @!attribute [rw] tags
52
+ # The tags to be attached to the suite definition.
53
+ # @return [Hash<String,String>]
54
+ #
55
+ class CreateSuiteDefinitionRequest < Struct.new(
56
+ :suite_definition_configuration,
57
+ :tags)
58
+ SENSITIVE = []
59
+ include Aws::Structure
60
+ end
61
+
62
+ # @!attribute [rw] suite_definition_id
63
+ # Creates a Device Advisor test suite with suite UUID.
64
+ # @return [String]
65
+ #
66
+ # @!attribute [rw] suite_definition_arn
67
+ # Creates a Device Advisor test suite with Amazon Resource name.
68
+ # @return [String]
69
+ #
70
+ # @!attribute [rw] suite_definition_name
71
+ # Creates a Device Advisor test suite with suite definition name.
72
+ # @return [String]
73
+ #
74
+ # @!attribute [rw] created_at
75
+ # Creates a Device Advisor test suite with TimeStamp of when it was
76
+ # created.
77
+ # @return [Time]
78
+ #
79
+ class CreateSuiteDefinitionResponse < Struct.new(
80
+ :suite_definition_id,
81
+ :suite_definition_arn,
82
+ :suite_definition_name,
83
+ :created_at)
84
+ SENSITIVE = []
85
+ include Aws::Structure
86
+ end
87
+
88
+ # @note When making an API call, you may pass DeleteSuiteDefinitionRequest
89
+ # data as a hash:
90
+ #
91
+ # {
92
+ # suite_definition_id: "UUID", # required
93
+ # }
94
+ #
95
+ # @!attribute [rw] suite_definition_id
96
+ # Deletes a Device Advisor test suite with defined suite Id.
97
+ # @return [String]
98
+ #
99
+ class DeleteSuiteDefinitionRequest < Struct.new(
100
+ :suite_definition_id)
101
+ SENSITIVE = []
102
+ include Aws::Structure
103
+ end
104
+
105
+ class DeleteSuiteDefinitionResponse < Aws::EmptyStructure; end
106
+
107
+ # Lists all the devices under test
108
+ #
109
+ # @note When making an API call, you may pass DeviceUnderTest
110
+ # data as a hash:
111
+ #
112
+ # {
113
+ # thing_arn: "AmazonResourceName",
114
+ # certificate_arn: "AmazonResourceName",
115
+ # }
116
+ #
117
+ # @!attribute [rw] thing_arn
118
+ # Lists devices thing arn
119
+ # @return [String]
120
+ #
121
+ # @!attribute [rw] certificate_arn
122
+ # Lists devices certificate arn
123
+ # @return [String]
124
+ #
125
+ class DeviceUnderTest < Struct.new(
126
+ :thing_arn,
127
+ :certificate_arn)
128
+ SENSITIVE = []
129
+ include Aws::Structure
130
+ end
131
+
132
+ # @note When making an API call, you may pass GetSuiteDefinitionRequest
133
+ # data as a hash:
134
+ #
135
+ # {
136
+ # suite_definition_id: "UUID", # required
137
+ # suite_definition_version: "SuiteDefinitionVersion",
138
+ # }
139
+ #
140
+ # @!attribute [rw] suite_definition_id
141
+ # Requests suite definition Id with GetSuiteDefinition API call.
142
+ # @return [String]
143
+ #
144
+ # @!attribute [rw] suite_definition_version
145
+ # Requests the suite definition version of a test suite.
146
+ # @return [String]
147
+ #
148
+ class GetSuiteDefinitionRequest < Struct.new(
149
+ :suite_definition_id,
150
+ :suite_definition_version)
151
+ SENSITIVE = []
152
+ include Aws::Structure
153
+ end
154
+
155
+ # @!attribute [rw] suite_definition_id
156
+ # Gets suite definition Id with GetSuiteDefinition API call.
157
+ # @return [String]
158
+ #
159
+ # @!attribute [rw] suite_definition_arn
160
+ # The ARN of the suite definition.
161
+ # @return [String]
162
+ #
163
+ # @!attribute [rw] suite_definition_version
164
+ # Gets suite definition version with GetSuiteDefinition API call.
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] latest_version
168
+ # Gets latest suite definition version with GetSuiteDefinition API
169
+ # call.
170
+ # @return [String]
171
+ #
172
+ # @!attribute [rw] suite_definition_configuration
173
+ # Gets the suite configuration with GetSuiteDefinition API call.
174
+ # @return [Types::SuiteDefinitionConfiguration]
175
+ #
176
+ # @!attribute [rw] created_at
177
+ # Gets the timestamp of the time suite was created with
178
+ # GetSuiteDefinition API call.
179
+ # @return [Time]
180
+ #
181
+ # @!attribute [rw] last_modified_at
182
+ # Gets the timestamp of the time suite was modified with
183
+ # GetSuiteDefinition API call.
184
+ # @return [Time]
185
+ #
186
+ # @!attribute [rw] tags
187
+ # Tags attached to the suite definition.
188
+ # @return [Hash<String,String>]
189
+ #
190
+ class GetSuiteDefinitionResponse < Struct.new(
191
+ :suite_definition_id,
192
+ :suite_definition_arn,
193
+ :suite_definition_version,
194
+ :latest_version,
195
+ :suite_definition_configuration,
196
+ :created_at,
197
+ :last_modified_at,
198
+ :tags)
199
+ SENSITIVE = []
200
+ include Aws::Structure
201
+ end
202
+
203
+ # @note When making an API call, you may pass GetSuiteRunReportRequest
204
+ # data as a hash:
205
+ #
206
+ # {
207
+ # suite_definition_id: "UUID", # required
208
+ # suite_run_id: "UUID", # required
209
+ # }
210
+ #
211
+ # @!attribute [rw] suite_definition_id
212
+ # Device Advisor suite definition Id.
213
+ # @return [String]
214
+ #
215
+ # @!attribute [rw] suite_run_id
216
+ # Device Advisor suite run Id.
217
+ # @return [String]
218
+ #
219
+ class GetSuiteRunReportRequest < Struct.new(
220
+ :suite_definition_id,
221
+ :suite_run_id)
222
+ SENSITIVE = []
223
+ include Aws::Structure
224
+ end
225
+
226
+ # @!attribute [rw] qualification_report_download_url
227
+ # Gets the download URL of the qualification report.
228
+ # @return [String]
229
+ #
230
+ class GetSuiteRunReportResponse < Struct.new(
231
+ :qualification_report_download_url)
232
+ SENSITIVE = []
233
+ include Aws::Structure
234
+ end
235
+
236
+ # @note When making an API call, you may pass GetSuiteRunRequest
237
+ # data as a hash:
238
+ #
239
+ # {
240
+ # suite_definition_id: "UUID", # required
241
+ # suite_run_id: "UUID", # required
242
+ # }
243
+ #
244
+ # @!attribute [rw] suite_definition_id
245
+ # Requests the information about Device Advisor test suite run based
246
+ # on suite definition Id.
247
+ # @return [String]
248
+ #
249
+ # @!attribute [rw] suite_run_id
250
+ # Requests the information about Device Advisor test suite run based
251
+ # on suite run Id.
252
+ # @return [String]
253
+ #
254
+ class GetSuiteRunRequest < Struct.new(
255
+ :suite_definition_id,
256
+ :suite_run_id)
257
+ SENSITIVE = []
258
+ include Aws::Structure
259
+ end
260
+
261
+ # @!attribute [rw] suite_definition_id
262
+ # Gets the information about Device Advisor test suite run based on
263
+ # suite definition Id.
264
+ # @return [String]
265
+ #
266
+ # @!attribute [rw] suite_definition_version
267
+ # Gets the information about Device Advisor test suite run based on
268
+ # suite definition version.
269
+ # @return [String]
270
+ #
271
+ # @!attribute [rw] suite_run_id
272
+ # Gets the information about Device Advisor test suite run based on
273
+ # suite run Id.
274
+ # @return [String]
275
+ #
276
+ # @!attribute [rw] suite_run_arn
277
+ # The ARN of the suite run.
278
+ # @return [String]
279
+ #
280
+ # @!attribute [rw] suite_run_configuration
281
+ # Gets the information about Device Advisor test suite run based on
282
+ # suite configuration.
283
+ # @return [Types::SuiteRunConfiguration]
284
+ #
285
+ # @!attribute [rw] test_result
286
+ # Gets the information about Device Advisor test suite run based on
287
+ # test case runs.
288
+ # @return [Types::TestResult]
289
+ #
290
+ # @!attribute [rw] start_time
291
+ # Gets the information about Device Advisor test suite run based on
292
+ # start time.
293
+ # @return [Time]
294
+ #
295
+ # @!attribute [rw] end_time
296
+ # Gets the information about Device Advisor test suite run based on
297
+ # end time.
298
+ # @return [Time]
299
+ #
300
+ # @!attribute [rw] status
301
+ # Gets the information about Device Advisor test suite run based on
302
+ # its status.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] error_reason
306
+ # Gets the information about Device Advisor test suite run based on
307
+ # error.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] tags
311
+ # The tags attached to the suite run.
312
+ # @return [Hash<String,String>]
313
+ #
314
+ class GetSuiteRunResponse < Struct.new(
315
+ :suite_definition_id,
316
+ :suite_definition_version,
317
+ :suite_run_id,
318
+ :suite_run_arn,
319
+ :suite_run_configuration,
320
+ :test_result,
321
+ :start_time,
322
+ :end_time,
323
+ :status,
324
+ :error_reason,
325
+ :tags)
326
+ SENSITIVE = []
327
+ include Aws::Structure
328
+ end
329
+
330
+ # Show Group Result.
331
+ #
332
+ # @!attribute [rw] group_id
333
+ # Show Group Result Id.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] group_name
337
+ # Show Group Result Name.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] tests
341
+ # Show Group Result.
342
+ # @return [Array<Types::TestCaseRun>]
343
+ #
344
+ class GroupResult < Struct.new(
345
+ :group_id,
346
+ :group_name,
347
+ :tests)
348
+ SENSITIVE = []
349
+ include Aws::Structure
350
+ end
351
+
352
+ # Sends Internal Failure Exception.
353
+ #
354
+ # @!attribute [rw] message
355
+ # Sends Internal Failure Exception message.
356
+ # @return [String]
357
+ #
358
+ class InternalServerException < Struct.new(
359
+ :message)
360
+ SENSITIVE = []
361
+ include Aws::Structure
362
+ end
363
+
364
+ # @note When making an API call, you may pass ListSuiteDefinitionsRequest
365
+ # data as a hash:
366
+ #
367
+ # {
368
+ # max_results: 1,
369
+ # next_token: "Token",
370
+ # }
371
+ #
372
+ # @!attribute [rw] max_results
373
+ # Request the list of all the Device Advisor test suites.
374
+ # @return [Integer]
375
+ #
376
+ # @!attribute [rw] next_token
377
+ # Requests the Device Advisor test suites next token.
378
+ # @return [String]
379
+ #
380
+ class ListSuiteDefinitionsRequest < Struct.new(
381
+ :max_results,
382
+ :next_token)
383
+ SENSITIVE = []
384
+ include Aws::Structure
385
+ end
386
+
387
+ # @!attribute [rw] suite_definition_information_list
388
+ # Lists test suite information using List suite definition.
389
+ # @return [Array<Types::SuiteDefinitionInformation>]
390
+ #
391
+ # @!attribute [rw] next_token
392
+ # Creates a Device Advisor test suite.
393
+ # @return [String]
394
+ #
395
+ class ListSuiteDefinitionsResponse < Struct.new(
396
+ :suite_definition_information_list,
397
+ :next_token)
398
+ SENSITIVE = []
399
+ include Aws::Structure
400
+ end
401
+
402
+ # @note When making an API call, you may pass ListSuiteRunsRequest
403
+ # data as a hash:
404
+ #
405
+ # {
406
+ # suite_definition_id: "UUID",
407
+ # suite_definition_version: "SuiteDefinitionVersion",
408
+ # max_results: 1,
409
+ # next_token: "Token",
410
+ # }
411
+ #
412
+ # @!attribute [rw] suite_definition_id
413
+ # Lists the runs of the specified Device Advisor test suite based on
414
+ # suite definition Id.
415
+ # @return [String]
416
+ #
417
+ # @!attribute [rw] suite_definition_version
418
+ # Lists the runs of the specified Device Advisor test suite based on
419
+ # suite definition version.
420
+ # @return [String]
421
+ #
422
+ # @!attribute [rw] max_results
423
+ # MaxResults for list suite run API request.
424
+ # @return [Integer]
425
+ #
426
+ # @!attribute [rw] next_token
427
+ # Next pagination token for list suite run request.
428
+ # @return [String]
429
+ #
430
+ class ListSuiteRunsRequest < Struct.new(
431
+ :suite_definition_id,
432
+ :suite_definition_version,
433
+ :max_results,
434
+ :next_token)
435
+ SENSITIVE = []
436
+ include Aws::Structure
437
+ end
438
+
439
+ # @!attribute [rw] suite_runs_list
440
+ # Lists the runs of the specified Device Advisor test suite.
441
+ # @return [Array<Types::SuiteRunInformation>]
442
+ #
443
+ # @!attribute [rw] next_token
444
+ # Next pagination token for list suite run response.
445
+ # @return [String]
446
+ #
447
+ class ListSuiteRunsResponse < Struct.new(
448
+ :suite_runs_list,
449
+ :next_token)
450
+ SENSITIVE = []
451
+ include Aws::Structure
452
+ end
453
+
454
+ # @note When making an API call, you may pass ListTagsForResourceRequest
455
+ # data as a hash:
456
+ #
457
+ # {
458
+ # resource_arn: "AmazonResourceName", # required
459
+ # }
460
+ #
461
+ # @!attribute [rw] resource_arn
462
+ # The ARN of the IoT Device Advisor resource.
463
+ # @return [String]
464
+ #
465
+ class ListTagsForResourceRequest < Struct.new(
466
+ :resource_arn)
467
+ SENSITIVE = []
468
+ include Aws::Structure
469
+ end
470
+
471
+ # @!attribute [rw] tags
472
+ # The tags attached to the IoT Device Advisor resource.
473
+ # @return [Hash<String,String>]
474
+ #
475
+ class ListTagsForResourceResponse < Struct.new(
476
+ :tags)
477
+ SENSITIVE = []
478
+ include Aws::Structure
479
+ end
480
+
481
+ # @note When making an API call, you may pass ListTestCasesRequest
482
+ # data as a hash:
483
+ #
484
+ # {
485
+ # intended_for_qualification: false,
486
+ # max_results: 1,
487
+ # next_token: "Token",
488
+ # }
489
+ #
490
+ # @!attribute [rw] intended_for_qualification
491
+ # Lists all the qualification test cases in the test suite.
492
+ # @return [Boolean]
493
+ #
494
+ # @!attribute [rw] max_results
495
+ # Requests the test cases max results.
496
+ # @return [Integer]
497
+ #
498
+ # @!attribute [rw] next_token
499
+ # Requests the test cases next token.
500
+ # @return [String]
501
+ #
502
+ class ListTestCasesRequest < Struct.new(
503
+ :intended_for_qualification,
504
+ :max_results,
505
+ :next_token)
506
+ SENSITIVE = []
507
+ include Aws::Structure
508
+ end
509
+
510
+ # @!attribute [rw] categories
511
+ # Gets the category of test case.
512
+ # @return [Array<Types::TestCaseCategory>]
513
+ #
514
+ # @!attribute [rw] root_group_configuration
515
+ # Gets the configuration of root test group.
516
+ # @return [Hash<String,String>]
517
+ #
518
+ # @!attribute [rw] group_configuration
519
+ # Gets the configuration of test group.
520
+ # @return [Hash<String,String>]
521
+ #
522
+ # @!attribute [rw] next_token
523
+ # Test cases next token response.
524
+ # @return [String]
525
+ #
526
+ class ListTestCasesResponse < Struct.new(
527
+ :categories,
528
+ :root_group_configuration,
529
+ :group_configuration,
530
+ :next_token)
531
+ SENSITIVE = []
532
+ include Aws::Structure
533
+ end
534
+
535
+ # Sends Resource Not Found Exception.
536
+ #
537
+ # @!attribute [rw] message
538
+ # Sends Resource Not Found Exception message.
539
+ # @return [String]
540
+ #
541
+ class ResourceNotFoundException < Struct.new(
542
+ :message)
543
+ SENSITIVE = []
544
+ include Aws::Structure
545
+ end
546
+
547
+ # @note When making an API call, you may pass StartSuiteRunRequest
548
+ # data as a hash:
549
+ #
550
+ # {
551
+ # suite_definition_id: "UUID", # required
552
+ # suite_definition_version: "SuiteDefinitionVersion",
553
+ # suite_run_configuration: {
554
+ # primary_device: {
555
+ # thing_arn: "AmazonResourceName",
556
+ # certificate_arn: "AmazonResourceName",
557
+ # },
558
+ # secondary_device: {
559
+ # thing_arn: "AmazonResourceName",
560
+ # certificate_arn: "AmazonResourceName",
561
+ # },
562
+ # selected_test_list: ["UUID"],
563
+ # },
564
+ # tags: {
565
+ # "String128" => "String256",
566
+ # },
567
+ # }
568
+ #
569
+ # @!attribute [rw] suite_definition_id
570
+ # Request to start suite run based on suite definition Id.
571
+ # @return [String]
572
+ #
573
+ # @!attribute [rw] suite_definition_version
574
+ # Request to start suite run based on suite definition version.
575
+ # @return [String]
576
+ #
577
+ # @!attribute [rw] suite_run_configuration
578
+ # Request to start suite run based on suite configuration.
579
+ # @return [Types::SuiteRunConfiguration]
580
+ #
581
+ # @!attribute [rw] tags
582
+ # The tags to be attached to the suite run.
583
+ # @return [Hash<String,String>]
584
+ #
585
+ class StartSuiteRunRequest < Struct.new(
586
+ :suite_definition_id,
587
+ :suite_definition_version,
588
+ :suite_run_configuration,
589
+ :tags)
590
+ SENSITIVE = []
591
+ include Aws::Structure
592
+ end
593
+
594
+ # @!attribute [rw] suite_run_id
595
+ # Starts a Device Advisor test suite run based on suite Run Id.
596
+ # @return [String]
597
+ #
598
+ # @!attribute [rw] suite_run_arn
599
+ # Starts a Device Advisor test suite run based on suite run arn.
600
+ # @return [String]
601
+ #
602
+ # @!attribute [rw] created_at
603
+ # Starts a Device Advisor test suite run based on suite create time.
604
+ # @return [Time]
605
+ #
606
+ class StartSuiteRunResponse < Struct.new(
607
+ :suite_run_id,
608
+ :suite_run_arn,
609
+ :created_at)
610
+ SENSITIVE = []
611
+ include Aws::Structure
612
+ end
613
+
614
+ # Gets Suite Definition Configuration.
615
+ #
616
+ # @note When making an API call, you may pass SuiteDefinitionConfiguration
617
+ # data as a hash:
618
+ #
619
+ # {
620
+ # suite_definition_name: "SuiteDefinitionName",
621
+ # devices: [
622
+ # {
623
+ # thing_arn: "AmazonResourceName",
624
+ # certificate_arn: "AmazonResourceName",
625
+ # },
626
+ # ],
627
+ # intended_for_qualification: false,
628
+ # root_group: "RootGroup",
629
+ # device_permission_role_arn: "AmazonResourceName",
630
+ # }
631
+ #
632
+ # @!attribute [rw] suite_definition_name
633
+ # Gets Suite Definition Configuration name.
634
+ # @return [String]
635
+ #
636
+ # @!attribute [rw] devices
637
+ # Gets the devices configured.
638
+ # @return [Array<Types::DeviceUnderTest>]
639
+ #
640
+ # @!attribute [rw] intended_for_qualification
641
+ # Gets the tests intended for qualification in a suite.
642
+ # @return [Boolean]
643
+ #
644
+ # @!attribute [rw] root_group
645
+ # Gets test suite root group.
646
+ # @return [String]
647
+ #
648
+ # @!attribute [rw] device_permission_role_arn
649
+ # Gets device permission arn.
650
+ # @return [String]
651
+ #
652
+ class SuiteDefinitionConfiguration < Struct.new(
653
+ :suite_definition_name,
654
+ :devices,
655
+ :intended_for_qualification,
656
+ :root_group,
657
+ :device_permission_role_arn)
658
+ SENSITIVE = []
659
+ include Aws::Structure
660
+ end
661
+
662
+ # Get suite definition information.
663
+ #
664
+ # @!attribute [rw] suite_definition_id
665
+ # Get suite definition Id.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] suite_definition_name
669
+ # Get test suite name.
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] default_devices
673
+ # Specifies the devices under test.
674
+ # @return [Array<Types::DeviceUnderTest>]
675
+ #
676
+ # @!attribute [rw] intended_for_qualification
677
+ # Gets the test suites which will be used for qualification.
678
+ # @return [Boolean]
679
+ #
680
+ # @!attribute [rw] created_at
681
+ # Gets the information of when the test suite was created.
682
+ # @return [Time]
683
+ #
684
+ class SuiteDefinitionInformation < Struct.new(
685
+ :suite_definition_id,
686
+ :suite_definition_name,
687
+ :default_devices,
688
+ :intended_for_qualification,
689
+ :created_at)
690
+ SENSITIVE = []
691
+ include Aws::Structure
692
+ end
693
+
694
+ # Gets suite run configuration.
695
+ #
696
+ # @note When making an API call, you may pass SuiteRunConfiguration
697
+ # data as a hash:
698
+ #
699
+ # {
700
+ # primary_device: {
701
+ # thing_arn: "AmazonResourceName",
702
+ # certificate_arn: "AmazonResourceName",
703
+ # },
704
+ # secondary_device: {
705
+ # thing_arn: "AmazonResourceName",
706
+ # certificate_arn: "AmazonResourceName",
707
+ # },
708
+ # selected_test_list: ["UUID"],
709
+ # }
710
+ #
711
+ # @!attribute [rw] primary_device
712
+ # Gets the primary device for suite run.
713
+ # @return [Types::DeviceUnderTest]
714
+ #
715
+ # @!attribute [rw] secondary_device
716
+ # Gets the secondary device for suite run.
717
+ # @return [Types::DeviceUnderTest]
718
+ #
719
+ # @!attribute [rw] selected_test_list
720
+ # Gets test case list.
721
+ # @return [Array<String>]
722
+ #
723
+ class SuiteRunConfiguration < Struct.new(
724
+ :primary_device,
725
+ :secondary_device,
726
+ :selected_test_list)
727
+ SENSITIVE = []
728
+ include Aws::Structure
729
+ end
730
+
731
+ # Get suite run information.
732
+ #
733
+ # @!attribute [rw] suite_definition_id
734
+ # Get suite run information based on suite definition Id.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] suite_definition_version
738
+ # Get suite run information based on suite definition version.
739
+ # @return [String]
740
+ #
741
+ # @!attribute [rw] suite_definition_name
742
+ # Get suite run information based on suite definition name.
743
+ # @return [String]
744
+ #
745
+ # @!attribute [rw] suite_run_id
746
+ # Get suite run information based on suite run Id.
747
+ # @return [String]
748
+ #
749
+ # @!attribute [rw] created_at
750
+ # Get suite run information based on time suite was created.
751
+ # @return [Time]
752
+ #
753
+ # @!attribute [rw] started_at
754
+ # Get suite run information based on start time of the run.
755
+ # @return [Time]
756
+ #
757
+ # @!attribute [rw] end_at
758
+ # Get suite run information based on end time of the run.
759
+ # @return [Time]
760
+ #
761
+ # @!attribute [rw] status
762
+ # Get suite run information based on test run status.
763
+ # @return [String]
764
+ #
765
+ # @!attribute [rw] passed
766
+ # Get suite run information based on result of the test suite run.
767
+ # @return [Integer]
768
+ #
769
+ # @!attribute [rw] failed
770
+ # Get suite run information based on result of the test suite run.
771
+ # @return [Integer]
772
+ #
773
+ class SuiteRunInformation < Struct.new(
774
+ :suite_definition_id,
775
+ :suite_definition_version,
776
+ :suite_definition_name,
777
+ :suite_run_id,
778
+ :created_at,
779
+ :started_at,
780
+ :end_at,
781
+ :status,
782
+ :passed,
783
+ :failed)
784
+ SENSITIVE = []
785
+ include Aws::Structure
786
+ end
787
+
788
+ # @note When making an API call, you may pass TagResourceRequest
789
+ # data as a hash:
790
+ #
791
+ # {
792
+ # resource_arn: "AmazonResourceName", # required
793
+ # tags: { # required
794
+ # "String128" => "String256",
795
+ # },
796
+ # }
797
+ #
798
+ # @!attribute [rw] resource_arn
799
+ # The resource ARN of an IoT Device Advisor resource.
800
+ # @return [String]
801
+ #
802
+ # @!attribute [rw] tags
803
+ # The tags to be attached to the IoT Device Advisor resource.
804
+ # @return [Hash<String,String>]
805
+ #
806
+ class TagResourceRequest < Struct.new(
807
+ :resource_arn,
808
+ :tags)
809
+ SENSITIVE = []
810
+ include Aws::Structure
811
+ end
812
+
813
+ class TagResourceResponse < Aws::EmptyStructure; end
814
+
815
+ # Shows tests in a test group.
816
+ #
817
+ # @!attribute [rw] name
818
+ # Shows test case name.
819
+ # @return [String]
820
+ #
821
+ # @!attribute [rw] configuration
822
+ # Shows test case configuration.
823
+ # @return [Hash<String,String>]
824
+ #
825
+ # @!attribute [rw] test
826
+ # Specifies a test.
827
+ # @return [Types::TestCaseDefinition]
828
+ #
829
+ class TestCase < Struct.new(
830
+ :name,
831
+ :configuration,
832
+ :test)
833
+ SENSITIVE = []
834
+ include Aws::Structure
835
+ end
836
+
837
+ # Gets the test case category.
838
+ #
839
+ # @!attribute [rw] name
840
+ # Lists all the tests name in the specified category.
841
+ # @return [String]
842
+ #
843
+ # @!attribute [rw] tests
844
+ # Lists all the tests in the specified category.
845
+ # @return [Array<Types::TestCase>]
846
+ #
847
+ class TestCaseCategory < Struct.new(
848
+ :name,
849
+ :tests)
850
+ SENSITIVE = []
851
+ include Aws::Structure
852
+ end
853
+
854
+ # Provides test case definition.
855
+ #
856
+ # @!attribute [rw] id
857
+ # Provides test case definition Id.
858
+ # @return [String]
859
+ #
860
+ # @!attribute [rw] test_case_version
861
+ # Provides test case definition version.
862
+ # @return [String]
863
+ #
864
+ class TestCaseDefinition < Struct.new(
865
+ :id,
866
+ :test_case_version)
867
+ SENSITIVE = []
868
+ include Aws::Structure
869
+ end
870
+
871
+ # Provides test case run.
872
+ #
873
+ # @!attribute [rw] test_case_run_id
874
+ # Provides test case run Id.
875
+ # @return [String]
876
+ #
877
+ # @!attribute [rw] test_case_definition_id
878
+ # Provides test case run definition Id.
879
+ # @return [String]
880
+ #
881
+ # @!attribute [rw] test_case_definition_name
882
+ # Provides test case run definition Name.
883
+ # @return [String]
884
+ #
885
+ # @!attribute [rw] status
886
+ # Provides test case run status.
887
+ # @return [String]
888
+ #
889
+ # @!attribute [rw] start_time
890
+ # Provides test case run start time.
891
+ # @return [Time]
892
+ #
893
+ # @!attribute [rw] end_time
894
+ # Provides test case run end time.
895
+ # @return [Time]
896
+ #
897
+ # @!attribute [rw] log_url
898
+ # Provides test case run log Url.
899
+ # @return [String]
900
+ #
901
+ # @!attribute [rw] warnings
902
+ # Provides test case run warnings.
903
+ # @return [String]
904
+ #
905
+ # @!attribute [rw] failure
906
+ # Provides test case run failure result.
907
+ # @return [String]
908
+ #
909
+ class TestCaseRun < Struct.new(
910
+ :test_case_run_id,
911
+ :test_case_definition_id,
912
+ :test_case_definition_name,
913
+ :status,
914
+ :start_time,
915
+ :end_time,
916
+ :log_url,
917
+ :warnings,
918
+ :failure)
919
+ SENSITIVE = []
920
+ include Aws::Structure
921
+ end
922
+
923
+ # Show each group result.
924
+ #
925
+ # @!attribute [rw] groups
926
+ # Show each group of test results.
927
+ # @return [Array<Types::GroupResult>]
928
+ #
929
+ class TestResult < Struct.new(
930
+ :groups)
931
+ SENSITIVE = []
932
+ include Aws::Structure
933
+ end
934
+
935
+ # @note When making an API call, you may pass UntagResourceRequest
936
+ # data as a hash:
937
+ #
938
+ # {
939
+ # resource_arn: "AmazonResourceName", # required
940
+ # tag_keys: ["String128"], # required
941
+ # }
942
+ #
943
+ # @!attribute [rw] resource_arn
944
+ # The resource ARN of an IoT Device Advisor resource.
945
+ # @return [String]
946
+ #
947
+ # @!attribute [rw] tag_keys
948
+ # List of tag keys to remove from the IoT Device Advisor resource.
949
+ # @return [Array<String>]
950
+ #
951
+ class UntagResourceRequest < Struct.new(
952
+ :resource_arn,
953
+ :tag_keys)
954
+ SENSITIVE = []
955
+ include Aws::Structure
956
+ end
957
+
958
+ class UntagResourceResponse < Aws::EmptyStructure; end
959
+
960
+ # @note When making an API call, you may pass UpdateSuiteDefinitionRequest
961
+ # data as a hash:
962
+ #
963
+ # {
964
+ # suite_definition_id: "UUID", # required
965
+ # suite_definition_configuration: {
966
+ # suite_definition_name: "SuiteDefinitionName",
967
+ # devices: [
968
+ # {
969
+ # thing_arn: "AmazonResourceName",
970
+ # certificate_arn: "AmazonResourceName",
971
+ # },
972
+ # ],
973
+ # intended_for_qualification: false,
974
+ # root_group: "RootGroup",
975
+ # device_permission_role_arn: "AmazonResourceName",
976
+ # },
977
+ # }
978
+ #
979
+ # @!attribute [rw] suite_definition_id
980
+ # Updates a Device Advisor test suite with suite definition id.
981
+ # @return [String]
982
+ #
983
+ # @!attribute [rw] suite_definition_configuration
984
+ # Updates a Device Advisor test suite with suite definition
985
+ # configuration.
986
+ # @return [Types::SuiteDefinitionConfiguration]
987
+ #
988
+ class UpdateSuiteDefinitionRequest < Struct.new(
989
+ :suite_definition_id,
990
+ :suite_definition_configuration)
991
+ SENSITIVE = []
992
+ include Aws::Structure
993
+ end
994
+
995
+ # @!attribute [rw] suite_definition_id
996
+ # Updates a Device Advisor test suite with suite UUID.
997
+ # @return [String]
998
+ #
999
+ # @!attribute [rw] suite_definition_arn
1000
+ # Updates a Device Advisor test suite with Amazon Resource name.
1001
+ # @return [String]
1002
+ #
1003
+ # @!attribute [rw] suite_definition_name
1004
+ # Updates a Device Advisor test suite with suite definition name.
1005
+ # @return [String]
1006
+ #
1007
+ # @!attribute [rw] suite_definition_version
1008
+ # Updates a Device Advisor test suite with suite definition version.
1009
+ # @return [String]
1010
+ #
1011
+ # @!attribute [rw] created_at
1012
+ # Updates a Device Advisor test suite with TimeStamp of when it was
1013
+ # created.
1014
+ # @return [Time]
1015
+ #
1016
+ # @!attribute [rw] last_updated_at
1017
+ # Updates a Device Advisor test suite with TimeStamp of when it was
1018
+ # updated.
1019
+ # @return [Time]
1020
+ #
1021
+ class UpdateSuiteDefinitionResponse < Struct.new(
1022
+ :suite_definition_id,
1023
+ :suite_definition_arn,
1024
+ :suite_definition_name,
1025
+ :suite_definition_version,
1026
+ :created_at,
1027
+ :last_updated_at)
1028
+ SENSITIVE = []
1029
+ include Aws::Structure
1030
+ end
1031
+
1032
+ # Sends invalid request exception.
1033
+ #
1034
+ # @!attribute [rw] message
1035
+ # Sends invalid request exception message.
1036
+ # @return [String]
1037
+ #
1038
+ class ValidationException < Struct.new(
1039
+ :message)
1040
+ SENSITIVE = []
1041
+ include Aws::Structure
1042
+ end
1043
+
1044
+ end
1045
+ end