-
Notifications
You must be signed in to change notification settings - Fork 600
/
api_types.go
2450 lines (2071 loc) · 80.9 KB
/
api_types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package devicefarm
import (
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
var _ aws.Config
var _ = awsutil.Prettify
// A container for account-level settings within AWS Device Farm.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/AccountSettings
type AccountSettings struct {
_ struct{} `type:"structure"`
// The AWS account number specified in the AccountSettings container.
AwsAccountNumber *string `locationName:"awsAccountNumber" min:"2" type:"string"`
// The default number of minutes (at the account level) a test run will execute
// before it times out. The default value is 150 minutes.
DefaultJobTimeoutMinutes *int64 `locationName:"defaultJobTimeoutMinutes" type:"integer"`
// The maximum number of minutes a test run will execute before it times out.
MaxJobTimeoutMinutes *int64 `locationName:"maxJobTimeoutMinutes" type:"integer"`
// The maximum number of device slots that the AWS account can purchase. Each
// maximum is expressed as an offering-id:number pair, where the offering-id
// represents one of the IDs returned by the ListOfferings command.
MaxSlots map[string]int64 `locationName:"maxSlots" type:"map"`
// When set to true, for private devices, Device Farm will not sign your app
// again. For public devices, Device Farm always signs your apps again and this
// parameter has no effect.
//
// For more information about how Device Farm re-signs your app(s), see Do you
// modify my app? (https://aws.amazon.com/device-farm/faq/) in the AWS Device
// Farm FAQs.
SkipAppResign *bool `locationName:"skipAppResign" type:"boolean"`
// Information about an AWS account's usage of free trial device minutes.
TrialMinutes *TrialMinutes `locationName:"trialMinutes" type:"structure"`
// Returns the unmetered devices you have purchased or want to purchase.
UnmeteredDevices map[string]int64 `locationName:"unmeteredDevices" type:"map"`
// Returns the unmetered remote access devices you have purchased or want to
// purchase.
UnmeteredRemoteAccessDevices map[string]int64 `locationName:"unmeteredRemoteAccessDevices" type:"map"`
}
// String returns the string representation
func (s AccountSettings) String() string {
return awsutil.Prettify(s)
}
// Represents the output of a test. Examples of artifacts include logs and screenshots.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/Artifact
type Artifact struct {
_ struct{} `type:"structure"`
// The artifact's ARN.
Arn *string `locationName:"arn" min:"32" type:"string"`
// The artifact's file extension.
Extension *string `locationName:"extension" type:"string"`
// The artifact's name.
Name *string `locationName:"name" type:"string"`
// The artifact's type.
//
// Allowed values include the following:
//
// * UNKNOWN: An unknown type.
//
// * SCREENSHOT: The screenshot type.
//
// * DEVICE_LOG: The device log type.
//
// * MESSAGE_LOG: The message log type.
//
// * VIDEO_LOG: The video log type.
//
// * RESULT_LOG: The result log type.
//
// * SERVICE_LOG: The service log type.
//
// * WEBKIT_LOG: The web kit log type.
//
// * INSTRUMENTATION_OUTPUT: The instrumentation type.
//
// * EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by
// an Android fuzz test.
//
// * CALABASH_JSON_OUTPUT: The Calabash JSON output type.
//
// * CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
//
// * CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
//
// * CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
//
// * AUTOMATION_OUTPUT: The automation output type.
//
// * APPIUM_SERVER_OUTPUT: The Appium server output type.
//
// * APPIUM_JAVA_OUTPUT: The Appium Java output type.
//
// * APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
//
// * APPIUM_PYTHON_OUTPUT: The Appium Python output type.
//
// * APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
//
// * EXPLORER_EVENT_LOG: The Explorer event log output type.
//
// * EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
//
// * APPLICATION_CRASH_REPORT: The application crash report output type.
//
// * XCTEST_LOG: The Xcode test output type.
//
// * VIDEO: The Video output type.
//
// * CUSTOMER_ARTIFACT:The Customer Artifact output type.
//
// * CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type.
//
// * TESTSPEC_OUTPUT: The Test Spec Output type.
Type ArtifactType `locationName:"type" type:"string" enum:"true"`
// The pre-signed Amazon S3 URL that can be used with a corresponding GET request
// to download the artifact's file.
Url *string `locationName:"url" type:"string"`
}
// String returns the string representation
func (s Artifact) String() string {
return awsutil.Prettify(s)
}
// Represents the amount of CPU that an app is using on a physical device.
//
// Note that this does not represent system-wide CPU usage.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/CPU
type CPU struct {
_ struct{} `type:"structure"`
// The CPU's architecture, for example x86 or ARM.
Architecture *string `locationName:"architecture" type:"string"`
// The clock speed of the device's CPU, expressed in hertz (Hz). For example,
// a 1.2 GHz CPU is expressed as 1200000000.
Clock *float64 `locationName:"clock" type:"double"`
// The CPU's frequency.
Frequency *string `locationName:"frequency" type:"string"`
}
// String returns the string representation
func (s CPU) String() string {
return awsutil.Prettify(s)
}
// Represents entity counters.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/Counters
type Counters struct {
_ struct{} `type:"structure"`
// The number of errored entities.
Errored *int64 `locationName:"errored" type:"integer"`
// The number of failed entities.
Failed *int64 `locationName:"failed" type:"integer"`
// The number of passed entities.
Passed *int64 `locationName:"passed" type:"integer"`
// The number of skipped entities.
Skipped *int64 `locationName:"skipped" type:"integer"`
// The number of stopped entities.
Stopped *int64 `locationName:"stopped" type:"integer"`
// The total number of entities.
Total *int64 `locationName:"total" type:"integer"`
// The number of warned entities.
Warned *int64 `locationName:"warned" type:"integer"`
}
// String returns the string representation
func (s Counters) String() string {
return awsutil.Prettify(s)
}
// Configuration settings for a remote access session, including billing method.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/CreateRemoteAccessSessionConfiguration
type CreateRemoteAccessSessionConfiguration struct {
_ struct{} `type:"structure"`
// The billing method for the remote access session.
BillingMethod BillingMethod `locationName:"billingMethod" type:"string" enum:"true"`
// An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.
VpceConfigurationArns []string `locationName:"vpceConfigurationArns" type:"list"`
}
// String returns the string representation
func (s CreateRemoteAccessSessionConfiguration) String() string {
return awsutil.Prettify(s)
}
// A JSON object specifying the paths where the artifacts generated by the customer's
// tests, on the device or in the test environment, will be pulled from.
//
// Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.
//
// For web app tests, you can specify both iosPaths and androidPaths.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/CustomerArtifactPaths
type CustomerArtifactPaths struct {
_ struct{} `type:"structure"`
// Comma-separated list of paths on the Android device where the artifacts generated
// by the customer's tests will be pulled from.
AndroidPaths []string `locationName:"androidPaths" type:"list"`
// Comma-separated list of paths in the test execution environment where the
// artifacts generated by the customer's tests will be pulled from.
DeviceHostPaths []string `locationName:"deviceHostPaths" type:"list"`
// Comma-separated list of paths on the iOS device where the artifacts generated
// by the customer's tests will be pulled from.
IosPaths []string `locationName:"iosPaths" type:"list"`
}
// String returns the string representation
func (s CustomerArtifactPaths) String() string {
return awsutil.Prettify(s)
}
// Represents a device type that an app is tested against.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/Device
type Device struct {
_ struct{} `type:"structure"`
// The device's ARN.
Arn *string `locationName:"arn" min:"32" type:"string"`
// Reflects how likely a device will be available for a test run. It is currently
// available in the ListDevices and GetDevice API methods.
Availability DeviceAvailability `locationName:"availability" type:"string" enum:"true"`
// The device's carrier.
Carrier *string `locationName:"carrier" type:"string"`
// Information about the device's CPU.
Cpu *CPU `locationName:"cpu" type:"structure"`
// The name of the fleet to which this device belongs.
FleetName *string `locationName:"fleetName" type:"string"`
// The type of fleet to which this device belongs. Possible values for fleet
// type are PRIVATE and PUBLIC.
FleetType *string `locationName:"fleetType" type:"string"`
// The device's form factor.
//
// Allowed values include:
//
// * PHONE: The phone form factor.
//
// * TABLET: The tablet form factor.
FormFactor DeviceFormFactor `locationName:"formFactor" type:"string" enum:"true"`
// The device's heap size, expressed in bytes.
HeapSize *int64 `locationName:"heapSize" type:"long"`
// The device's image name.
Image *string `locationName:"image" type:"string"`
// The instances belonging to this device.
Instances []DeviceInstance `locationName:"instances" type:"list"`
// The device's manufacturer name.
Manufacturer *string `locationName:"manufacturer" type:"string"`
// The device's total memory size, expressed in bytes.
Memory *int64 `locationName:"memory" type:"long"`
// The device's model name.
Model *string `locationName:"model" type:"string"`
// The device's model ID.
ModelId *string `locationName:"modelId" type:"string"`
// The device's display name.
Name *string `locationName:"name" type:"string"`
// The device's operating system type.
Os *string `locationName:"os" type:"string"`
// The device's platform.
//
// Allowed values include:
//
// * ANDROID: The Android platform.
//
// * IOS: The iOS platform.
Platform DevicePlatform `locationName:"platform" type:"string" enum:"true"`
// The device's radio.
Radio *string `locationName:"radio" type:"string"`
// Specifies whether remote access has been enabled for the specified device.
RemoteAccessEnabled *bool `locationName:"remoteAccessEnabled" type:"boolean"`
// This flag is set to true if remote debugging is enabled for the device.
RemoteDebugEnabled *bool `locationName:"remoteDebugEnabled" type:"boolean"`
// The resolution of the device.
Resolution *Resolution `locationName:"resolution" type:"structure"`
}
// String returns the string representation
func (s Device) String() string {
return awsutil.Prettify(s)
}
// Represents a device filter used to select a set of devices to be included
// in a test run. This data structure is passed in as the deviceSelectionConfiguration
// parameter to ScheduleRun. For an example of the JSON request syntax, see
// ScheduleRun.
//
// It is also passed in as the filters parameter to ListDevices. For an example
// of the JSON request syntax, see ListDevices.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/DeviceFilter
type DeviceFilter struct {
_ struct{} `type:"structure"`
// The aspect of a device such as platform or model used as the selection criteria
// in a device filter.
//
// The supported operators for each attribute are provided in the following
// list.
//
// ARN
//
// The Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
//
// Supported operators: EQUALS, IN, NOT_IN
//
// PLATFORM
//
// The device platform. Valid values are "ANDROID" or "IOS".
//
// Supported operators: EQUALS
//
// OS_VERSION
//
// The operating system version. For example, "10.3.2".
//
// Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN,
// LESS_THAN_OR_EQUALS, NOT_IN
//
// MODEL
//
// The device model. For example, "iPad 5th Gen".
//
// Supported operators: CONTAINS, EQUALS, IN, NOT_IN
//
// AVAILABILITY
//
// The current availability of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE",
// "BUSY", or "TEMPORARY_NOT_AVAILABLE".
//
// Supported operators: EQUALS
//
// FORM_FACTOR
//
// The device form factor. Valid values are "PHONE" or "TABLET".
//
// Supported operators: EQUALS
//
// MANUFACTURER
//
// The device manufacturer. For example, "Apple".
//
// Supported operators: EQUALS, IN, NOT_IN
//
// REMOTE_ACCESS_ENABLED
//
// Whether the device is enabled for remote access. Valid values are "TRUE"
// or "FALSE".
//
// Supported operators: EQUALS
//
// REMOTE_DEBUG_ENABLED
//
// Whether the device is enabled for remote debugging. Valid values are "TRUE"
// or "FALSE".
//
// Supported operators: EQUALS
//
// INSTANCE_ARN
//
// The Amazon Resource Name (ARN) of the device instance.
//
// Supported operators: EQUALS, IN, NOT_IN
//
// INSTANCE_LABELS
//
// The label of the device instance.
//
// Supported operators: CONTAINS
//
// FLEET_TYPE
//
// The fleet type. Valid values are "PUBLIC" or "PRIVATE".
//
// Supported operators: EQUALS
Attribute DeviceFilterAttribute `locationName:"attribute" type:"string" enum:"true"`
// Specifies how Device Farm compares the filter's attribute to the value. For
// the operators that are supported by each attribute, see the attribute descriptions.
Operator RuleOperator `locationName:"operator" type:"string" enum:"true"`
// An array of one or more filter values used in a device filter.
//
// Operator Values
//
// * The IN and NOT_IN operators can take a values array that has more than
// one element.
//
// * The other operators require an array with a single element.
//
// Attribute Values
//
// * The PLATFORM attribute can be set to "ANDROID" or "IOS".
//
// * The AVAILABILITY attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE",
// "BUSY", or "TEMPORARY_NOT_AVAILABLE".
//
// * The FORM_FACTOR attribute can be set to "PHONE" or "TABLET".
//
// * The FLEET_TYPE attribute can be set to "PUBLIC" or "PRIVATE".
Values []string `locationName:"values" type:"list"`
}
// String returns the string representation
func (s DeviceFilter) String() string {
return awsutil.Prettify(s)
}
// Represents the device instance.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/DeviceInstance
type DeviceInstance struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the device instance.
Arn *string `locationName:"arn" min:"32" type:"string"`
// The Amazon Resource Name (ARN) of the device.
DeviceArn *string `locationName:"deviceArn" min:"32" type:"string"`
// A object containing information about the instance profile.
InstanceProfile *InstanceProfile `locationName:"instanceProfile" type:"structure"`
// An array of strings describing the device instance.
Labels []string `locationName:"labels" type:"list"`
// The status of the device instance. Valid values are listed below.
Status InstanceStatus `locationName:"status" type:"string" enum:"true"`
// Unique device identifier for the device instance.
Udid *string `locationName:"udid" type:"string"`
}
// String returns the string representation
func (s DeviceInstance) String() string {
return awsutil.Prettify(s)
}
// Represents the total (metered or unmetered) minutes used by the resource
// to run tests. Contains the sum of minutes consumed by all children.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/DeviceMinutes
type DeviceMinutes struct {
_ struct{} `type:"structure"`
// When specified, represents only the sum of metered minutes used by the resource
// to run tests.
Metered *float64 `locationName:"metered" type:"double"`
// When specified, represents the total minutes used by the resource to run
// tests.
Total *float64 `locationName:"total" type:"double"`
// When specified, represents only the sum of unmetered minutes used by the
// resource to run tests.
Unmetered *float64 `locationName:"unmetered" type:"double"`
}
// String returns the string representation
func (s DeviceMinutes) String() string {
return awsutil.Prettify(s)
}
// Represents a collection of device types.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/DevicePool
type DevicePool struct {
_ struct{} `type:"structure"`
// The device pool's ARN.
Arn *string `locationName:"arn" min:"32" type:"string"`
// The device pool's description.
Description *string `locationName:"description" type:"string"`
// The number of devices that Device Farm can add to your device pool. Device
// Farm adds devices that are available and that meet the criteria that you
// assign for the rules parameter. Depending on how many devices meet these
// constraints, your device pool might contain fewer devices than the value
// for this parameter.
//
// By specifying the maximum number of devices, you can control the costs that
// you incur by running tests.
MaxDevices *int64 `locationName:"maxDevices" type:"integer"`
// The device pool's name.
Name *string `locationName:"name" type:"string"`
// Information about the device pool's rules.
Rules []Rule `locationName:"rules" type:"list"`
// The device pool's type.
//
// Allowed values include:
//
// * CURATED: A device pool that is created and managed by AWS Device Farm.
//
// * PRIVATE: A device pool that is created and managed by the device pool
// developer.
Type DevicePoolType `locationName:"type" type:"string" enum:"true"`
}
// String returns the string representation
func (s DevicePool) String() string {
return awsutil.Prettify(s)
}
// Represents a device pool compatibility result.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/DevicePoolCompatibilityResult
type DevicePoolCompatibilityResult struct {
_ struct{} `type:"structure"`
// Whether the result was compatible with the device pool.
Compatible *bool `locationName:"compatible" type:"boolean"`
// The device (phone or tablet) that you wish to return information about.
Device *Device `locationName:"device" type:"structure"`
// Information about the compatibility.
IncompatibilityMessages []IncompatibilityMessage `locationName:"incompatibilityMessages" type:"list"`
}
// String returns the string representation
func (s DevicePoolCompatibilityResult) String() string {
return awsutil.Prettify(s)
}
// Represents the device filters used in a test run as well as the maximum number
// of devices to be included in the run. It is passed in as the deviceSelectionConfiguration
// request parameter in ScheduleRun.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/DeviceSelectionConfiguration
type DeviceSelectionConfiguration struct {
_ struct{} `type:"structure"`
// Used to dynamically select a set of devices for a test run. A filter is made
// up of an attribute, an operator, and one or more values.
//
// * Attribute The aspect of a device such as platform or model used as the
// selection criteria in a device filter. Allowed values include: ARN: The
// Amazon Resource Name (ARN) of the device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
// PLATFORM: The device platform. Valid values are "ANDROID" or "IOS". OS_VERSION:
// The operating system version. For example, "10.3.2". MODEL: The device
// model. For example, "iPad 5th Gen". AVAILABILITY: The current availability
// of the device. Valid values are "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY",
// or "TEMPORARY_NOT_AVAILABLE". FORM_FACTOR: The device form factor. Valid
// values are "PHONE" or "TABLET". MANUFACTURER: The device manufacturer.
// For example, "Apple". REMOTE_ACCESS_ENABLED: Whether the device is enabled
// for remote access. Valid values are "TRUE" or "FALSE". REMOTE_DEBUG_ENABLED:
// Whether the device is enabled for remote debugging. Valid values are "TRUE"
// or "FALSE". INSTANCE_ARN: The Amazon Resource Name (ARN) of the device
// instance. INSTANCE_LABELS: The label of the device instance. FLEET_TYPE:
// The fleet type. Valid values are "PUBLIC" or "PRIVATE".
//
// * Operator The filter operator. The EQUALS operator is available for every
// attribute except INSTANCE_LABELS. The CONTAINS operator is available for
// the INSTANCE_LABELS and MODEL attributes. The IN and NOT_IN operators
// are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN
// attributes. The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS
// operators are also available for the OS_VERSION attribute.
//
// * Values An array of one or more filter values. Operator Values The IN
// and NOT_IN operators can take a values array that has more than one element.
// The other operators require an array with a single element. Attribute
// Values The PLATFORM attribute can be set to "ANDROID" or "IOS". The AVAILABILITY
// attribute can be set to "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE".
// The FORM_FACTOR attribute can be set to "PHONE" or "TABLET". The FLEET_TYPE
// attribute can be set to "PUBLIC" or "PRIVATE".
//
// Filters is a required field
Filters []DeviceFilter `locationName:"filters" type:"list" required:"true"`
// The maximum number of devices to be included in a test run.
//
// MaxDevices is a required field
MaxDevices *int64 `locationName:"maxDevices" type:"integer" required:"true"`
}
// String returns the string representation
func (s DeviceSelectionConfiguration) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DeviceSelectionConfiguration) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DeviceSelectionConfiguration"}
if s.Filters == nil {
invalidParams.Add(aws.NewErrParamRequired("Filters"))
}
if s.MaxDevices == nil {
invalidParams.Add(aws.NewErrParamRequired("MaxDevices"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Contains the run results requested by the device selection configuration
// as well as how many devices were returned. For an example of the JSON response
// syntax, see ScheduleRun.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/DeviceSelectionResult
type DeviceSelectionResult struct {
_ struct{} `type:"structure"`
// The filters in a device selection result.
Filters []DeviceFilter `locationName:"filters" type:"list"`
// The number of devices that matched the device filter selection criteria.
MatchedDevicesCount *int64 `locationName:"matchedDevicesCount" type:"integer"`
// The maximum number of devices to be selected by a device filter and included
// in a test run.
MaxDevices *int64 `locationName:"maxDevices" type:"integer"`
}
// String returns the string representation
func (s DeviceSelectionResult) String() string {
return awsutil.Prettify(s)
}
// Represents configuration information about a test run, such as the execution
// timeout (in minutes).
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/ExecutionConfiguration
type ExecutionConfiguration struct {
_ struct{} `type:"structure"`
// True if account cleanup is enabled at the beginning of the test; otherwise,
// false.
AccountsCleanup *bool `locationName:"accountsCleanup" type:"boolean"`
// True if app package cleanup is enabled at the beginning of the test; otherwise,
// false.
AppPackagesCleanup *bool `locationName:"appPackagesCleanup" type:"boolean"`
// The number of minutes a test run will execute before it times out.
JobTimeoutMinutes *int64 `locationName:"jobTimeoutMinutes" type:"integer"`
// When set to true, for private devices, Device Farm will not sign your app
// again. For public devices, Device Farm always signs your apps again and this
// parameter has no effect.
//
// For more information about how Device Farm re-signs your app(s), see Do you
// modify my app? (https://aws.amazon.com/device-farm/faq/) in the AWS Device
// Farm FAQs.
SkipAppResign *bool `locationName:"skipAppResign" type:"boolean"`
// Set to true to enable video capture; otherwise, set to false. The default
// is true.
VideoCapture *bool `locationName:"videoCapture" type:"boolean"`
}
// String returns the string representation
func (s ExecutionConfiguration) String() string {
return awsutil.Prettify(s)
}
// Represents information about incompatibility.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/IncompatibilityMessage
type IncompatibilityMessage struct {
_ struct{} `type:"structure"`
// A message about the incompatibility.
Message *string `locationName:"message" type:"string"`
// The type of incompatibility.
//
// Allowed values include:
//
// * ARN: The ARN.
//
// * FORM_FACTOR: The form factor (for example, phone or tablet).
//
// * MANUFACTURER: The manufacturer.
//
// * PLATFORM: The platform (for example, Android or iOS).
//
// * REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
//
// * APPIUM_VERSION: The Appium version for the test.
Type DeviceAttribute `locationName:"type" type:"string" enum:"true"`
}
// String returns the string representation
func (s IncompatibilityMessage) String() string {
return awsutil.Prettify(s)
}
// Represents the instance profile.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/InstanceProfile
type InstanceProfile struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the instance profile.
Arn *string `locationName:"arn" min:"32" type:"string"`
// The description of the instance profile.
Description *string `locationName:"description" type:"string"`
// An array of strings specifying the list of app packages that should not be
// cleaned up from the device after a test run is over.
//
// The list of packages is only considered if you set packageCleanup to true.
ExcludeAppPackagesFromCleanup []string `locationName:"excludeAppPackagesFromCleanup" type:"list"`
// The name of the instance profile.
Name *string `locationName:"name" type:"string"`
// When set to true, Device Farm will remove app packages after a test run.
// The default value is false for private devices.
PackageCleanup *bool `locationName:"packageCleanup" type:"boolean"`
// When set to true, Device Farm will reboot the instance after a test run.
// The default value is true.
RebootAfterUse *bool `locationName:"rebootAfterUse" type:"boolean"`
}
// String returns the string representation
func (s InstanceProfile) String() string {
return awsutil.Prettify(s)
}
// Represents a device.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/Job
type Job struct {
_ struct{} `type:"structure"`
// The job's ARN.
Arn *string `locationName:"arn" min:"32" type:"string"`
// The job's result counters.
Counters *Counters `locationName:"counters" type:"structure"`
// When the job was created.
Created *time.Time `locationName:"created" type:"timestamp"`
// The device (phone or tablet).
Device *Device `locationName:"device" type:"structure"`
// Represents the total (metered or unmetered) minutes used by the job.
DeviceMinutes *DeviceMinutes `locationName:"deviceMinutes" type:"structure"`
// The Amazon Resource Name (ARN) of the instance.
InstanceArn *string `locationName:"instanceArn" min:"32" type:"string"`
// A message about the job's result.
Message *string `locationName:"message" type:"string"`
// The job's name.
Name *string `locationName:"name" type:"string"`
// The job's result.
//
// Allowed values include:
//
// * PENDING: A pending condition.
//
// * PASSED: A passing condition.
//
// * WARNED: A warning condition.
//
// * FAILED: A failed condition.
//
// * SKIPPED: A skipped condition.
//
// * ERRORED: An error condition.
//
// * STOPPED: A stopped condition.
Result ExecutionResult `locationName:"result" type:"string" enum:"true"`
// The job's start time.
Started *time.Time `locationName:"started" type:"timestamp"`
// The job's status.
//
// Allowed values include:
//
// * PENDING: A pending status.
//
// * PENDING_CONCURRENCY: A pending concurrency status.
//
// * PENDING_DEVICE: A pending device status.
//
// * PROCESSING: A processing status.
//
// * SCHEDULING: A scheduling status.
//
// * PREPARING: A preparing status.
//
// * RUNNING: A running status.
//
// * COMPLETED: A completed status.
//
// * STOPPING: A stopping status.
Status ExecutionStatus `locationName:"status" type:"string" enum:"true"`
// The job's stop time.
Stopped *time.Time `locationName:"stopped" type:"timestamp"`
// The job's type.
//
// Allowed values include the following:
//
// * BUILTIN_FUZZ: The built-in fuzz type.
//
// * BUILTIN_EXPLORER: For Android, an app explorer that will traverse an
// Android app, interacting with it and capturing screenshots at the same
// time.
//
// * APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
//
// * APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
//
// * APPIUM_PYTHON: The Appium Python type.
//
// * APPIUM_NODE: The Appium Node.js type.
//
// * APPIUM_RUBY: The Appium Ruby type.
//
// * APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
//
// * APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
//
// * APPIUM_WEB_PYTHON: The Appium Python type for web apps.
//
// * APPIUM_WEB_NODE: The Appium Node.js type for web apps.
//
// * APPIUM_WEB_RUBY: The Appium Ruby test type for web apps.
//
// * CALABASH: The Calabash type.
//
// * INSTRUMENTATION: The Instrumentation type.
//
// * UIAUTOMATION: The uiautomation type.
//
// * UIAUTOMATOR: The uiautomator type.
//
// * XCTEST: The Xcode test type.
//
// * XCTEST_UI: The Xcode UI test type.
Type TestType `locationName:"type" type:"string" enum:"true"`
// This value is set to true if video capture is enabled; otherwise, it is set
// to false.
VideoCapture *bool `locationName:"videoCapture" type:"boolean"`
// The endpoint for streaming device video.
VideoEndpoint *string `locationName:"videoEndpoint" type:"string"`
}
// String returns the string representation
func (s Job) String() string {
return awsutil.Prettify(s)
}
// Represents a latitude and longitude pair, expressed in geographic coordinate
// system degrees (for example 47.6204, -122.3491).
//
// Elevation is currently not supported.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/Location
type Location struct {
_ struct{} `type:"structure"`
// The latitude.
//
// Latitude is a required field
Latitude *float64 `locationName:"latitude" type:"double" required:"true"`
// The longitude.
//
// Longitude is a required field
Longitude *float64 `locationName:"longitude" type:"double" required:"true"`
}
// String returns the string representation
func (s Location) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *Location) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "Location"}
if s.Latitude == nil {
invalidParams.Add(aws.NewErrParamRequired("Latitude"))
}
if s.Longitude == nil {
invalidParams.Add(aws.NewErrParamRequired("Longitude"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// A number representing the monetary amount for an offering or transaction.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/MonetaryAmount
type MonetaryAmount struct {
_ struct{} `type:"structure"`
// The numerical amount of an offering or transaction.
Amount *float64 `locationName:"amount" type:"double"`
// The currency code of a monetary amount. For example, USD means "U.S. dollars."
CurrencyCode CurrencyCode `locationName:"currencyCode" type:"string" enum:"true"`
}
// String returns the string representation
func (s MonetaryAmount) String() string {
return awsutil.Prettify(s)
}
// An array of settings that describes characteristics of a network profile.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/devicefarm-2015-06-23/NetworkProfile
type NetworkProfile struct {
_ struct{} `type:"structure"`
// The Amazon Resource Name (ARN) of the network profile.
Arn *string `locationName:"arn" min:"32" type:"string"`
// The description of the network profile.
Description *string `locationName:"description" type:"string"`
// The data throughput rate in bits per second, as an integer from 0 to 104857600.
DownlinkBandwidthBits *int64 `locationName:"downlinkBandwidthBits" type:"long"`
// Delay time for all packets to destination in milliseconds as an integer from
// 0 to 2000.
DownlinkDelayMs *int64 `locationName:"downlinkDelayMs" type:"long"`
// Time variation in the delay of received packets in milliseconds as an integer
// from 0 to 2000.
DownlinkJitterMs *int64 `locationName:"downlinkJitterMs" type:"long"`
// Proportion of received packets that fail to arrive from 0 to 100 percent.
DownlinkLossPercent *int64 `locationName:"downlinkLossPercent" type:"integer"`
// The name of the network profile.
Name *string `locationName:"name" type:"string"`
// The type of network profile. Valid values are listed below.
Type NetworkProfileType `locationName:"type" type:"string" enum:"true"`
// The data throughput rate in bits per second, as an integer from 0 to 104857600.
UplinkBandwidthBits *int64 `locationName:"uplinkBandwidthBits" type:"long"`
// Delay time for all packets to destination in milliseconds as an integer from
// 0 to 2000.
UplinkDelayMs *int64 `locationName:"uplinkDelayMs" type:"long"`