@aws-sdk/client-device-farm 3.379.1 → 3.382.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.
@@ -7,10 +7,12 @@ import { DeviceFarmServiceException as __BaseException } from "./DeviceFarmServi
7
7
  */
8
8
  export interface TrialMinutes {
9
9
  /**
10
+ * @public
10
11
  * <p>The total number of free trial minutes that the account started with.</p>
11
12
  */
12
13
  total?: number;
13
14
  /**
15
+ * @public
14
16
  * <p>The number of free trial minutes remaining in the account.</p>
15
17
  */
16
18
  remaining?: number;
@@ -33,28 +35,34 @@ export type DevicePlatform = (typeof DevicePlatform)[keyof typeof DevicePlatform
33
35
  */
34
36
  export interface AccountSettings {
35
37
  /**
38
+ * @public
36
39
  * <p>The AWS account number specified in the <code>AccountSettings</code>
37
40
  * container.</p>
38
41
  */
39
42
  awsAccountNumber?: string;
40
43
  /**
44
+ * @public
41
45
  * <p>Returns the unmetered devices you have purchased or want to purchase.</p>
42
46
  */
43
47
  unmeteredDevices?: Record<string, number>;
44
48
  /**
49
+ * @public
45
50
  * <p>Returns the unmetered remote access devices you have purchased or want to
46
51
  * purchase.</p>
47
52
  */
48
53
  unmeteredRemoteAccessDevices?: Record<string, number>;
49
54
  /**
55
+ * @public
50
56
  * <p>The maximum number of minutes a test run executes before it times out.</p>
51
57
  */
52
58
  maxJobTimeoutMinutes?: number;
53
59
  /**
60
+ * @public
54
61
  * <p>Information about an AWS account's usage of free trial device minutes.</p>
55
62
  */
56
63
  trialMinutes?: TrialMinutes;
57
64
  /**
65
+ * @public
58
66
  * <p>The maximum number of device slots that the AWS account can purchase. Each maximum
59
67
  * is expressed as an <code>offering-id:number</code> pair, where the
60
68
  * <code>offering-id</code> represents one of the IDs returned by the
@@ -62,11 +70,13 @@ export interface AccountSettings {
62
70
  */
63
71
  maxSlots?: Record<string, number>;
64
72
  /**
73
+ * @public
65
74
  * <p>The default number of minutes (at the account level) a test run executes before it times out. The
66
75
  * default value is 150 minutes.</p>
67
76
  */
68
77
  defaultJobTimeoutMinutes?: number;
69
78
  /**
79
+ * @public
70
80
  * <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public
71
81
  * devices, Device Farm always signs your apps again.</p>
72
82
  * <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device
@@ -131,14 +141,17 @@ export type ArtifactType = (typeof ArtifactType)[keyof typeof ArtifactType];
131
141
  */
132
142
  export interface Artifact {
133
143
  /**
144
+ * @public
134
145
  * <p>The artifact's ARN.</p>
135
146
  */
136
147
  arn?: string;
137
148
  /**
149
+ * @public
138
150
  * <p>The artifact's name.</p>
139
151
  */
140
152
  name?: string;
141
153
  /**
154
+ * @public
142
155
  * <p>The artifact's type.</p>
143
156
  * <p>Allowed values include the following:</p>
144
157
  * <ul>
@@ -230,10 +243,12 @@ export interface Artifact {
230
243
  */
231
244
  type?: ArtifactType | string;
232
245
  /**
246
+ * @public
233
247
  * <p>The artifact's file extension.</p>
234
248
  */
235
249
  extension?: string;
236
250
  /**
251
+ * @public
237
252
  * <p>The presigned Amazon S3 URL that can be used with a GET request to download the artifact's
238
253
  * file.</p>
239
254
  */
@@ -282,30 +297,37 @@ export declare class CannotDeleteException extends __BaseException {
282
297
  */
283
298
  export interface Counters {
284
299
  /**
300
+ * @public
285
301
  * <p>The total number of entities.</p>
286
302
  */
287
303
  total?: number;
288
304
  /**
305
+ * @public
289
306
  * <p>The number of passed entities.</p>
290
307
  */
291
308
  passed?: number;
292
309
  /**
310
+ * @public
293
311
  * <p>The number of failed entities.</p>
294
312
  */
295
313
  failed?: number;
296
314
  /**
315
+ * @public
297
316
  * <p>The number of warned entities.</p>
298
317
  */
299
318
  warned?: number;
300
319
  /**
320
+ * @public
301
321
  * <p>The number of errored entities.</p>
302
322
  */
303
323
  errored?: number;
304
324
  /**
325
+ * @public
305
326
  * <p>The number of stopped entities.</p>
306
327
  */
307
328
  stopped?: number;
308
329
  /**
330
+ * @public
309
331
  * <p>The number of skipped entities.</p>
310
332
  */
311
333
  skipped?: number;
@@ -317,14 +339,17 @@ export interface Counters {
317
339
  */
318
340
  export interface CPU {
319
341
  /**
342
+ * @public
320
343
  * <p>The CPU's frequency.</p>
321
344
  */
322
345
  frequency?: string;
323
346
  /**
347
+ * @public
324
348
  * <p>The CPU's architecture (for example, x86 or ARM).</p>
325
349
  */
326
350
  architecture?: string;
327
351
  /**
352
+ * @public
328
353
  * <p>The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2
329
354
  * GHz CPU is expressed as 1200000000.</p>
330
355
  */
@@ -377,6 +402,7 @@ export type RuleOperator = (typeof RuleOperator)[keyof typeof RuleOperator];
377
402
  */
378
403
  export interface Rule {
379
404
  /**
405
+ * @public
380
406
  * <p>The rule's stringified attribute. For example, specify the value as
381
407
  * <code>"\"abc\""</code>.</p>
382
408
  * <p>The supported operators for each attribute are provided in the following
@@ -479,12 +505,14 @@ export interface Rule {
479
505
  */
480
506
  attribute?: DeviceAttribute | string;
481
507
  /**
508
+ * @public
482
509
  * <p>Specifies how Device Farm compares the rule's attribute to the value. For the
483
510
  * operators that are supported by each attribute, see the attribute
484
511
  * descriptions.</p>
485
512
  */
486
513
  operator?: RuleOperator | string;
487
514
  /**
515
+ * @public
488
516
  * <p>The rule's value.</p>
489
517
  */
490
518
  value?: string;
@@ -495,22 +523,27 @@ export interface Rule {
495
523
  */
496
524
  export interface CreateDevicePoolRequest {
497
525
  /**
526
+ * @public
498
527
  * <p>The ARN of the project for the device pool.</p>
499
528
  */
500
529
  projectArn: string | undefined;
501
530
  /**
531
+ * @public
502
532
  * <p>The device pool's name.</p>
503
533
  */
504
534
  name: string | undefined;
505
535
  /**
536
+ * @public
506
537
  * <p>The device pool's description.</p>
507
538
  */
508
539
  description?: string;
509
540
  /**
541
+ * @public
510
542
  * <p>The device pool's rules.</p>
511
543
  */
512
544
  rules: Rule[] | undefined;
513
545
  /**
546
+ * @public
514
547
  * <p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are
515
548
  * available and meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many
516
549
  * devices meet these constraints, your device pool might contain fewer devices than the value for this
@@ -538,18 +571,22 @@ export type DevicePoolType = (typeof DevicePoolType)[keyof typeof DevicePoolType
538
571
  */
539
572
  export interface DevicePool {
540
573
  /**
574
+ * @public
541
575
  * <p>The device pool's ARN.</p>
542
576
  */
543
577
  arn?: string;
544
578
  /**
579
+ * @public
545
580
  * <p>The device pool's name.</p>
546
581
  */
547
582
  name?: string;
548
583
  /**
584
+ * @public
549
585
  * <p>The device pool's description.</p>
550
586
  */
551
587
  description?: string;
552
588
  /**
589
+ * @public
553
590
  * <p>The device pool's type.</p>
554
591
  * <p>Allowed values include:</p>
555
592
  * <ul>
@@ -565,10 +602,12 @@ export interface DevicePool {
565
602
  */
566
603
  type?: DevicePoolType | string;
567
604
  /**
605
+ * @public
568
606
  * <p>Information about the device pool's rules.</p>
569
607
  */
570
608
  rules?: Rule[];
571
609
  /**
610
+ * @public
572
611
  * <p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are
573
612
  * available and meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many
574
613
  * devices meet these constraints, your device pool might contain fewer devices than the value for this
@@ -584,6 +623,7 @@ export interface DevicePool {
584
623
  */
585
624
  export interface CreateDevicePoolResult {
586
625
  /**
626
+ * @public
587
627
  * <p>The newly created device pool.</p>
588
628
  */
589
629
  devicePool?: DevicePool;
@@ -629,19 +669,23 @@ export declare class ServiceAccountException extends __BaseException {
629
669
  */
630
670
  export interface CreateInstanceProfileRequest {
631
671
  /**
672
+ * @public
632
673
  * <p>The name of your instance profile.</p>
633
674
  */
634
675
  name: string | undefined;
635
676
  /**
677
+ * @public
636
678
  * <p>The description of your instance profile.</p>
637
679
  */
638
680
  description?: string;
639
681
  /**
682
+ * @public
640
683
  * <p>When set to <code>true</code>, Device Farm removes app packages after a test run. The default value is
641
684
  * <code>false</code> for private devices.</p>
642
685
  */
643
686
  packageCleanup?: boolean;
644
687
  /**
688
+ * @public
645
689
  * <p>An array of strings that specifies the list of app packages that should not be cleaned up from the device
646
690
  * after a test run.</p>
647
691
  * <p>The list of packages is considered only if you set <code>packageCleanup</code> to
@@ -649,6 +693,7 @@ export interface CreateInstanceProfileRequest {
649
693
  */
650
694
  excludeAppPackagesFromCleanup?: string[];
651
695
  /**
696
+ * @public
652
697
  * <p>When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is
653
698
  * <code>true</code>.</p>
654
699
  */
@@ -660,15 +705,18 @@ export interface CreateInstanceProfileRequest {
660
705
  */
661
706
  export interface InstanceProfile {
662
707
  /**
708
+ * @public
663
709
  * <p>The Amazon Resource Name (ARN) of the instance profile.</p>
664
710
  */
665
711
  arn?: string;
666
712
  /**
713
+ * @public
667
714
  * <p>When set to <code>true</code>, Device Farm removes app packages after a test run. The default value is
668
715
  * <code>false</code> for private devices.</p>
669
716
  */
670
717
  packageCleanup?: boolean;
671
718
  /**
719
+ * @public
672
720
  * <p>An array of strings containing the list of app packages that should not be cleaned up from the device
673
721
  * after a test run completes.</p>
674
722
  * <p>The list of packages is considered only if you set <code>packageCleanup</code> to
@@ -676,15 +724,18 @@ export interface InstanceProfile {
676
724
  */
677
725
  excludeAppPackagesFromCleanup?: string[];
678
726
  /**
727
+ * @public
679
728
  * <p>When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is
680
729
  * <code>true</code>.</p>
681
730
  */
682
731
  rebootAfterUse?: boolean;
683
732
  /**
733
+ * @public
684
734
  * <p>The name of the instance profile.</p>
685
735
  */
686
736
  name?: string;
687
737
  /**
738
+ * @public
688
739
  * <p>The description of the instance profile.</p>
689
740
  */
690
741
  description?: string;
@@ -694,6 +745,7 @@ export interface InstanceProfile {
694
745
  */
695
746
  export interface CreateInstanceProfileResult {
696
747
  /**
748
+ * @public
697
749
  * <p>An object that contains information about your instance profile.</p>
698
750
  */
699
751
  instanceProfile?: InstanceProfile;
@@ -715,58 +767,70 @@ export type NetworkProfileType = (typeof NetworkProfileType)[keyof typeof Networ
715
767
  */
716
768
  export interface CreateNetworkProfileRequest {
717
769
  /**
770
+ * @public
718
771
  * <p>The Amazon Resource Name (ARN) of the project for which you want to create a
719
772
  * network profile.</p>
720
773
  */
721
774
  projectArn: string | undefined;
722
775
  /**
776
+ * @public
723
777
  * <p>The name for the new network profile.</p>
724
778
  */
725
779
  name: string | undefined;
726
780
  /**
781
+ * @public
727
782
  * <p>The description of the network profile.</p>
728
783
  */
729
784
  description?: string;
730
785
  /**
786
+ * @public
731
787
  * <p>The type of network profile to create. Valid values are listed here.</p>
732
788
  */
733
789
  type?: NetworkProfileType | string;
734
790
  /**
791
+ * @public
735
792
  * <p>The data throughput rate in bits per second, as an integer from 0 to
736
793
  * 104857600.</p>
737
794
  */
738
795
  uplinkBandwidthBits?: number;
739
796
  /**
797
+ * @public
740
798
  * <p>The data throughput rate in bits per second, as an integer from 0 to
741
799
  * 104857600.</p>
742
800
  */
743
801
  downlinkBandwidthBits?: number;
744
802
  /**
803
+ * @public
745
804
  * <p>Delay time for all packets to destination in milliseconds as an integer from 0 to
746
805
  * 2000.</p>
747
806
  */
748
807
  uplinkDelayMs?: number;
749
808
  /**
809
+ * @public
750
810
  * <p>Delay time for all packets to destination in milliseconds as an integer from 0 to
751
811
  * 2000.</p>
752
812
  */
753
813
  downlinkDelayMs?: number;
754
814
  /**
815
+ * @public
755
816
  * <p>Time variation in the delay of received packets in milliseconds as an integer from
756
817
  * 0 to 2000.</p>
757
818
  */
758
819
  uplinkJitterMs?: number;
759
820
  /**
821
+ * @public
760
822
  * <p>Time variation in the delay of received packets in milliseconds as an integer from
761
823
  * 0 to 2000.</p>
762
824
  */
763
825
  downlinkJitterMs?: number;
764
826
  /**
827
+ * @public
765
828
  * <p>Proportion of transmitted packets that fail to arrive from 0 to 100
766
829
  * percent.</p>
767
830
  */
768
831
  uplinkLossPercent?: number;
769
832
  /**
833
+ * @public
770
834
  * <p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>
771
835
  */
772
836
  downlinkLossPercent?: number;
@@ -777,57 +841,69 @@ export interface CreateNetworkProfileRequest {
777
841
  */
778
842
  export interface NetworkProfile {
779
843
  /**
844
+ * @public
780
845
  * <p>The Amazon Resource Name (ARN) of the network profile.</p>
781
846
  */
782
847
  arn?: string;
783
848
  /**
849
+ * @public
784
850
  * <p>The name of the network profile.</p>
785
851
  */
786
852
  name?: string;
787
853
  /**
854
+ * @public
788
855
  * <p>The description of the network profile.</p>
789
856
  */
790
857
  description?: string;
791
858
  /**
859
+ * @public
792
860
  * <p>The type of network profile. Valid values are listed here.</p>
793
861
  */
794
862
  type?: NetworkProfileType | string;
795
863
  /**
864
+ * @public
796
865
  * <p>The data throughput rate in bits per second, as an integer from 0 to
797
866
  * 104857600.</p>
798
867
  */
799
868
  uplinkBandwidthBits?: number;
800
869
  /**
870
+ * @public
801
871
  * <p>The data throughput rate in bits per second, as an integer from 0 to
802
872
  * 104857600.</p>
803
873
  */
804
874
  downlinkBandwidthBits?: number;
805
875
  /**
876
+ * @public
806
877
  * <p>Delay time for all packets to destination in milliseconds as an integer from 0 to
807
878
  * 2000.</p>
808
879
  */
809
880
  uplinkDelayMs?: number;
810
881
  /**
882
+ * @public
811
883
  * <p>Delay time for all packets to destination in milliseconds as an integer from 0 to
812
884
  * 2000.</p>
813
885
  */
814
886
  downlinkDelayMs?: number;
815
887
  /**
888
+ * @public
816
889
  * <p>Time variation in the delay of received packets in milliseconds as an integer from
817
890
  * 0 to 2000.</p>
818
891
  */
819
892
  uplinkJitterMs?: number;
820
893
  /**
894
+ * @public
821
895
  * <p>Time variation in the delay of received packets in milliseconds as an integer from
822
896
  * 0 to 2000.</p>
823
897
  */
824
898
  downlinkJitterMs?: number;
825
899
  /**
900
+ * @public
826
901
  * <p>Proportion of transmitted packets that fail to arrive from 0 to 100
827
902
  * percent.</p>
828
903
  */
829
904
  uplinkLossPercent?: number;
830
905
  /**
906
+ * @public
831
907
  * <p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>
832
908
  */
833
909
  downlinkLossPercent?: number;
@@ -837,6 +913,7 @@ export interface NetworkProfile {
837
913
  */
838
914
  export interface CreateNetworkProfileResult {
839
915
  /**
916
+ * @public
840
917
  * <p>The network profile that is returned by the create network profile
841
918
  * request.</p>
842
919
  */
@@ -848,14 +925,17 @@ export interface CreateNetworkProfileResult {
848
925
  */
849
926
  export interface VpcConfig {
850
927
  /**
928
+ * @public
851
929
  * <p>An array of one or more security groups IDs in your Amazon VPC.</p>
852
930
  */
853
931
  securityGroupIds: string[] | undefined;
854
932
  /**
933
+ * @public
855
934
  * <p>An array of one or more subnet IDs in your Amazon VPC.</p>
856
935
  */
857
936
  subnetIds: string[] | undefined;
858
937
  /**
938
+ * @public
859
939
  * <p>The ID of the Amazon VPC.</p>
860
940
  */
861
941
  vpcId: string | undefined;
@@ -866,15 +946,18 @@ export interface VpcConfig {
866
946
  */
867
947
  export interface CreateProjectRequest {
868
948
  /**
949
+ * @public
869
950
  * <p>The project's name.</p>
870
951
  */
871
952
  name: string | undefined;
872
953
  /**
954
+ * @public
873
955
  * <p>Sets the execution timeout value (in minutes) for a project. All test runs in this project use the
874
956
  * specified execution timeout value unless overridden when scheduling a run.</p>
875
957
  */
876
958
  defaultJobTimeoutMinutes?: number;
877
959
  /**
960
+ * @public
878
961
  * <p>The VPC security groups and subnets that are attached to a project.</p>
879
962
  */
880
963
  vpcConfig?: VpcConfig;
@@ -886,23 +969,28 @@ export interface CreateProjectRequest {
886
969
  */
887
970
  export interface Project {
888
971
  /**
972
+ * @public
889
973
  * <p>The project's ARN.</p>
890
974
  */
891
975
  arn?: string;
892
976
  /**
977
+ * @public
893
978
  * <p>The project's name.</p>
894
979
  */
895
980
  name?: string;
896
981
  /**
982
+ * @public
897
983
  * <p>The default number of minutes (at the project level) a test run executes before it times out. The
898
984
  * default value is 150 minutes.</p>
899
985
  */
900
986
  defaultJobTimeoutMinutes?: number;
901
987
  /**
988
+ * @public
902
989
  * <p>When the project was created.</p>
903
990
  */
904
991
  created?: Date;
905
992
  /**
993
+ * @public
906
994
  * <p>The VPC security groups and subnets that are attached to a project.</p>
907
995
  */
908
996
  vpcConfig?: VpcConfig;
@@ -913,6 +1001,7 @@ export interface Project {
913
1001
  */
914
1002
  export interface CreateProjectResult {
915
1003
  /**
1004
+ * @public
916
1005
  * <p>The newly created project.</p>
917
1006
  */
918
1007
  project?: Project;
@@ -937,10 +1026,12 @@ export declare class TagOperationException extends __BaseException {
937
1026
  */
938
1027
  export interface CreateRemoteAccessSessionConfiguration {
939
1028
  /**
1029
+ * @public
940
1030
  * <p>The billing method for the remote access session.</p>
941
1031
  */
942
1032
  billingMethod?: BillingMethod | string;
943
1033
  /**
1034
+ * @public
944
1035
  * <p>An array of ARNs included in the VPC endpoint configuration.</p>
945
1036
  */
946
1037
  vpceConfigurationArns?: string[];
@@ -964,20 +1055,24 @@ export type InteractionMode = (typeof InteractionMode)[keyof typeof InteractionM
964
1055
  */
965
1056
  export interface CreateRemoteAccessSessionRequest {
966
1057
  /**
1058
+ * @public
967
1059
  * <p>The Amazon Resource Name (ARN) of the project for which you want to create a remote
968
1060
  * access session.</p>
969
1061
  */
970
1062
  projectArn: string | undefined;
971
1063
  /**
1064
+ * @public
972
1065
  * <p>The ARN of the device for which you want to create a remote access session.</p>
973
1066
  */
974
1067
  deviceArn: string | undefined;
975
1068
  /**
1069
+ * @public
976
1070
  * <p>The Amazon Resource Name (ARN) of the device instance for which you want to create a
977
1071
  * remote access session.</p>
978
1072
  */
979
1073
  instanceArn?: string;
980
1074
  /**
1075
+ * @public
981
1076
  * <p>Ignored. The public key of the <code>ssh</code> key pair you want to use for connecting to remote
982
1077
  * devices in your remote debugging session. This key is required only if <code>remoteDebugEnabled</code> is
983
1078
  * set to <code>true</code>.</p>
@@ -986,6 +1081,7 @@ export interface CreateRemoteAccessSessionRequest {
986
1081
  */
987
1082
  sshPublicKey?: string;
988
1083
  /**
1084
+ * @public
989
1085
  * <p>Set to <code>true</code> if you want to access devices remotely for debugging in
990
1086
  * your remote access session.</p>
991
1087
  * <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no
@@ -993,20 +1089,24 @@ export interface CreateRemoteAccessSessionRequest {
993
1089
  */
994
1090
  remoteDebugEnabled?: boolean;
995
1091
  /**
1092
+ * @public
996
1093
  * <p>Set to <code>true</code> to enable remote recording for the remote access
997
1094
  * session.</p>
998
1095
  */
999
1096
  remoteRecordEnabled?: boolean;
1000
1097
  /**
1098
+ * @public
1001
1099
  * <p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access
1002
1100
  * session.</p>
1003
1101
  */
1004
1102
  remoteRecordAppArn?: string;
1005
1103
  /**
1104
+ * @public
1006
1105
  * <p>The name of the remote access session to create.</p>
1007
1106
  */
1008
1107
  name?: string;
1009
1108
  /**
1109
+ * @public
1010
1110
  * <p>Unique identifier for the client. If you want access to multiple devices on the same client, you should
1011
1111
  * pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This
1012
1112
  * identifier is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p>
@@ -1015,10 +1115,12 @@ export interface CreateRemoteAccessSessionRequest {
1015
1115
  */
1016
1116
  clientId?: string;
1017
1117
  /**
1118
+ * @public
1018
1119
  * <p>The configuration information for the remote access session request.</p>
1019
1120
  */
1020
1121
  configuration?: CreateRemoteAccessSessionConfiguration;
1021
1122
  /**
1123
+ * @public
1022
1124
  * <p>The interaction mode of the remote access session. Valid values are:</p>
1023
1125
  * <ul>
1024
1126
  * <li>
@@ -1039,6 +1141,7 @@ export interface CreateRemoteAccessSessionRequest {
1039
1141
  */
1040
1142
  interactionMode?: InteractionMode | string;
1041
1143
  /**
1144
+ * @public
1042
1145
  * <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public
1043
1146
  * devices, Device Farm always signs your apps again.</p>
1044
1147
  * <p>For more information on how Device Farm modifies your uploads during tests, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a>
@@ -1092,26 +1195,32 @@ export type InstanceStatus = (typeof InstanceStatus)[keyof typeof InstanceStatus
1092
1195
  */
1093
1196
  export interface DeviceInstance {
1094
1197
  /**
1198
+ * @public
1095
1199
  * <p>The Amazon Resource Name (ARN) of the device instance.</p>
1096
1200
  */
1097
1201
  arn?: string;
1098
1202
  /**
1203
+ * @public
1099
1204
  * <p>The ARN of the device.</p>
1100
1205
  */
1101
1206
  deviceArn?: string;
1102
1207
  /**
1208
+ * @public
1103
1209
  * <p>An array of strings that describe the device instance.</p>
1104
1210
  */
1105
1211
  labels?: string[];
1106
1212
  /**
1213
+ * @public
1107
1214
  * <p>The status of the device instance. Valid values are listed here.</p>
1108
1215
  */
1109
1216
  status?: InstanceStatus | string;
1110
1217
  /**
1218
+ * @public
1111
1219
  * <p>Unique device identifier for the device instance.</p>
1112
1220
  */
1113
1221
  udid?: string;
1114
1222
  /**
1223
+ * @public
1115
1224
  * <p>A object that contains information about the instance profile.</p>
1116
1225
  */
1117
1226
  instanceProfile?: InstanceProfile;
@@ -1123,10 +1232,12 @@ export interface DeviceInstance {
1123
1232
  */
1124
1233
  export interface Resolution {
1125
1234
  /**
1235
+ * @public
1126
1236
  * <p>The screen resolution's width, expressed in pixels.</p>
1127
1237
  */
1128
1238
  width?: number;
1129
1239
  /**
1240
+ * @public
1130
1241
  * <p>The screen resolution's height, expressed in pixels.</p>
1131
1242
  */
1132
1243
  height?: number;
@@ -1137,26 +1248,32 @@ export interface Resolution {
1137
1248
  */
1138
1249
  export interface Device {
1139
1250
  /**
1251
+ * @public
1140
1252
  * <p>The device's ARN.</p>
1141
1253
  */
1142
1254
  arn?: string;
1143
1255
  /**
1256
+ * @public
1144
1257
  * <p>The device's display name.</p>
1145
1258
  */
1146
1259
  name?: string;
1147
1260
  /**
1261
+ * @public
1148
1262
  * <p>The device's manufacturer name.</p>
1149
1263
  */
1150
1264
  manufacturer?: string;
1151
1265
  /**
1266
+ * @public
1152
1267
  * <p>The device's model name.</p>
1153
1268
  */
1154
1269
  model?: string;
1155
1270
  /**
1271
+ * @public
1156
1272
  * <p>The device's model ID.</p>
1157
1273
  */
1158
1274
  modelId?: string;
1159
1275
  /**
1276
+ * @public
1160
1277
  * <p>The device's form factor.</p>
1161
1278
  * <p>Allowed values include:</p>
1162
1279
  * <ul>
@@ -1170,6 +1287,7 @@ export interface Device {
1170
1287
  */
1171
1288
  formFactor?: DeviceFormFactor | string;
1172
1289
  /**
1290
+ * @public
1173
1291
  * <p>The device's platform.</p>
1174
1292
  * <p>Allowed values include:</p>
1175
1293
  * <ul>
@@ -1183,43 +1301,53 @@ export interface Device {
1183
1301
  */
1184
1302
  platform?: DevicePlatform | string;
1185
1303
  /**
1304
+ * @public
1186
1305
  * <p>The device's operating system type.</p>
1187
1306
  */
1188
1307
  os?: string;
1189
1308
  /**
1309
+ * @public
1190
1310
  * <p>Information about the device's CPU.</p>
1191
1311
  */
1192
1312
  cpu?: CPU;
1193
1313
  /**
1314
+ * @public
1194
1315
  * <p>The resolution of the device.</p>
1195
1316
  */
1196
1317
  resolution?: Resolution;
1197
1318
  /**
1319
+ * @public
1198
1320
  * <p>The device's heap size, expressed in bytes.</p>
1199
1321
  */
1200
1322
  heapSize?: number;
1201
1323
  /**
1324
+ * @public
1202
1325
  * <p>The device's total memory size, expressed in bytes.</p>
1203
1326
  */
1204
1327
  memory?: number;
1205
1328
  /**
1329
+ * @public
1206
1330
  * <p>The device's image name.</p>
1207
1331
  */
1208
1332
  image?: string;
1209
1333
  /**
1334
+ * @public
1210
1335
  * <p>The device's carrier.</p>
1211
1336
  */
1212
1337
  carrier?: string;
1213
1338
  /**
1339
+ * @public
1214
1340
  * <p>The device's radio.</p>
1215
1341
  */
1216
1342
  radio?: string;
1217
1343
  /**
1344
+ * @public
1218
1345
  * <p>Specifies whether remote access has been enabled for the specified
1219
1346
  * device.</p>
1220
1347
  */
1221
1348
  remoteAccessEnabled?: boolean;
1222
1349
  /**
1350
+ * @public
1223
1351
  * <p>This flag is set to <code>true</code> if remote debugging is enabled for the
1224
1352
  * device.</p>
1225
1353
  * <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no
@@ -1227,18 +1355,22 @@ export interface Device {
1227
1355
  */
1228
1356
  remoteDebugEnabled?: boolean;
1229
1357
  /**
1358
+ * @public
1230
1359
  * <p>The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.</p>
1231
1360
  */
1232
1361
  fleetType?: string;
1233
1362
  /**
1363
+ * @public
1234
1364
  * <p>The name of the fleet to which this device belongs.</p>
1235
1365
  */
1236
1366
  fleetName?: string;
1237
1367
  /**
1368
+ * @public
1238
1369
  * <p>The instances that belong to this device.</p>
1239
1370
  */
1240
1371
  instances?: DeviceInstance[];
1241
1372
  /**
1373
+ * @public
1242
1374
  * <p>Indicates how likely a device is available for a test run. Currently available in the <a>ListDevices</a> and GetDevice API methods.</p>
1243
1375
  */
1244
1376
  availability?: DeviceAvailability | string;
@@ -1250,16 +1382,19 @@ export interface Device {
1250
1382
  */
1251
1383
  export interface DeviceMinutes {
1252
1384
  /**
1385
+ * @public
1253
1386
  * <p>When specified, represents the total minutes used by the resource to run
1254
1387
  * tests.</p>
1255
1388
  */
1256
1389
  total?: number;
1257
1390
  /**
1391
+ * @public
1258
1392
  * <p>When specified, represents only the sum of metered minutes used by the resource to
1259
1393
  * run tests.</p>
1260
1394
  */
1261
1395
  metered?: number;
1262
1396
  /**
1397
+ * @public
1263
1398
  * <p>When specified, represents only the sum of unmetered minutes used by the resource
1264
1399
  * to run tests.</p>
1265
1400
  */
@@ -1307,18 +1442,22 @@ export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionSta
1307
1442
  */
1308
1443
  export interface RemoteAccessSession {
1309
1444
  /**
1445
+ * @public
1310
1446
  * <p>The Amazon Resource Name (ARN) of the remote access session.</p>
1311
1447
  */
1312
1448
  arn?: string;
1313
1449
  /**
1450
+ * @public
1314
1451
  * <p>The name of the remote access session.</p>
1315
1452
  */
1316
1453
  name?: string;
1317
1454
  /**
1455
+ * @public
1318
1456
  * <p>The date and time the remote access session was created.</p>
1319
1457
  */
1320
1458
  created?: Date;
1321
1459
  /**
1460
+ * @public
1322
1461
  * <p>The status of the remote access session. Can be any of the following:</p>
1323
1462
  * <ul>
1324
1463
  * <li>
@@ -1352,6 +1491,7 @@ export interface RemoteAccessSession {
1352
1491
  */
1353
1492
  status?: ExecutionStatus | string;
1354
1493
  /**
1494
+ * @public
1355
1495
  * <p>The result of the remote access session. Can be any of the following:</p>
1356
1496
  * <ul>
1357
1497
  * <li>
@@ -1379,26 +1519,32 @@ export interface RemoteAccessSession {
1379
1519
  */
1380
1520
  result?: ExecutionResult | string;
1381
1521
  /**
1522
+ * @public
1382
1523
  * <p>A message about the remote access session.</p>
1383
1524
  */
1384
1525
  message?: string;
1385
1526
  /**
1527
+ * @public
1386
1528
  * <p>The date and time the remote access session was started.</p>
1387
1529
  */
1388
1530
  started?: Date;
1389
1531
  /**
1532
+ * @public
1390
1533
  * <p>The date and time the remote access session was stopped.</p>
1391
1534
  */
1392
1535
  stopped?: Date;
1393
1536
  /**
1537
+ * @public
1394
1538
  * <p>The device (phone or tablet) used in the remote access session.</p>
1395
1539
  */
1396
1540
  device?: Device;
1397
1541
  /**
1542
+ * @public
1398
1543
  * <p>The ARN of the instance.</p>
1399
1544
  */
1400
1545
  instanceArn?: string;
1401
1546
  /**
1547
+ * @public
1402
1548
  * <p>This flag is set to <code>true</code> if remote debugging is enabled for the remote
1403
1549
  * access session.</p>
1404
1550
  * <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no
@@ -1406,15 +1552,18 @@ export interface RemoteAccessSession {
1406
1552
  */
1407
1553
  remoteDebugEnabled?: boolean;
1408
1554
  /**
1555
+ * @public
1409
1556
  * <p>This flag is set to <code>true</code> if remote recording is enabled for the remote
1410
1557
  * access session.</p>
1411
1558
  */
1412
1559
  remoteRecordEnabled?: boolean;
1413
1560
  /**
1561
+ * @public
1414
1562
  * <p>The ARN for the app to be recorded in the remote access session.</p>
1415
1563
  */
1416
1564
  remoteRecordAppArn?: string;
1417
1565
  /**
1566
+ * @public
1418
1567
  * <p>IP address of the EC2 host where you need to connect to remotely debug devices.
1419
1568
  * Only returned if remote debugging is enabled for the remote access session.</p>
1420
1569
  * <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no
@@ -1422,6 +1571,7 @@ export interface RemoteAccessSession {
1422
1571
  */
1423
1572
  hostAddress?: string;
1424
1573
  /**
1574
+ * @public
1425
1575
  * <p>Unique identifier of your client for the remote access session. Only returned if
1426
1576
  * remote debugging is enabled for the remote access session.</p>
1427
1577
  * <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no
@@ -1429,21 +1579,25 @@ export interface RemoteAccessSession {
1429
1579
  */
1430
1580
  clientId?: string;
1431
1581
  /**
1582
+ * @public
1432
1583
  * <p>The billing method of the remote access session. Possible values include <code>METERED</code> or
1433
1584
  * <code>UNMETERED</code>. For more information about metered devices, see <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology">AWS Device Farm
1434
1585
  * terminology</a>.</p>
1435
1586
  */
1436
1587
  billingMethod?: BillingMethod | string;
1437
1588
  /**
1589
+ * @public
1438
1590
  * <p>The number of minutes a device is used in a remote access session (including setup
1439
1591
  * and teardown minutes).</p>
1440
1592
  */
1441
1593
  deviceMinutes?: DeviceMinutes;
1442
1594
  /**
1595
+ * @public
1443
1596
  * <p>The endpoint for the remote access sesssion.</p>
1444
1597
  */
1445
1598
  endpoint?: string;
1446
1599
  /**
1600
+ * @public
1447
1601
  * <p>Unique device identifier for the remote device. Only returned if remote debugging
1448
1602
  * is enabled for the remote access session.</p>
1449
1603
  * <p>Remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no
@@ -1451,6 +1605,7 @@ export interface RemoteAccessSession {
1451
1605
  */
1452
1606
  deviceUdid?: string;
1453
1607
  /**
1608
+ * @public
1454
1609
  * <p>The interaction mode of the remote access session. Valid values are:</p>
1455
1610
  * <ul>
1456
1611
  * <li>
@@ -1471,6 +1626,7 @@ export interface RemoteAccessSession {
1471
1626
  */
1472
1627
  interactionMode?: InteractionMode | string;
1473
1628
  /**
1629
+ * @public
1474
1630
  * <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public
1475
1631
  * devices, Device Farm always signs your apps again.</p>
1476
1632
  * <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device
@@ -1478,6 +1634,7 @@ export interface RemoteAccessSession {
1478
1634
  */
1479
1635
  skipAppResign?: boolean;
1480
1636
  /**
1637
+ * @public
1481
1638
  * <p>The VPC security groups and subnets that are attached to a project.</p>
1482
1639
  */
1483
1640
  vpcConfig?: VpcConfig;
@@ -1489,6 +1646,7 @@ export interface RemoteAccessSession {
1489
1646
  */
1490
1647
  export interface CreateRemoteAccessSessionResult {
1491
1648
  /**
1649
+ * @public
1492
1650
  * <p>A container that describes the remote access session when the request to create a
1493
1651
  * remote access session is sent.</p>
1494
1652
  */
@@ -1500,14 +1658,17 @@ export interface CreateRemoteAccessSessionResult {
1500
1658
  */
1501
1659
  export interface TestGridVpcConfig {
1502
1660
  /**
1661
+ * @public
1503
1662
  * <p>A list of VPC security group IDs in your Amazon VPC.</p>
1504
1663
  */
1505
1664
  securityGroupIds: string[] | undefined;
1506
1665
  /**
1666
+ * @public
1507
1667
  * <p>A list of VPC subnet IDs in your Amazon VPC.</p>
1508
1668
  */
1509
1669
  subnetIds: string[] | undefined;
1510
1670
  /**
1671
+ * @public
1511
1672
  * <p>The ID of the Amazon VPC.</p>
1512
1673
  */
1513
1674
  vpcId: string | undefined;
@@ -1517,14 +1678,17 @@ export interface TestGridVpcConfig {
1517
1678
  */
1518
1679
  export interface CreateTestGridProjectRequest {
1519
1680
  /**
1681
+ * @public
1520
1682
  * <p>Human-readable name of the Selenium testing project.</p>
1521
1683
  */
1522
1684
  name: string | undefined;
1523
1685
  /**
1686
+ * @public
1524
1687
  * <p>Human-readable description of the project.</p>
1525
1688
  */
1526
1689
  description?: string;
1527
1690
  /**
1691
+ * @public
1528
1692
  * <p>The VPC security groups and subnets that are attached to a project.</p>
1529
1693
  */
1530
1694
  vpcConfig?: TestGridVpcConfig;
@@ -1535,22 +1699,27 @@ export interface CreateTestGridProjectRequest {
1535
1699
  */
1536
1700
  export interface TestGridProject {
1537
1701
  /**
1702
+ * @public
1538
1703
  * <p>The ARN for the project.</p>
1539
1704
  */
1540
1705
  arn?: string;
1541
1706
  /**
1707
+ * @public
1542
1708
  * <p>A human-readable name for the project.</p>
1543
1709
  */
1544
1710
  name?: string;
1545
1711
  /**
1712
+ * @public
1546
1713
  * <p>A human-readable description for the project.</p>
1547
1714
  */
1548
1715
  description?: string;
1549
1716
  /**
1717
+ * @public
1550
1718
  * <p>The VPC security groups and subnets that are attached to a project.</p>
1551
1719
  */
1552
1720
  vpcConfig?: TestGridVpcConfig;
1553
1721
  /**
1722
+ * @public
1554
1723
  * <p>When the project was created.</p>
1555
1724
  */
1556
1725
  created?: Date;
@@ -1560,6 +1729,7 @@ export interface TestGridProject {
1560
1729
  */
1561
1730
  export interface CreateTestGridProjectResult {
1562
1731
  /**
1732
+ * @public
1563
1733
  * <p>ARN of the Selenium testing project that was created.</p>
1564
1734
  */
1565
1735
  testGridProject?: TestGridProject;
@@ -1582,11 +1752,13 @@ export declare class InternalServiceException extends __BaseException {
1582
1752
  */
1583
1753
  export interface CreateTestGridUrlRequest {
1584
1754
  /**
1755
+ * @public
1585
1756
  * <p>ARN (from <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>) to associate
1586
1757
  * with the short-term URL. </p>
1587
1758
  */
1588
1759
  projectArn: string | undefined;
1589
1760
  /**
1761
+ * @public
1590
1762
  * <p>Lifetime, in seconds, of the URL.</p>
1591
1763
  */
1592
1764
  expiresInSeconds: number | undefined;
@@ -1596,11 +1768,13 @@ export interface CreateTestGridUrlRequest {
1596
1768
  */
1597
1769
  export interface CreateTestGridUrlResult {
1598
1770
  /**
1771
+ * @public
1599
1772
  * <p>A signed URL, expiring in <a>CreateTestGridUrlRequest$expiresInSeconds</a> seconds, to be passed
1600
1773
  * to a <code>RemoteWebDriver</code>. </p>
1601
1774
  */
1602
1775
  url?: string;
1603
1776
  /**
1777
+ * @public
1604
1778
  * <p>The number of seconds the URL from <a>CreateTestGridUrlResult$url</a> stays active.</p>
1605
1779
  */
1606
1780
  expires?: Date;
@@ -1653,10 +1827,12 @@ export type UploadType = (typeof UploadType)[keyof typeof UploadType];
1653
1827
  */
1654
1828
  export interface CreateUploadRequest {
1655
1829
  /**
1830
+ * @public
1656
1831
  * <p>The ARN of the project for the upload.</p>
1657
1832
  */
1658
1833
  projectArn: string | undefined;
1659
1834
  /**
1835
+ * @public
1660
1836
  * <p>The upload's file name. The name should not contain any forward slashes (<code>/</code>). If you are
1661
1837
  * uploading an iOS app, the file name must end with the <code>.ipa</code> extension. If you are uploading an
1662
1838
  * Android app, the file name must end with the <code>.apk</code> extension. For all others, the file name must
@@ -1664,6 +1840,7 @@ export interface CreateUploadRequest {
1664
1840
  */
1665
1841
  name: string | undefined;
1666
1842
  /**
1843
+ * @public
1667
1844
  * <p>The upload's upload type.</p>
1668
1845
  * <p>Must be one of the following values:</p>
1669
1846
  * <ul>
@@ -1769,6 +1946,7 @@ export interface CreateUploadRequest {
1769
1946
  */
1770
1947
  type: UploadType | string | undefined;
1771
1948
  /**
1949
+ * @public
1772
1950
  * <p>The upload's content type (for example, <code>application/octet-stream</code>).</p>
1773
1951
  */
1774
1952
  contentType?: string;
@@ -1806,18 +1984,22 @@ export type UploadStatus = (typeof UploadStatus)[keyof typeof UploadStatus];
1806
1984
  */
1807
1985
  export interface Upload {
1808
1986
  /**
1987
+ * @public
1809
1988
  * <p>The upload's ARN.</p>
1810
1989
  */
1811
1990
  arn?: string;
1812
1991
  /**
1992
+ * @public
1813
1993
  * <p>The upload's file name.</p>
1814
1994
  */
1815
1995
  name?: string;
1816
1996
  /**
1997
+ * @public
1817
1998
  * <p>When the upload was created.</p>
1818
1999
  */
1819
2000
  created?: Date;
1820
2001
  /**
2002
+ * @public
1821
2003
  * <p>The upload's type.</p>
1822
2004
  * <p>Must be one of the following values:</p>
1823
2005
  * <ul>
@@ -1921,6 +2103,7 @@ export interface Upload {
1921
2103
  */
1922
2104
  type?: UploadType | string;
1923
2105
  /**
2106
+ * @public
1924
2107
  * <p>The upload's status.</p>
1925
2108
  * <p>Must be one of the following values:</p>
1926
2109
  * <ul>
@@ -1940,24 +2123,29 @@ export interface Upload {
1940
2123
  */
1941
2124
  status?: UploadStatus | string;
1942
2125
  /**
2126
+ * @public
1943
2127
  * <p>The presigned Amazon S3 URL that was used to store a file using a PUT request.</p>
1944
2128
  */
1945
2129
  url?: string;
1946
2130
  /**
2131
+ * @public
1947
2132
  * <p>The upload's metadata. For example, for Android, this contains information that is
1948
2133
  * parsed from the manifest and is displayed in the AWS Device Farm console after the
1949
2134
  * associated app is uploaded.</p>
1950
2135
  */
1951
2136
  metadata?: string;
1952
2137
  /**
2138
+ * @public
1953
2139
  * <p>The upload's content type (for example, <code>application/octet-stream</code>).</p>
1954
2140
  */
1955
2141
  contentType?: string;
1956
2142
  /**
2143
+ * @public
1957
2144
  * <p>A message about the upload's result.</p>
1958
2145
  */
1959
2146
  message?: string;
1960
2147
  /**
2148
+ * @public
1961
2149
  * <p>The upload's category. Allowed values include:</p>
1962
2150
  * <ul>
1963
2151
  * <li>
@@ -1976,6 +2164,7 @@ export interface Upload {
1976
2164
  */
1977
2165
  export interface CreateUploadResult {
1978
2166
  /**
2167
+ * @public
1979
2168
  * <p>The newly created upload.</p>
1980
2169
  */
1981
2170
  upload?: Upload;
@@ -1985,20 +2174,24 @@ export interface CreateUploadResult {
1985
2174
  */
1986
2175
  export interface CreateVPCEConfigurationRequest {
1987
2176
  /**
2177
+ * @public
1988
2178
  * <p>The friendly name you give to your VPC endpoint configuration, to manage your
1989
2179
  * configurations more easily.</p>
1990
2180
  */
1991
2181
  vpceConfigurationName: string | undefined;
1992
2182
  /**
2183
+ * @public
1993
2184
  * <p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>
1994
2185
  */
1995
2186
  vpceServiceName: string | undefined;
1996
2187
  /**
2188
+ * @public
1997
2189
  * <p>The DNS name of the service running in your VPC that you want Device Farm to
1998
2190
  * test.</p>
1999
2191
  */
2000
2192
  serviceDnsName: string | undefined;
2001
2193
  /**
2194
+ * @public
2002
2195
  * <p>An optional description that provides details about your VPC endpoint configuration.</p>
2003
2196
  */
2004
2197
  vpceConfigurationDescription?: string;
@@ -2009,24 +2202,29 @@ export interface CreateVPCEConfigurationRequest {
2009
2202
  */
2010
2203
  export interface VPCEConfiguration {
2011
2204
  /**
2205
+ * @public
2012
2206
  * <p>The Amazon Resource Name (ARN) of the VPC endpoint configuration.</p>
2013
2207
  */
2014
2208
  arn?: string;
2015
2209
  /**
2210
+ * @public
2016
2211
  * <p>The friendly name you give to your VPC endpoint configuration to manage your configurations more
2017
2212
  * easily.</p>
2018
2213
  */
2019
2214
  vpceConfigurationName?: string;
2020
2215
  /**
2216
+ * @public
2021
2217
  * <p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>
2022
2218
  */
2023
2219
  vpceServiceName?: string;
2024
2220
  /**
2221
+ * @public
2025
2222
  * <p>The DNS name that maps to the private IP address of the service you want to
2026
2223
  * access.</p>
2027
2224
  */
2028
2225
  serviceDnsName?: string;
2029
2226
  /**
2227
+ * @public
2030
2228
  * <p>An optional description that provides details about your VPC endpoint configuration.</p>
2031
2229
  */
2032
2230
  vpceConfigurationDescription?: string;
@@ -2036,6 +2234,7 @@ export interface VPCEConfiguration {
2036
2234
  */
2037
2235
  export interface CreateVPCEConfigurationResult {
2038
2236
  /**
2237
+ * @public
2039
2238
  * <p>An object that contains information about your VPC endpoint configuration.</p>
2040
2239
  */
2041
2240
  vpceConfiguration?: VPCEConfiguration;
@@ -2062,16 +2261,19 @@ export type CurrencyCode = (typeof CurrencyCode)[keyof typeof CurrencyCode];
2062
2261
  */
2063
2262
  export interface CustomerArtifactPaths {
2064
2263
  /**
2264
+ * @public
2065
2265
  * <p>Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests
2066
2266
  * are pulled from.</p>
2067
2267
  */
2068
2268
  iosPaths?: string[];
2069
2269
  /**
2270
+ * @public
2070
2271
  * <p>Comma-separated list of paths on the Android device where the artifacts generated by the customer's
2071
2272
  * tests are pulled from.</p>
2072
2273
  */
2073
2274
  androidPaths?: string[];
2074
2275
  /**
2276
+ * @public
2075
2277
  * <p>Comma-separated list of paths in the test execution environment where the artifacts generated by the
2076
2278
  * customer's tests are pulled from.</p>
2077
2279
  */
@@ -2083,6 +2285,7 @@ export interface CustomerArtifactPaths {
2083
2285
  */
2084
2286
  export interface DeleteDevicePoolRequest {
2085
2287
  /**
2288
+ * @public
2086
2289
  * <p>Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.</p>
2087
2290
  */
2088
2291
  arn: string | undefined;
@@ -2098,6 +2301,7 @@ export interface DeleteDevicePoolResult {
2098
2301
  */
2099
2302
  export interface DeleteInstanceProfileRequest {
2100
2303
  /**
2304
+ * @public
2101
2305
  * <p>The Amazon Resource Name (ARN) of the instance profile you are requesting to
2102
2306
  * delete.</p>
2103
2307
  */
@@ -2113,6 +2317,7 @@ export interface DeleteInstanceProfileResult {
2113
2317
  */
2114
2318
  export interface DeleteNetworkProfileRequest {
2115
2319
  /**
2320
+ * @public
2116
2321
  * <p>The ARN of the network profile to delete.</p>
2117
2322
  */
2118
2323
  arn: string | undefined;
@@ -2128,6 +2333,7 @@ export interface DeleteNetworkProfileResult {
2128
2333
  */
2129
2334
  export interface DeleteProjectRequest {
2130
2335
  /**
2336
+ * @public
2131
2337
  * <p>Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.</p>
2132
2338
  */
2133
2339
  arn: string | undefined;
@@ -2144,6 +2350,7 @@ export interface DeleteProjectResult {
2144
2350
  */
2145
2351
  export interface DeleteRemoteAccessSessionRequest {
2146
2352
  /**
2353
+ * @public
2147
2354
  * <p>The Amazon Resource Name (ARN) of the session for which you want to delete remote
2148
2355
  * access.</p>
2149
2356
  */
@@ -2162,6 +2369,7 @@ export interface DeleteRemoteAccessSessionResult {
2162
2369
  */
2163
2370
  export interface DeleteRunRequest {
2164
2371
  /**
2372
+ * @public
2165
2373
  * <p>The Amazon Resource Name (ARN) for the run to delete.</p>
2166
2374
  */
2167
2375
  arn: string | undefined;
@@ -2177,6 +2385,7 @@ export interface DeleteRunResult {
2177
2385
  */
2178
2386
  export interface DeleteTestGridProjectRequest {
2179
2387
  /**
2388
+ * @public
2180
2389
  * <p>The ARN of the project to delete, from <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>.</p>
2181
2390
  */
2182
2391
  projectArn: string | undefined;
@@ -2192,6 +2401,7 @@ export interface DeleteTestGridProjectResult {
2192
2401
  */
2193
2402
  export interface DeleteUploadRequest {
2194
2403
  /**
2404
+ * @public
2195
2405
  * <p>Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.</p>
2196
2406
  */
2197
2407
  arn: string | undefined;
@@ -2207,6 +2417,7 @@ export interface DeleteUploadResult {
2207
2417
  */
2208
2418
  export interface DeleteVPCEConfigurationRequest {
2209
2419
  /**
2420
+ * @public
2210
2421
  * <p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
2211
2422
  * delete.</p>
2212
2423
  */
@@ -2243,6 +2454,7 @@ export interface GetAccountSettingsRequest {
2243
2454
  */
2244
2455
  export interface GetAccountSettingsResult {
2245
2456
  /**
2457
+ * @public
2246
2458
  * <p>The account settings.</p>
2247
2459
  */
2248
2460
  accountSettings?: AccountSettings;
@@ -2253,6 +2465,7 @@ export interface GetAccountSettingsResult {
2253
2465
  */
2254
2466
  export interface GetDeviceRequest {
2255
2467
  /**
2468
+ * @public
2256
2469
  * <p>The device type's ARN.</p>
2257
2470
  */
2258
2471
  arn: string | undefined;
@@ -2263,6 +2476,7 @@ export interface GetDeviceRequest {
2263
2476
  */
2264
2477
  export interface GetDeviceResult {
2265
2478
  /**
2479
+ * @public
2266
2480
  * <p>An object that contains information about the requested device.</p>
2267
2481
  */
2268
2482
  device?: Device;
@@ -2272,6 +2486,7 @@ export interface GetDeviceResult {
2272
2486
  */
2273
2487
  export interface GetDeviceInstanceRequest {
2274
2488
  /**
2489
+ * @public
2275
2490
  * <p>The Amazon Resource Name (ARN) of the instance you're requesting information
2276
2491
  * about.</p>
2277
2492
  */
@@ -2282,6 +2497,7 @@ export interface GetDeviceInstanceRequest {
2282
2497
  */
2283
2498
  export interface GetDeviceInstanceResult {
2284
2499
  /**
2500
+ * @public
2285
2501
  * <p>An object that contains information about your device instance.</p>
2286
2502
  */
2287
2503
  deviceInstance?: DeviceInstance;
@@ -2292,6 +2508,7 @@ export interface GetDeviceInstanceResult {
2292
2508
  */
2293
2509
  export interface GetDevicePoolRequest {
2294
2510
  /**
2511
+ * @public
2295
2512
  * <p>The device pool's ARN.</p>
2296
2513
  */
2297
2514
  arn: string | undefined;
@@ -2302,6 +2519,7 @@ export interface GetDevicePoolRequest {
2302
2519
  */
2303
2520
  export interface GetDevicePoolResult {
2304
2521
  /**
2522
+ * @public
2305
2523
  * <p>An object that contains information about the requested device pool.</p>
2306
2524
  */
2307
2525
  devicePool?: DevicePool;
@@ -2314,10 +2532,12 @@ export interface GetDevicePoolResult {
2314
2532
  */
2315
2533
  export interface Location {
2316
2534
  /**
2535
+ * @public
2317
2536
  * <p>The latitude.</p>
2318
2537
  */
2319
2538
  latitude: number | undefined;
2320
2539
  /**
2540
+ * @public
2321
2541
  * <p>The longitude.</p>
2322
2542
  */
2323
2543
  longitude: number | undefined;
@@ -2329,18 +2549,22 @@ export interface Location {
2329
2549
  */
2330
2550
  export interface Radios {
2331
2551
  /**
2552
+ * @public
2332
2553
  * <p>True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.</p>
2333
2554
  */
2334
2555
  wifi?: boolean;
2335
2556
  /**
2557
+ * @public
2336
2558
  * <p>True if Bluetooth is enabled at the beginning of the test. Otherwise, false.</p>
2337
2559
  */
2338
2560
  bluetooth?: boolean;
2339
2561
  /**
2562
+ * @public
2340
2563
  * <p>True if NFC is enabled at the beginning of the test. Otherwise, false.</p>
2341
2564
  */
2342
2565
  nfc?: boolean;
2343
2566
  /**
2567
+ * @public
2344
2568
  * <p>True if GPS is enabled at the beginning of the test. Otherwise, false.</p>
2345
2569
  */
2346
2570
  gps?: boolean;
@@ -2352,40 +2576,49 @@ export interface Radios {
2352
2576
  */
2353
2577
  export interface ScheduleRunConfiguration {
2354
2578
  /**
2579
+ * @public
2355
2580
  * <p>The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to
2356
2581
  * external data for Android or the app's sandbox for iOS.</p>
2357
2582
  */
2358
2583
  extraDataPackageArn?: string;
2359
2584
  /**
2585
+ * @public
2360
2586
  * <p>Reserved for internal use.</p>
2361
2587
  */
2362
2588
  networkProfileArn?: string;
2363
2589
  /**
2590
+ * @public
2364
2591
  * <p>Information about the locale that is used for the run.</p>
2365
2592
  */
2366
2593
  locale?: string;
2367
2594
  /**
2595
+ * @public
2368
2596
  * <p>Information about the location that is used for the run.</p>
2369
2597
  */
2370
2598
  location?: Location;
2371
2599
  /**
2600
+ * @public
2372
2601
  * <p>An array of ARNs for your VPC endpoint configurations.</p>
2373
2602
  */
2374
2603
  vpceConfigurationArns?: string[];
2375
2604
  /**
2605
+ * @public
2376
2606
  * <p>Input <code>CustomerArtifactPaths</code> object for the scheduled run
2377
2607
  * configuration.</p>
2378
2608
  */
2379
2609
  customerArtifactPaths?: CustomerArtifactPaths;
2380
2610
  /**
2611
+ * @public
2381
2612
  * <p>Information about the radio states for the run.</p>
2382
2613
  */
2383
2614
  radios?: Radios;
2384
2615
  /**
2616
+ * @public
2385
2617
  * <p>A list of upload ARNs for app packages to be installed with your app.</p>
2386
2618
  */
2387
2619
  auxiliaryApps?: string[];
2388
2620
  /**
2621
+ * @public
2389
2622
  * <p>Specifies the billing method for a test run: <code>metered</code> or
2390
2623
  * <code>unmetered</code>. If the parameter is not specified, the default value is
2391
2624
  * <code>metered</code>.</p>
@@ -2434,6 +2667,7 @@ export type TestType = (typeof TestType)[keyof typeof TestType];
2434
2667
  */
2435
2668
  export interface ScheduleRunTest {
2436
2669
  /**
2670
+ * @public
2437
2671
  * <p>The test's type.</p>
2438
2672
  * <p>Must be one of the following values:</p>
2439
2673
  * <ul>
@@ -2497,18 +2731,22 @@ export interface ScheduleRunTest {
2497
2731
  */
2498
2732
  type: TestType | string | undefined;
2499
2733
  /**
2734
+ * @public
2500
2735
  * <p>The ARN of the uploaded test to be run.</p>
2501
2736
  */
2502
2737
  testPackageArn?: string;
2503
2738
  /**
2739
+ * @public
2504
2740
  * <p>The ARN of the YAML-formatted test specification.</p>
2505
2741
  */
2506
2742
  testSpecArn?: string;
2507
2743
  /**
2744
+ * @public
2508
2745
  * <p>The test's filter.</p>
2509
2746
  */
2510
2747
  filter?: string;
2511
2748
  /**
2749
+ * @public
2512
2750
  * <p>The test's parameters, such as test framework parameters and fixture settings.
2513
2751
  * Parameters are represented by name-value pairs of strings.</p>
2514
2752
  * <p>For all tests:</p>
@@ -2653,14 +2891,17 @@ export interface ScheduleRunTest {
2653
2891
  */
2654
2892
  export interface GetDevicePoolCompatibilityRequest {
2655
2893
  /**
2894
+ * @public
2656
2895
  * <p>The device pool's ARN.</p>
2657
2896
  */
2658
2897
  devicePoolArn: string | undefined;
2659
2898
  /**
2899
+ * @public
2660
2900
  * <p>The ARN of the app that is associated with the specified device pool.</p>
2661
2901
  */
2662
2902
  appArn?: string;
2663
2903
  /**
2904
+ * @public
2664
2905
  * <p>The test type for the specified device pool.</p>
2665
2906
  * <p>Allowed values include the following:</p>
2666
2907
  * <ul>
@@ -2723,10 +2964,12 @@ export interface GetDevicePoolCompatibilityRequest {
2723
2964
  */
2724
2965
  testType?: TestType | string;
2725
2966
  /**
2967
+ * @public
2726
2968
  * <p>Information about the uploaded test to be run against the device pool.</p>
2727
2969
  */
2728
2970
  test?: ScheduleRunTest;
2729
2971
  /**
2972
+ * @public
2730
2973
  * <p>An object that contains information about the settings for a run.</p>
2731
2974
  */
2732
2975
  configuration?: ScheduleRunConfiguration;
@@ -2737,10 +2980,12 @@ export interface GetDevicePoolCompatibilityRequest {
2737
2980
  */
2738
2981
  export interface IncompatibilityMessage {
2739
2982
  /**
2983
+ * @public
2740
2984
  * <p>A message about the incompatibility.</p>
2741
2985
  */
2742
2986
  message?: string;
2743
2987
  /**
2988
+ * @public
2744
2989
  * <p>The type of incompatibility.</p>
2745
2990
  * <p>Allowed values include:</p>
2746
2991
  * <ul>
@@ -2772,14 +3017,17 @@ export interface IncompatibilityMessage {
2772
3017
  */
2773
3018
  export interface DevicePoolCompatibilityResult {
2774
3019
  /**
3020
+ * @public
2775
3021
  * <p>The device (phone or tablet) to return information about.</p>
2776
3022
  */
2777
3023
  device?: Device;
2778
3024
  /**
3025
+ * @public
2779
3026
  * <p>Whether the result was compatible with the device pool.</p>
2780
3027
  */
2781
3028
  compatible?: boolean;
2782
3029
  /**
3030
+ * @public
2783
3031
  * <p>Information about the compatibility.</p>
2784
3032
  */
2785
3033
  incompatibilityMessages?: IncompatibilityMessage[];
@@ -2790,10 +3038,12 @@ export interface DevicePoolCompatibilityResult {
2790
3038
  */
2791
3039
  export interface GetDevicePoolCompatibilityResult {
2792
3040
  /**
3041
+ * @public
2793
3042
  * <p>Information about compatible devices.</p>
2794
3043
  */
2795
3044
  compatibleDevices?: DevicePoolCompatibilityResult[];
2796
3045
  /**
3046
+ * @public
2797
3047
  * <p>Information about incompatible devices.</p>
2798
3048
  */
2799
3049
  incompatibleDevices?: DevicePoolCompatibilityResult[];
@@ -2803,6 +3053,7 @@ export interface GetDevicePoolCompatibilityResult {
2803
3053
  */
2804
3054
  export interface GetInstanceProfileRequest {
2805
3055
  /**
3056
+ * @public
2806
3057
  * <p>The Amazon Resource Name (ARN) of an instance profile.</p>
2807
3058
  */
2808
3059
  arn: string | undefined;
@@ -2812,6 +3063,7 @@ export interface GetInstanceProfileRequest {
2812
3063
  */
2813
3064
  export interface GetInstanceProfileResult {
2814
3065
  /**
3066
+ * @public
2815
3067
  * <p>An object that contains information about an instance profile.</p>
2816
3068
  */
2817
3069
  instanceProfile?: InstanceProfile;
@@ -2822,6 +3074,7 @@ export interface GetInstanceProfileResult {
2822
3074
  */
2823
3075
  export interface GetJobRequest {
2824
3076
  /**
3077
+ * @public
2825
3078
  * <p>The job's ARN.</p>
2826
3079
  */
2827
3080
  arn: string | undefined;
@@ -2832,14 +3085,17 @@ export interface GetJobRequest {
2832
3085
  */
2833
3086
  export interface Job {
2834
3087
  /**
3088
+ * @public
2835
3089
  * <p>The job's ARN.</p>
2836
3090
  */
2837
3091
  arn?: string;
2838
3092
  /**
3093
+ * @public
2839
3094
  * <p>The job's name.</p>
2840
3095
  */
2841
3096
  name?: string;
2842
3097
  /**
3098
+ * @public
2843
3099
  * <p>The job's type.</p>
2844
3100
  * <p>Allowed values include the following:</p>
2845
3101
  * <ul>
@@ -2902,10 +3158,12 @@ export interface Job {
2902
3158
  */
2903
3159
  type?: TestType | string;
2904
3160
  /**
3161
+ * @public
2905
3162
  * <p>When the job was created.</p>
2906
3163
  */
2907
3164
  created?: Date;
2908
3165
  /**
3166
+ * @public
2909
3167
  * <p>The job's status.</p>
2910
3168
  * <p>Allowed values include:</p>
2911
3169
  * <ul>
@@ -2940,6 +3198,7 @@ export interface Job {
2940
3198
  */
2941
3199
  status?: ExecutionStatus | string;
2942
3200
  /**
3201
+ * @public
2943
3202
  * <p>The job's result.</p>
2944
3203
  * <p>Allowed values include:</p>
2945
3204
  * <ul>
@@ -2968,38 +3227,47 @@ export interface Job {
2968
3227
  */
2969
3228
  result?: ExecutionResult | string;
2970
3229
  /**
3230
+ * @public
2971
3231
  * <p>The job's start time.</p>
2972
3232
  */
2973
3233
  started?: Date;
2974
3234
  /**
3235
+ * @public
2975
3236
  * <p>The job's stop time.</p>
2976
3237
  */
2977
3238
  stopped?: Date;
2978
3239
  /**
3240
+ * @public
2979
3241
  * <p>The job's result counters.</p>
2980
3242
  */
2981
3243
  counters?: Counters;
2982
3244
  /**
3245
+ * @public
2983
3246
  * <p>A message about the job's result.</p>
2984
3247
  */
2985
3248
  message?: string;
2986
3249
  /**
3250
+ * @public
2987
3251
  * <p>The device (phone or tablet).</p>
2988
3252
  */
2989
3253
  device?: Device;
2990
3254
  /**
3255
+ * @public
2991
3256
  * <p>The ARN of the instance.</p>
2992
3257
  */
2993
3258
  instanceArn?: string;
2994
3259
  /**
3260
+ * @public
2995
3261
  * <p>Represents the total (metered or unmetered) minutes used by the job.</p>
2996
3262
  */
2997
3263
  deviceMinutes?: DeviceMinutes;
2998
3264
  /**
3265
+ * @public
2999
3266
  * <p>The endpoint for streaming device video.</p>
3000
3267
  */
3001
3268
  videoEndpoint?: string;
3002
3269
  /**
3270
+ * @public
3003
3271
  * <p>This value is set to true if video capture is enabled. Otherwise, it is set to false.</p>
3004
3272
  */
3005
3273
  videoCapture?: boolean;
@@ -3010,6 +3278,7 @@ export interface Job {
3010
3278
  */
3011
3279
  export interface GetJobResult {
3012
3280
  /**
3281
+ * @public
3013
3282
  * <p>An object that contains information about the requested job.</p>
3014
3283
  */
3015
3284
  job?: Job;
@@ -3019,6 +3288,7 @@ export interface GetJobResult {
3019
3288
  */
3020
3289
  export interface GetNetworkProfileRequest {
3021
3290
  /**
3291
+ * @public
3022
3292
  * <p>The ARN of the network profile to return information about.</p>
3023
3293
  */
3024
3294
  arn: string | undefined;
@@ -3028,6 +3298,7 @@ export interface GetNetworkProfileRequest {
3028
3298
  */
3029
3299
  export interface GetNetworkProfileResult {
3030
3300
  /**
3301
+ * @public
3031
3302
  * <p>The network profile.</p>
3032
3303
  */
3033
3304
  networkProfile?: NetworkProfile;
@@ -3039,6 +3310,7 @@ export interface GetNetworkProfileResult {
3039
3310
  */
3040
3311
  export interface GetOfferingStatusRequest {
3041
3312
  /**
3313
+ * @public
3042
3314
  * <p>An identifier that was returned from the previous call to this operation, which can
3043
3315
  * be used to return the next set of items in the list.</p>
3044
3316
  */
@@ -3050,10 +3322,12 @@ export interface GetOfferingStatusRequest {
3050
3322
  */
3051
3323
  export interface MonetaryAmount {
3052
3324
  /**
3325
+ * @public
3053
3326
  * <p>The numerical amount of an offering or transaction.</p>
3054
3327
  */
3055
3328
  amount?: number;
3056
3329
  /**
3330
+ * @public
3057
3331
  * <p>The currency code of a monetary amount. For example, <code>USD</code> means U.S. dollars.</p>
3058
3332
  */
3059
3333
  currencyCode?: CurrencyCode | string;
@@ -3075,10 +3349,12 @@ export type RecurringChargeFrequency = (typeof RecurringChargeFrequency)[keyof t
3075
3349
  */
3076
3350
  export interface RecurringCharge {
3077
3351
  /**
3352
+ * @public
3078
3353
  * <p>The cost of the recurring charge.</p>
3079
3354
  */
3080
3355
  cost?: MonetaryAmount;
3081
3356
  /**
3357
+ * @public
3082
3358
  * <p>The frequency in which charges recur.</p>
3083
3359
  */
3084
3360
  frequency?: RecurringChargeFrequency | string;
@@ -3100,22 +3376,27 @@ export type OfferingType = (typeof OfferingType)[keyof typeof OfferingType];
3100
3376
  */
3101
3377
  export interface Offering {
3102
3378
  /**
3379
+ * @public
3103
3380
  * <p>The ID that corresponds to a device offering.</p>
3104
3381
  */
3105
3382
  id?: string;
3106
3383
  /**
3384
+ * @public
3107
3385
  * <p>A string that describes the offering.</p>
3108
3386
  */
3109
3387
  description?: string;
3110
3388
  /**
3389
+ * @public
3111
3390
  * <p>The type of offering (for example, <code>RECURRING</code>) for a device.</p>
3112
3391
  */
3113
3392
  type?: OfferingType | string;
3114
3393
  /**
3394
+ * @public
3115
3395
  * <p>The platform of the device (for example, <code>ANDROID</code> or <code>IOS</code>).</p>
3116
3396
  */
3117
3397
  platform?: DevicePlatform | string;
3118
3398
  /**
3399
+ * @public
3119
3400
  * <p>Specifies whether there are recurring charges for the offering.</p>
3120
3401
  */
3121
3402
  recurringCharges?: RecurringCharge[];
@@ -3139,18 +3420,22 @@ export type OfferingTransactionType = (typeof OfferingTransactionType)[keyof typ
3139
3420
  */
3140
3421
  export interface OfferingStatus {
3141
3422
  /**
3423
+ * @public
3142
3424
  * <p>The type specified for the offering status.</p>
3143
3425
  */
3144
3426
  type?: OfferingTransactionType | string;
3145
3427
  /**
3428
+ * @public
3146
3429
  * <p>Represents the metadata of an offering status.</p>
3147
3430
  */
3148
3431
  offering?: Offering;
3149
3432
  /**
3433
+ * @public
3150
3434
  * <p>The number of available devices in the offering.</p>
3151
3435
  */
3152
3436
  quantity?: number;
3153
3437
  /**
3438
+ * @public
3154
3439
  * <p>The date on which the offering is effective.</p>
3155
3440
  */
3156
3441
  effectiveOn?: Date;
@@ -3161,14 +3446,17 @@ export interface OfferingStatus {
3161
3446
  */
3162
3447
  export interface GetOfferingStatusResult {
3163
3448
  /**
3449
+ * @public
3164
3450
  * <p>When specified, gets the offering status for the current period.</p>
3165
3451
  */
3166
3452
  current?: Record<string, OfferingStatus>;
3167
3453
  /**
3454
+ * @public
3168
3455
  * <p>When specified, gets the offering status for the next period.</p>
3169
3456
  */
3170
3457
  nextPeriod?: Record<string, OfferingStatus>;
3171
3458
  /**
3459
+ * @public
3172
3460
  * <p>An identifier that was returned from the previous call to this operation, which can
3173
3461
  * be used to return the next set of items in the list.</p>
3174
3462
  */
@@ -3193,6 +3481,7 @@ export declare class NotEligibleException extends __BaseException {
3193
3481
  */
3194
3482
  export interface GetProjectRequest {
3195
3483
  /**
3484
+ * @public
3196
3485
  * <p>The project's ARN.</p>
3197
3486
  */
3198
3487
  arn: string | undefined;
@@ -3203,6 +3492,7 @@ export interface GetProjectRequest {
3203
3492
  */
3204
3493
  export interface GetProjectResult {
3205
3494
  /**
3495
+ * @public
3206
3496
  * <p>The project to get information about.</p>
3207
3497
  */
3208
3498
  project?: Project;
@@ -3214,6 +3504,7 @@ export interface GetProjectResult {
3214
3504
  */
3215
3505
  export interface GetRemoteAccessSessionRequest {
3216
3506
  /**
3507
+ * @public
3217
3508
  * <p>The Amazon Resource Name (ARN) of the remote access session about which you want to
3218
3509
  * get session information.</p>
3219
3510
  */
@@ -3226,6 +3517,7 @@ export interface GetRemoteAccessSessionRequest {
3226
3517
  */
3227
3518
  export interface GetRemoteAccessSessionResult {
3228
3519
  /**
3520
+ * @public
3229
3521
  * <p>A container that lists detailed information about the remote access
3230
3522
  * session.</p>
3231
3523
  */
@@ -3237,6 +3529,7 @@ export interface GetRemoteAccessSessionResult {
3237
3529
  */
3238
3530
  export interface GetRunRequest {
3239
3531
  /**
3532
+ * @public
3240
3533
  * <p>The run's ARN.</p>
3241
3534
  */
3242
3535
  arn: string | undefined;
@@ -3274,6 +3567,7 @@ export type DeviceFilterAttribute = (typeof DeviceFilterAttribute)[keyof typeof
3274
3567
  */
3275
3568
  export interface DeviceFilter {
3276
3569
  /**
3570
+ * @public
3277
3571
  * <p>The aspect of a device such as platform or model used as the selection criteria in a
3278
3572
  * device filter.</p>
3279
3573
  * <p>The supported operators for each attribute are provided in the following list.</p>
@@ -3365,11 +3659,13 @@ export interface DeviceFilter {
3365
3659
  */
3366
3660
  attribute: DeviceFilterAttribute | string | undefined;
3367
3661
  /**
3662
+ * @public
3368
3663
  * <p>Specifies how Device Farm compares the filter's attribute to the value. See the attribute
3369
3664
  * descriptions.</p>
3370
3665
  */
3371
3666
  operator: RuleOperator | string | undefined;
3372
3667
  /**
3668
+ * @public
3373
3669
  * <p>An array of one or more filter values used in a device filter.</p>
3374
3670
  * <p class="title">
3375
3671
  * <b>Operator Values</b>
@@ -3411,14 +3707,17 @@ export interface DeviceFilter {
3411
3707
  */
3412
3708
  export interface DeviceSelectionResult {
3413
3709
  /**
3710
+ * @public
3414
3711
  * <p>The filters in a device selection result.</p>
3415
3712
  */
3416
3713
  filters?: DeviceFilter[];
3417
3714
  /**
3715
+ * @public
3418
3716
  * <p>The number of devices that matched the device filter selection criteria.</p>
3419
3717
  */
3420
3718
  matchedDevicesCount?: number;
3421
3719
  /**
3720
+ * @public
3422
3721
  * <p>The maximum number of devices to be selected by a device filter and included in a test
3423
3722
  * run.</p>
3424
3723
  */
@@ -3443,14 +3742,17 @@ export type ExecutionResultCode = (typeof ExecutionResultCode)[keyof typeof Exec
3443
3742
  */
3444
3743
  export interface Run {
3445
3744
  /**
3745
+ * @public
3446
3746
  * <p>The run's ARN.</p>
3447
3747
  */
3448
3748
  arn?: string;
3449
3749
  /**
3750
+ * @public
3450
3751
  * <p>The run's name.</p>
3451
3752
  */
3452
3753
  name?: string;
3453
3754
  /**
3755
+ * @public
3454
3756
  * <p>The run's type.</p>
3455
3757
  * <p>Must be one of the following values:</p>
3456
3758
  * <ul>
@@ -3516,6 +3818,7 @@ export interface Run {
3516
3818
  */
3517
3819
  type?: TestType | string;
3518
3820
  /**
3821
+ * @public
3519
3822
  * <p>The run's platform.</p>
3520
3823
  * <p>Allowed values include:</p>
3521
3824
  * <ul>
@@ -3529,10 +3832,12 @@ export interface Run {
3529
3832
  */
3530
3833
  platform?: DevicePlatform | string;
3531
3834
  /**
3835
+ * @public
3532
3836
  * <p>When the run was created.</p>
3533
3837
  */
3534
3838
  created?: Date;
3535
3839
  /**
3840
+ * @public
3536
3841
  * <p>The run's status.</p>
3537
3842
  * <p>Allowed values include:</p>
3538
3843
  * <ul>
@@ -3567,6 +3872,7 @@ export interface Run {
3567
3872
  */
3568
3873
  status?: ExecutionStatus | string;
3569
3874
  /**
3875
+ * @public
3570
3876
  * <p>The run's result.</p>
3571
3877
  * <p>Allowed values include:</p>
3572
3878
  * <ul>
@@ -3595,30 +3901,37 @@ export interface Run {
3595
3901
  */
3596
3902
  result?: ExecutionResult | string;
3597
3903
  /**
3904
+ * @public
3598
3905
  * <p>The run's start time.</p>
3599
3906
  */
3600
3907
  started?: Date;
3601
3908
  /**
3909
+ * @public
3602
3910
  * <p>The run's stop time.</p>
3603
3911
  */
3604
3912
  stopped?: Date;
3605
3913
  /**
3914
+ * @public
3606
3915
  * <p>The run's result counters.</p>
3607
3916
  */
3608
3917
  counters?: Counters;
3609
3918
  /**
3919
+ * @public
3610
3920
  * <p>A message about the run's result.</p>
3611
3921
  */
3612
3922
  message?: string;
3613
3923
  /**
3924
+ * @public
3614
3925
  * <p>The total number of jobs for the run.</p>
3615
3926
  */
3616
3927
  totalJobs?: number;
3617
3928
  /**
3929
+ * @public
3618
3930
  * <p>The total number of completed jobs.</p>
3619
3931
  */
3620
3932
  completedJobs?: number;
3621
3933
  /**
3934
+ * @public
3622
3935
  * <p>Specifies the billing method for a test run: <code>metered</code> or
3623
3936
  * <code>unmetered</code>. If the parameter is not specified, the default value is
3624
3937
  * <code>metered</code>.</p>
@@ -3629,67 +3942,82 @@ export interface Run {
3629
3942
  */
3630
3943
  billingMethod?: BillingMethod | string;
3631
3944
  /**
3945
+ * @public
3632
3946
  * <p>Represents the total (metered or unmetered) minutes used by the test run.</p>
3633
3947
  */
3634
3948
  deviceMinutes?: DeviceMinutes;
3635
3949
  /**
3950
+ * @public
3636
3951
  * <p>The network profile being used for a test run.</p>
3637
3952
  */
3638
3953
  networkProfile?: NetworkProfile;
3639
3954
  /**
3955
+ * @public
3640
3956
  * <p>Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package.
3641
3957
  * If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points
3642
3958
  * to.</p>
3643
3959
  */
3644
3960
  parsingResultUrl?: string;
3645
3961
  /**
3962
+ * @public
3646
3963
  * <p>Supporting field for the result field. Set only if <code>result</code> is <code>SKIPPED</code>.
3647
3964
  * <code>PARSING_FAILED</code> if the result is skipped because of test package parsing failure.</p>
3648
3965
  */
3649
3966
  resultCode?: ExecutionResultCode | string;
3650
3967
  /**
3968
+ * @public
3651
3969
  * <p>For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same
3652
3970
  * seed value between tests ensures identical event sequences.</p>
3653
3971
  */
3654
3972
  seed?: number;
3655
3973
  /**
3974
+ * @public
3656
3975
  * <p>An app to upload or that has been uploaded.</p>
3657
3976
  */
3658
3977
  appUpload?: string;
3659
3978
  /**
3979
+ * @public
3660
3980
  * <p>For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz
3661
3981
  * test should perform.</p>
3662
3982
  */
3663
3983
  eventCount?: number;
3664
3984
  /**
3985
+ * @public
3665
3986
  * <p>The number of minutes the job executes before it times out.</p>
3666
3987
  */
3667
3988
  jobTimeoutMinutes?: number;
3668
3989
  /**
3990
+ * @public
3669
3991
  * <p>The ARN of the device pool for the run.</p>
3670
3992
  */
3671
3993
  devicePoolArn?: string;
3672
3994
  /**
3995
+ * @public
3673
3996
  * <p>Information about the locale that is used for the run.</p>
3674
3997
  */
3675
3998
  locale?: string;
3676
3999
  /**
4000
+ * @public
3677
4001
  * <p>Information about the radio states for the run.</p>
3678
4002
  */
3679
4003
  radios?: Radios;
3680
4004
  /**
4005
+ * @public
3681
4006
  * <p>Information about the location that is used for the run.</p>
3682
4007
  */
3683
4008
  location?: Location;
3684
4009
  /**
4010
+ * @public
3685
4011
  * <p>Output <code>CustomerArtifactPaths</code> object for the test run.</p>
3686
4012
  */
3687
4013
  customerArtifactPaths?: CustomerArtifactPaths;
3688
4014
  /**
4015
+ * @public
3689
4016
  * <p>The Device Farm console URL for the recording of the run.</p>
3690
4017
  */
3691
4018
  webUrl?: string;
3692
4019
  /**
4020
+ * @public
3693
4021
  * <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public
3694
4022
  * devices, Device Farm always signs your apps again.</p>
3695
4023
  * <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device
@@ -3697,14 +4025,17 @@ export interface Run {
3697
4025
  */
3698
4026
  skipAppResign?: boolean;
3699
4027
  /**
4028
+ * @public
3700
4029
  * <p>The ARN of the YAML-formatted test specification for the run.</p>
3701
4030
  */
3702
4031
  testSpecArn?: string;
3703
4032
  /**
4033
+ * @public
3704
4034
  * <p>The results of a device filter used to select the devices for a test run.</p>
3705
4035
  */
3706
4036
  deviceSelectionResult?: DeviceSelectionResult;
3707
4037
  /**
4038
+ * @public
3708
4039
  * <p>The VPC security groups and subnets that are attached to a project.</p>
3709
4040
  */
3710
4041
  vpcConfig?: VpcConfig;
@@ -3715,6 +4046,7 @@ export interface Run {
3715
4046
  */
3716
4047
  export interface GetRunResult {
3717
4048
  /**
4049
+ * @public
3718
4050
  * <p>The run to get results from.</p>
3719
4051
  */
3720
4052
  run?: Run;
@@ -3725,6 +4057,7 @@ export interface GetRunResult {
3725
4057
  */
3726
4058
  export interface GetSuiteRequest {
3727
4059
  /**
4060
+ * @public
3728
4061
  * <p>The suite's ARN.</p>
3729
4062
  */
3730
4063
  arn: string | undefined;
@@ -3735,14 +4068,17 @@ export interface GetSuiteRequest {
3735
4068
  */
3736
4069
  export interface Suite {
3737
4070
  /**
4071
+ * @public
3738
4072
  * <p>The suite's ARN.</p>
3739
4073
  */
3740
4074
  arn?: string;
3741
4075
  /**
4076
+ * @public
3742
4077
  * <p>The suite's name.</p>
3743
4078
  */
3744
4079
  name?: string;
3745
4080
  /**
4081
+ * @public
3746
4082
  * <p>The suite's type.</p>
3747
4083
  * <p>Must be one of the following values:</p>
3748
4084
  * <ul>
@@ -3808,10 +4144,12 @@ export interface Suite {
3808
4144
  */
3809
4145
  type?: TestType | string;
3810
4146
  /**
4147
+ * @public
3811
4148
  * <p>When the suite was created.</p>
3812
4149
  */
3813
4150
  created?: Date;
3814
4151
  /**
4152
+ * @public
3815
4153
  * <p>The suite's status.</p>
3816
4154
  * <p>Allowed values include:</p>
3817
4155
  * <ul>
@@ -3846,6 +4184,7 @@ export interface Suite {
3846
4184
  */
3847
4185
  status?: ExecutionStatus | string;
3848
4186
  /**
4187
+ * @public
3849
4188
  * <p>The suite's result.</p>
3850
4189
  * <p>Allowed values include:</p>
3851
4190
  * <ul>
@@ -3874,22 +4213,27 @@ export interface Suite {
3874
4213
  */
3875
4214
  result?: ExecutionResult | string;
3876
4215
  /**
4216
+ * @public
3877
4217
  * <p>The suite's start time.</p>
3878
4218
  */
3879
4219
  started?: Date;
3880
4220
  /**
4221
+ * @public
3881
4222
  * <p>The suite's stop time.</p>
3882
4223
  */
3883
4224
  stopped?: Date;
3884
4225
  /**
4226
+ * @public
3885
4227
  * <p>The suite's result counters.</p>
3886
4228
  */
3887
4229
  counters?: Counters;
3888
4230
  /**
4231
+ * @public
3889
4232
  * <p>A message about the suite's result.</p>
3890
4233
  */
3891
4234
  message?: string;
3892
4235
  /**
4236
+ * @public
3893
4237
  * <p>Represents the total (metered or unmetered) minutes used by the test
3894
4238
  * suite.</p>
3895
4239
  */
@@ -3901,6 +4245,7 @@ export interface Suite {
3901
4245
  */
3902
4246
  export interface GetSuiteResult {
3903
4247
  /**
4248
+ * @public
3904
4249
  * <p>A collection of one or more tests.</p>
3905
4250
  */
3906
4251
  suite?: Suite;
@@ -3911,6 +4256,7 @@ export interface GetSuiteResult {
3911
4256
  */
3912
4257
  export interface GetTestRequest {
3913
4258
  /**
4259
+ * @public
3914
4260
  * <p>The test's ARN.</p>
3915
4261
  */
3916
4262
  arn: string | undefined;
@@ -3921,14 +4267,17 @@ export interface GetTestRequest {
3921
4267
  */
3922
4268
  export interface Test {
3923
4269
  /**
4270
+ * @public
3924
4271
  * <p>The test's ARN.</p>
3925
4272
  */
3926
4273
  arn?: string;
3927
4274
  /**
4275
+ * @public
3928
4276
  * <p>The test's name.</p>
3929
4277
  */
3930
4278
  name?: string;
3931
4279
  /**
4280
+ * @public
3932
4281
  * <p>The test's type.</p>
3933
4282
  * <p>Must be one of the following values:</p>
3934
4283
  * <ul>
@@ -3994,10 +4343,12 @@ export interface Test {
3994
4343
  */
3995
4344
  type?: TestType | string;
3996
4345
  /**
4346
+ * @public
3997
4347
  * <p>When the test was created.</p>
3998
4348
  */
3999
4349
  created?: Date;
4000
4350
  /**
4351
+ * @public
4001
4352
  * <p>The test's status.</p>
4002
4353
  * <p>Allowed values include:</p>
4003
4354
  * <ul>
@@ -4032,6 +4383,7 @@ export interface Test {
4032
4383
  */
4033
4384
  status?: ExecutionStatus | string;
4034
4385
  /**
4386
+ * @public
4035
4387
  * <p>The test's result.</p>
4036
4388
  * <p>Allowed values include:</p>
4037
4389
  * <ul>
@@ -4060,22 +4412,27 @@ export interface Test {
4060
4412
  */
4061
4413
  result?: ExecutionResult | string;
4062
4414
  /**
4415
+ * @public
4063
4416
  * <p>The test's start time.</p>
4064
4417
  */
4065
4418
  started?: Date;
4066
4419
  /**
4420
+ * @public
4067
4421
  * <p>The test's stop time.</p>
4068
4422
  */
4069
4423
  stopped?: Date;
4070
4424
  /**
4425
+ * @public
4071
4426
  * <p>The test's result counters.</p>
4072
4427
  */
4073
4428
  counters?: Counters;
4074
4429
  /**
4430
+ * @public
4075
4431
  * <p>A message about the test's result.</p>
4076
4432
  */
4077
4433
  message?: string;
4078
4434
  /**
4435
+ * @public
4079
4436
  * <p>Represents the total (metered or unmetered) minutes used by the test.</p>
4080
4437
  */
4081
4438
  deviceMinutes?: DeviceMinutes;
@@ -4086,6 +4443,7 @@ export interface Test {
4086
4443
  */
4087
4444
  export interface GetTestResult {
4088
4445
  /**
4446
+ * @public
4089
4447
  * <p>A test condition that is evaluated.</p>
4090
4448
  */
4091
4449
  test?: Test;
@@ -4095,6 +4453,7 @@ export interface GetTestResult {
4095
4453
  */
4096
4454
  export interface GetTestGridProjectRequest {
4097
4455
  /**
4456
+ * @public
4098
4457
  * <p>The ARN of the Selenium testing project, from either <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>.</p>
4099
4458
  */
4100
4459
  projectArn: string | undefined;
@@ -4104,6 +4463,7 @@ export interface GetTestGridProjectRequest {
4104
4463
  */
4105
4464
  export interface GetTestGridProjectResult {
4106
4465
  /**
4466
+ * @public
4107
4467
  * <p>A <a>TestGridProject</a>.</p>
4108
4468
  */
4109
4469
  testGridProject?: TestGridProject;
@@ -4113,14 +4473,17 @@ export interface GetTestGridProjectResult {
4113
4473
  */
4114
4474
  export interface GetTestGridSessionRequest {
4115
4475
  /**
4476
+ * @public
4116
4477
  * <p>The ARN for the project that this session belongs to. See <a>CreateTestGridProject</a> and <a>ListTestGridProjects</a>.</p>
4117
4478
  */
4118
4479
  projectArn?: string;
4119
4480
  /**
4481
+ * @public
4120
4482
  * <p>An ID associated with this session.</p>
4121
4483
  */
4122
4484
  sessionId?: string;
4123
4485
  /**
4486
+ * @public
4124
4487
  * <p>An ARN that uniquely identifies a <a>TestGridSession</a>.</p>
4125
4488
  */
4126
4489
  sessionArn?: string;
@@ -4145,26 +4508,32 @@ export type TestGridSessionStatus = (typeof TestGridSessionStatus)[keyof typeof
4145
4508
  */
4146
4509
  export interface TestGridSession {
4147
4510
  /**
4511
+ * @public
4148
4512
  * <p>The ARN of the session.</p>
4149
4513
  */
4150
4514
  arn?: string;
4151
4515
  /**
4516
+ * @public
4152
4517
  * <p>The state of the session.</p>
4153
4518
  */
4154
4519
  status?: TestGridSessionStatus | string;
4155
4520
  /**
4521
+ * @public
4156
4522
  * <p>The time that the session was started.</p>
4157
4523
  */
4158
4524
  created?: Date;
4159
4525
  /**
4526
+ * @public
4160
4527
  * <p>The time the session ended.</p>
4161
4528
  */
4162
4529
  ended?: Date;
4163
4530
  /**
4531
+ * @public
4164
4532
  * <p>The number of billed minutes that were used for this session. </p>
4165
4533
  */
4166
4534
  billingMinutes?: number;
4167
4535
  /**
4536
+ * @public
4168
4537
  * <p>A JSON object of options and parameters passed to the Selenium WebDriver.</p>
4169
4538
  */
4170
4539
  seleniumProperties?: string;
@@ -4174,6 +4543,7 @@ export interface TestGridSession {
4174
4543
  */
4175
4544
  export interface GetTestGridSessionResult {
4176
4545
  /**
4546
+ * @public
4177
4547
  * <p>The <a>TestGridSession</a> that was requested.</p>
4178
4548
  */
4179
4549
  testGridSession?: TestGridSession;
@@ -4184,6 +4554,7 @@ export interface GetTestGridSessionResult {
4184
4554
  */
4185
4555
  export interface GetUploadRequest {
4186
4556
  /**
4557
+ * @public
4187
4558
  * <p>The upload's ARN.</p>
4188
4559
  */
4189
4560
  arn: string | undefined;
@@ -4194,6 +4565,7 @@ export interface GetUploadRequest {
4194
4565
  */
4195
4566
  export interface GetUploadResult {
4196
4567
  /**
4568
+ * @public
4197
4569
  * <p>An app or a set of one or more tests to upload or that have been
4198
4570
  * uploaded.</p>
4199
4571
  */
@@ -4204,6 +4576,7 @@ export interface GetUploadResult {
4204
4576
  */
4205
4577
  export interface GetVPCEConfigurationRequest {
4206
4578
  /**
4579
+ * @public
4207
4580
  * <p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
4208
4581
  * describe.</p>
4209
4582
  */
@@ -4214,6 +4587,7 @@ export interface GetVPCEConfigurationRequest {
4214
4587
  */
4215
4588
  export interface GetVPCEConfigurationResult {
4216
4589
  /**
4590
+ * @public
4217
4591
  * <p>An object that contains information about your VPC endpoint configuration.</p>
4218
4592
  */
4219
4593
  vpceConfiguration?: VPCEConfiguration;
@@ -4225,11 +4599,13 @@ export interface GetVPCEConfigurationResult {
4225
4599
  */
4226
4600
  export interface InstallToRemoteAccessSessionRequest {
4227
4601
  /**
4602
+ * @public
4228
4603
  * <p>The Amazon Resource Name (ARN) of the remote access session about which you are
4229
4604
  * requesting information.</p>
4230
4605
  */
4231
4606
  remoteAccessSessionArn: string | undefined;
4232
4607
  /**
4608
+ * @public
4233
4609
  * <p>The ARN of the app about which you are requesting information.</p>
4234
4610
  */
4235
4611
  appArn: string | undefined;
@@ -4241,6 +4617,7 @@ export interface InstallToRemoteAccessSessionRequest {
4241
4617
  */
4242
4618
  export interface InstallToRemoteAccessSessionResult {
4243
4619
  /**
4620
+ * @public
4244
4621
  * <p>An app to upload or that has been uploaded.</p>
4245
4622
  */
4246
4623
  appUpload?: Upload;
@@ -4251,10 +4628,12 @@ export interface InstallToRemoteAccessSessionResult {
4251
4628
  */
4252
4629
  export interface ListArtifactsRequest {
4253
4630
  /**
4631
+ * @public
4254
4632
  * <p>The run, job, suite, or test ARN.</p>
4255
4633
  */
4256
4634
  arn: string | undefined;
4257
4635
  /**
4636
+ * @public
4258
4637
  * <p>The artifacts' type.</p>
4259
4638
  * <p>Allowed values include:</p>
4260
4639
  * <ul>
@@ -4271,6 +4650,7 @@ export interface ListArtifactsRequest {
4271
4650
  */
4272
4651
  type: ArtifactCategory | string | undefined;
4273
4652
  /**
4653
+ * @public
4274
4654
  * <p>An identifier that was returned from the previous call to this operation, which can
4275
4655
  * be used to return the next set of items in the list.</p>
4276
4656
  */
@@ -4282,10 +4662,12 @@ export interface ListArtifactsRequest {
4282
4662
  */
4283
4663
  export interface ListArtifactsResult {
4284
4664
  /**
4665
+ * @public
4285
4666
  * <p>Information about the artifacts.</p>
4286
4667
  */
4287
4668
  artifacts?: Artifact[];
4288
4669
  /**
4670
+ * @public
4289
4671
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4290
4672
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4291
4673
  * list.</p>
@@ -4297,10 +4679,12 @@ export interface ListArtifactsResult {
4297
4679
  */
4298
4680
  export interface ListDeviceInstancesRequest {
4299
4681
  /**
4682
+ * @public
4300
4683
  * <p>An integer that specifies the maximum number of items you want to return in the API response.</p>
4301
4684
  */
4302
4685
  maxResults?: number;
4303
4686
  /**
4687
+ * @public
4304
4688
  * <p>An identifier that was returned from the previous call to this operation, which can be
4305
4689
  * used to return the next set of items in the list.</p>
4306
4690
  */
@@ -4311,10 +4695,12 @@ export interface ListDeviceInstancesRequest {
4311
4695
  */
4312
4696
  export interface ListDeviceInstancesResult {
4313
4697
  /**
4698
+ * @public
4314
4699
  * <p>An object that contains information about your device instances.</p>
4315
4700
  */
4316
4701
  deviceInstances?: DeviceInstance[];
4317
4702
  /**
4703
+ * @public
4318
4704
  * <p>An identifier that can be used in the next call to this operation to return the next
4319
4705
  * set of items in the list.</p>
4320
4706
  */
@@ -4326,10 +4712,12 @@ export interface ListDeviceInstancesResult {
4326
4712
  */
4327
4713
  export interface ListDevicePoolsRequest {
4328
4714
  /**
4715
+ * @public
4329
4716
  * <p>The project ARN.</p>
4330
4717
  */
4331
4718
  arn: string | undefined;
4332
4719
  /**
4720
+ * @public
4333
4721
  * <p>The device pools' type.</p>
4334
4722
  * <p>Allowed values include:</p>
4335
4723
  * <ul>
@@ -4345,6 +4733,7 @@ export interface ListDevicePoolsRequest {
4345
4733
  */
4346
4734
  type?: DevicePoolType | string;
4347
4735
  /**
4736
+ * @public
4348
4737
  * <p>An identifier that was returned from the previous call to this operation, which can
4349
4738
  * be used to return the next set of items in the list.</p>
4350
4739
  */
@@ -4356,10 +4745,12 @@ export interface ListDevicePoolsRequest {
4356
4745
  */
4357
4746
  export interface ListDevicePoolsResult {
4358
4747
  /**
4748
+ * @public
4359
4749
  * <p>Information about the device pools.</p>
4360
4750
  */
4361
4751
  devicePools?: DevicePool[];
4362
4752
  /**
4753
+ * @public
4363
4754
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4364
4755
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4365
4756
  * list.</p>
@@ -4372,15 +4763,18 @@ export interface ListDevicePoolsResult {
4372
4763
  */
4373
4764
  export interface ListDevicesRequest {
4374
4765
  /**
4766
+ * @public
4375
4767
  * <p>The Amazon Resource Name (ARN) of the project.</p>
4376
4768
  */
4377
4769
  arn?: string;
4378
4770
  /**
4771
+ * @public
4379
4772
  * <p>An identifier that was returned from the previous call to this operation, which can
4380
4773
  * be used to return the next set of items in the list.</p>
4381
4774
  */
4382
4775
  nextToken?: string;
4383
4776
  /**
4777
+ * @public
4384
4778
  * <p>Used to select a set of devices. A filter is made up of an attribute, an operator, and
4385
4779
  * one or more values.</p>
4386
4780
  * <ul>
@@ -4481,10 +4875,12 @@ export interface ListDevicesRequest {
4481
4875
  */
4482
4876
  export interface ListDevicesResult {
4483
4877
  /**
4878
+ * @public
4484
4879
  * <p>Information about the devices.</p>
4485
4880
  */
4486
4881
  devices?: Device[];
4487
4882
  /**
4883
+ * @public
4488
4884
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4489
4885
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4490
4886
  * list.</p>
@@ -4496,10 +4892,12 @@ export interface ListDevicesResult {
4496
4892
  */
4497
4893
  export interface ListInstanceProfilesRequest {
4498
4894
  /**
4895
+ * @public
4499
4896
  * <p>An integer that specifies the maximum number of items you want to return in the API response.</p>
4500
4897
  */
4501
4898
  maxResults?: number;
4502
4899
  /**
4900
+ * @public
4503
4901
  * <p>An identifier that was returned from the previous call to this operation, which can be
4504
4902
  * used to return the next set of items in the list.</p>
4505
4903
  */
@@ -4510,10 +4908,12 @@ export interface ListInstanceProfilesRequest {
4510
4908
  */
4511
4909
  export interface ListInstanceProfilesResult {
4512
4910
  /**
4911
+ * @public
4513
4912
  * <p>An object that contains information about your instance profiles.</p>
4514
4913
  */
4515
4914
  instanceProfiles?: InstanceProfile[];
4516
4915
  /**
4916
+ * @public
4517
4917
  * <p>An identifier that can be used in the next call to this operation to return the next
4518
4918
  * set of items in the list.</p>
4519
4919
  */
@@ -4525,10 +4925,12 @@ export interface ListInstanceProfilesResult {
4525
4925
  */
4526
4926
  export interface ListJobsRequest {
4527
4927
  /**
4928
+ * @public
4528
4929
  * <p>The run's Amazon Resource Name (ARN).</p>
4529
4930
  */
4530
4931
  arn: string | undefined;
4531
4932
  /**
4933
+ * @public
4532
4934
  * <p>An identifier that was returned from the previous call to this operation, which can
4533
4935
  * be used to return the next set of items in the list.</p>
4534
4936
  */
@@ -4540,10 +4942,12 @@ export interface ListJobsRequest {
4540
4942
  */
4541
4943
  export interface ListJobsResult {
4542
4944
  /**
4945
+ * @public
4543
4946
  * <p>Information about the jobs.</p>
4544
4947
  */
4545
4948
  jobs?: Job[];
4546
4949
  /**
4950
+ * @public
4547
4951
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4548
4952
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4549
4953
  * list.</p>
@@ -4555,15 +4959,18 @@ export interface ListJobsResult {
4555
4959
  */
4556
4960
  export interface ListNetworkProfilesRequest {
4557
4961
  /**
4962
+ * @public
4558
4963
  * <p>The Amazon Resource Name (ARN) of the project for which you want to list network
4559
4964
  * profiles.</p>
4560
4965
  */
4561
4966
  arn: string | undefined;
4562
4967
  /**
4968
+ * @public
4563
4969
  * <p>The type of network profile to return information about. Valid values are listed here.</p>
4564
4970
  */
4565
4971
  type?: NetworkProfileType | string;
4566
4972
  /**
4973
+ * @public
4567
4974
  * <p>An identifier that was returned from the previous call to this operation, which can
4568
4975
  * be used to return the next set of items in the list.</p>
4569
4976
  */
@@ -4574,10 +4981,12 @@ export interface ListNetworkProfilesRequest {
4574
4981
  */
4575
4982
  export interface ListNetworkProfilesResult {
4576
4983
  /**
4984
+ * @public
4577
4985
  * <p>A list of the available network profiles.</p>
4578
4986
  */
4579
4987
  networkProfiles?: NetworkProfile[];
4580
4988
  /**
4989
+ * @public
4581
4990
  * <p>An identifier that was returned from the previous call to this operation, which can
4582
4991
  * be used to return the next set of items in the list.</p>
4583
4992
  */
@@ -4588,6 +4997,7 @@ export interface ListNetworkProfilesResult {
4588
4997
  */
4589
4998
  export interface ListOfferingPromotionsRequest {
4590
4999
  /**
5000
+ * @public
4591
5001
  * <p>An identifier that was returned from the previous call to this operation, which can
4592
5002
  * be used to return the next set of items in the list.</p>
4593
5003
  */
@@ -4599,10 +5009,12 @@ export interface ListOfferingPromotionsRequest {
4599
5009
  */
4600
5010
  export interface OfferingPromotion {
4601
5011
  /**
5012
+ * @public
4602
5013
  * <p>The ID of the offering promotion.</p>
4603
5014
  */
4604
5015
  id?: string;
4605
5016
  /**
5017
+ * @public
4606
5018
  * <p>A string that describes the offering promotion.</p>
4607
5019
  */
4608
5020
  description?: string;
@@ -4612,10 +5024,12 @@ export interface OfferingPromotion {
4612
5024
  */
4613
5025
  export interface ListOfferingPromotionsResult {
4614
5026
  /**
5027
+ * @public
4615
5028
  * <p>Information about the offering promotions.</p>
4616
5029
  */
4617
5030
  offeringPromotions?: OfferingPromotion[];
4618
5031
  /**
5032
+ * @public
4619
5033
  * <p>An identifier to be used in the next call to this operation, to return the next set
4620
5034
  * of items in the list.</p>
4621
5035
  */
@@ -4627,6 +5041,7 @@ export interface ListOfferingPromotionsResult {
4627
5041
  */
4628
5042
  export interface ListOfferingsRequest {
4629
5043
  /**
5044
+ * @public
4630
5045
  * <p>An identifier that was returned from the previous call to this operation, which can
4631
5046
  * be used to return the next set of items in the list.</p>
4632
5047
  */
@@ -4638,10 +5053,12 @@ export interface ListOfferingsRequest {
4638
5053
  */
4639
5054
  export interface ListOfferingsResult {
4640
5055
  /**
5056
+ * @public
4641
5057
  * <p>A value that represents the list offering results.</p>
4642
5058
  */
4643
5059
  offerings?: Offering[];
4644
5060
  /**
5061
+ * @public
4645
5062
  * <p>An identifier that was returned from the previous call to this operation, which can
4646
5063
  * be used to return the next set of items in the list.</p>
4647
5064
  */
@@ -4653,6 +5070,7 @@ export interface ListOfferingsResult {
4653
5070
  */
4654
5071
  export interface ListOfferingTransactionsRequest {
4655
5072
  /**
5073
+ * @public
4656
5074
  * <p>An identifier that was returned from the previous call to this operation, which can
4657
5075
  * be used to return the next set of items in the list.</p>
4658
5076
  */
@@ -4664,22 +5082,27 @@ export interface ListOfferingTransactionsRequest {
4664
5082
  */
4665
5083
  export interface OfferingTransaction {
4666
5084
  /**
5085
+ * @public
4667
5086
  * <p>The status of an offering transaction.</p>
4668
5087
  */
4669
5088
  offeringStatus?: OfferingStatus;
4670
5089
  /**
5090
+ * @public
4671
5091
  * <p>The transaction ID of the offering transaction.</p>
4672
5092
  */
4673
5093
  transactionId?: string;
4674
5094
  /**
5095
+ * @public
4675
5096
  * <p>The ID that corresponds to a device offering promotion.</p>
4676
5097
  */
4677
5098
  offeringPromotionId?: string;
4678
5099
  /**
5100
+ * @public
4679
5101
  * <p>The date on which an offering transaction was created.</p>
4680
5102
  */
4681
5103
  createdOn?: Date;
4682
5104
  /**
5105
+ * @public
4683
5106
  * <p>The cost of an offering transaction.</p>
4684
5107
  */
4685
5108
  cost?: MonetaryAmount;
@@ -4690,11 +5113,13 @@ export interface OfferingTransaction {
4690
5113
  */
4691
5114
  export interface ListOfferingTransactionsResult {
4692
5115
  /**
5116
+ * @public
4693
5117
  * <p>The audit log of subscriptions you have purchased and modified through AWS Device
4694
5118
  * Farm.</p>
4695
5119
  */
4696
5120
  offeringTransactions?: OfferingTransaction[];
4697
5121
  /**
5122
+ * @public
4698
5123
  * <p>An identifier that was returned from the previous call to this operation, which can
4699
5124
  * be used to return the next set of items in the list.</p>
4700
5125
  */
@@ -4706,12 +5131,14 @@ export interface ListOfferingTransactionsResult {
4706
5131
  */
4707
5132
  export interface ListProjectsRequest {
4708
5133
  /**
5134
+ * @public
4709
5135
  * <p>Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm
4710
5136
  * returns a list of all projects for the AWS account. You can also specify a project
4711
5137
  * ARN.</p>
4712
5138
  */
4713
5139
  arn?: string;
4714
5140
  /**
5141
+ * @public
4715
5142
  * <p>An identifier that was returned from the previous call to this operation, which can
4716
5143
  * be used to return the next set of items in the list.</p>
4717
5144
  */
@@ -4723,10 +5150,12 @@ export interface ListProjectsRequest {
4723
5150
  */
4724
5151
  export interface ListProjectsResult {
4725
5152
  /**
5153
+ * @public
4726
5154
  * <p>Information about the projects.</p>
4727
5155
  */
4728
5156
  projects?: Project[];
4729
5157
  /**
5158
+ * @public
4730
5159
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4731
5160
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4732
5161
  * list.</p>
@@ -4740,11 +5169,13 @@ export interface ListProjectsResult {
4740
5169
  */
4741
5170
  export interface ListRemoteAccessSessionsRequest {
4742
5171
  /**
5172
+ * @public
4743
5173
  * <p>The Amazon Resource Name (ARN) of the project about which you are requesting
4744
5174
  * information.</p>
4745
5175
  */
4746
5176
  arn: string | undefined;
4747
5177
  /**
5178
+ * @public
4748
5179
  * <p>An identifier that was returned from the previous call to this operation, which can
4749
5180
  * be used to return the next set of items in the list.</p>
4750
5181
  */
@@ -4757,11 +5188,13 @@ export interface ListRemoteAccessSessionsRequest {
4757
5188
  */
4758
5189
  export interface ListRemoteAccessSessionsResult {
4759
5190
  /**
5191
+ * @public
4760
5192
  * <p>A container that represents the metadata from the service about each remote access session you are
4761
5193
  * requesting.</p>
4762
5194
  */
4763
5195
  remoteAccessSessions?: RemoteAccessSession[];
4764
5196
  /**
5197
+ * @public
4765
5198
  * <p>An identifier that was returned from the previous call to this operation, which can
4766
5199
  * be used to return the next set of items in the list.</p>
4767
5200
  */
@@ -4773,11 +5206,13 @@ export interface ListRemoteAccessSessionsResult {
4773
5206
  */
4774
5207
  export interface ListRunsRequest {
4775
5208
  /**
5209
+ * @public
4776
5210
  * <p>The Amazon Resource Name (ARN) of the project for which you want to list
4777
5211
  * runs.</p>
4778
5212
  */
4779
5213
  arn: string | undefined;
4780
5214
  /**
5215
+ * @public
4781
5216
  * <p>An identifier that was returned from the previous call to this operation, which can
4782
5217
  * be used to return the next set of items in the list.</p>
4783
5218
  */
@@ -4789,10 +5224,12 @@ export interface ListRunsRequest {
4789
5224
  */
4790
5225
  export interface ListRunsResult {
4791
5226
  /**
5227
+ * @public
4792
5228
  * <p>Information about the runs.</p>
4793
5229
  */
4794
5230
  runs?: Run[];
4795
5231
  /**
5232
+ * @public
4796
5233
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4797
5234
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4798
5235
  * list.</p>
@@ -4805,10 +5242,12 @@ export interface ListRunsResult {
4805
5242
  */
4806
5243
  export interface ListSamplesRequest {
4807
5244
  /**
5245
+ * @public
4808
5246
  * <p>The Amazon Resource Name (ARN) of the job used to list samples.</p>
4809
5247
  */
4810
5248
  arn: string | undefined;
4811
5249
  /**
5250
+ * @public
4812
5251
  * <p>An identifier that was returned from the previous call to this operation, which can
4813
5252
  * be used to return the next set of items in the list.</p>
4814
5253
  */
@@ -4847,10 +5286,12 @@ export type SampleType = (typeof SampleType)[keyof typeof SampleType];
4847
5286
  */
4848
5287
  export interface Sample {
4849
5288
  /**
5289
+ * @public
4850
5290
  * <p>The sample's ARN.</p>
4851
5291
  */
4852
5292
  arn?: string;
4853
5293
  /**
5294
+ * @public
4854
5295
  * <p>The sample's type.</p>
4855
5296
  * <p>Must be one of the following values:</p>
4856
5297
  * <ul>
@@ -4914,6 +5355,7 @@ export interface Sample {
4914
5355
  */
4915
5356
  type?: SampleType | string;
4916
5357
  /**
5358
+ * @public
4917
5359
  * <p>The presigned Amazon S3 URL that can be used with a GET request to download the sample's
4918
5360
  * file.</p>
4919
5361
  */
@@ -4925,10 +5367,12 @@ export interface Sample {
4925
5367
  */
4926
5368
  export interface ListSamplesResult {
4927
5369
  /**
5370
+ * @public
4928
5371
  * <p>Information about the samples.</p>
4929
5372
  */
4930
5373
  samples?: Sample[];
4931
5374
  /**
5375
+ * @public
4932
5376
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4933
5377
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4934
5378
  * list.</p>
@@ -4941,10 +5385,12 @@ export interface ListSamplesResult {
4941
5385
  */
4942
5386
  export interface ListSuitesRequest {
4943
5387
  /**
5388
+ * @public
4944
5389
  * <p>The job's Amazon Resource Name (ARN).</p>
4945
5390
  */
4946
5391
  arn: string | undefined;
4947
5392
  /**
5393
+ * @public
4948
5394
  * <p>An identifier that was returned from the previous call to this operation, which can
4949
5395
  * be used to return the next set of items in the list.</p>
4950
5396
  */
@@ -4956,10 +5402,12 @@ export interface ListSuitesRequest {
4956
5402
  */
4957
5403
  export interface ListSuitesResult {
4958
5404
  /**
5405
+ * @public
4959
5406
  * <p>Information about the suites.</p>
4960
5407
  */
4961
5408
  suites?: Suite[];
4962
5409
  /**
5410
+ * @public
4963
5411
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
4964
5412
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
4965
5413
  * list.</p>
@@ -4971,6 +5419,7 @@ export interface ListSuitesResult {
4971
5419
  */
4972
5420
  export interface ListTagsForResourceRequest {
4973
5421
  /**
5422
+ * @public
4974
5423
  * <p>The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags
4975
5424
  * with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>,
4976
5425
  * <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>,
@@ -4987,11 +5436,13 @@ export interface ListTagsForResourceRequest {
4987
5436
  */
4988
5437
  export interface Tag {
4989
5438
  /**
5439
+ * @public
4990
5440
  * <p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label that acts like a
4991
5441
  * category for more specific tag values.</p>
4992
5442
  */
4993
5443
  Key: string | undefined;
4994
5444
  /**
5445
+ * @public
4995
5446
  * <p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a descriptor in a
4996
5447
  * tag category (key).</p>
4997
5448
  */
@@ -5002,6 +5453,7 @@ export interface Tag {
5002
5453
  */
5003
5454
  export interface ListTagsForResourceResponse {
5004
5455
  /**
5456
+ * @public
5005
5457
  * <p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum
5006
5458
  * character length of 128 characters. Tag values can have a maximum length of 256 characters.</p>
5007
5459
  */
@@ -5012,10 +5464,12 @@ export interface ListTagsForResourceResponse {
5012
5464
  */
5013
5465
  export interface ListTestGridProjectsRequest {
5014
5466
  /**
5467
+ * @public
5015
5468
  * <p>Return no more than this number of results.</p>
5016
5469
  */
5017
5470
  maxResult?: number;
5018
5471
  /**
5472
+ * @public
5019
5473
  * <p>From a response, used to continue a paginated listing. </p>
5020
5474
  */
5021
5475
  nextToken?: string;
@@ -5025,10 +5479,12 @@ export interface ListTestGridProjectsRequest {
5025
5479
  */
5026
5480
  export interface ListTestGridProjectsResult {
5027
5481
  /**
5482
+ * @public
5028
5483
  * <p>The list of TestGridProjects, based on a <a>ListTestGridProjectsRequest</a>.</p>
5029
5484
  */
5030
5485
  testGridProjects?: TestGridProject[];
5031
5486
  /**
5487
+ * @public
5032
5488
  * <p>Used for pagination. Pass into <a>ListTestGridProjects</a> to get more results in a paginated
5033
5489
  * request.</p>
5034
5490
  */
@@ -5039,14 +5495,17 @@ export interface ListTestGridProjectsResult {
5039
5495
  */
5040
5496
  export interface ListTestGridSessionActionsRequest {
5041
5497
  /**
5498
+ * @public
5042
5499
  * <p>The ARN of the session to retrieve.</p>
5043
5500
  */
5044
5501
  sessionArn: string | undefined;
5045
5502
  /**
5503
+ * @public
5046
5504
  * <p>The maximum number of sessions to return per response.</p>
5047
5505
  */
5048
5506
  maxResult?: number;
5049
5507
  /**
5508
+ * @public
5050
5509
  * <p>Pagination token.</p>
5051
5510
  */
5052
5511
  nextToken?: string;
@@ -5057,22 +5516,27 @@ export interface ListTestGridSessionActionsRequest {
5057
5516
  */
5058
5517
  export interface TestGridSessionAction {
5059
5518
  /**
5519
+ * @public
5060
5520
  * <p>The action taken by the session.</p>
5061
5521
  */
5062
5522
  action?: string;
5063
5523
  /**
5524
+ * @public
5064
5525
  * <p>The time that the session invoked the action.</p>
5065
5526
  */
5066
5527
  started?: Date;
5067
5528
  /**
5529
+ * @public
5068
5530
  * <p>The time, in milliseconds, that the action took to complete in the browser.</p>
5069
5531
  */
5070
5532
  duration?: number;
5071
5533
  /**
5534
+ * @public
5072
5535
  * <p>HTTP status code returned to the browser when the action was taken.</p>
5073
5536
  */
5074
5537
  statusCode?: string;
5075
5538
  /**
5539
+ * @public
5076
5540
  * <p>HTTP method that the browser used to make the request.</p>
5077
5541
  */
5078
5542
  requestMethod?: string;
@@ -5082,10 +5546,12 @@ export interface TestGridSessionAction {
5082
5546
  */
5083
5547
  export interface ListTestGridSessionActionsResult {
5084
5548
  /**
5549
+ * @public
5085
5550
  * <p>The action taken by the session.</p>
5086
5551
  */
5087
5552
  actions?: TestGridSessionAction[];
5088
5553
  /**
5554
+ * @public
5089
5555
  * <p>Pagination token.</p>
5090
5556
  */
5091
5557
  nextToken?: string;
@@ -5107,18 +5573,22 @@ export type TestGridSessionArtifactCategory = (typeof TestGridSessionArtifactCat
5107
5573
  */
5108
5574
  export interface ListTestGridSessionArtifactsRequest {
5109
5575
  /**
5576
+ * @public
5110
5577
  * <p>The ARN of a <a>TestGridSession</a>. </p>
5111
5578
  */
5112
5579
  sessionArn: string | undefined;
5113
5580
  /**
5581
+ * @public
5114
5582
  * <p>Limit results to a specified type of artifact.</p>
5115
5583
  */
5116
5584
  type?: TestGridSessionArtifactCategory | string;
5117
5585
  /**
5586
+ * @public
5118
5587
  * <p>The maximum number of results to be returned by a request.</p>
5119
5588
  */
5120
5589
  maxResult?: number;
5121
5590
  /**
5591
+ * @public
5122
5592
  * <p>Pagination token.</p>
5123
5593
  */
5124
5594
  nextToken?: string;
@@ -5146,14 +5616,17 @@ export type TestGridSessionArtifactType = (typeof TestGridSessionArtifactType)[k
5146
5616
  */
5147
5617
  export interface TestGridSessionArtifact {
5148
5618
  /**
5619
+ * @public
5149
5620
  * <p>The file name of the artifact.</p>
5150
5621
  */
5151
5622
  filename?: string;
5152
5623
  /**
5624
+ * @public
5153
5625
  * <p>The kind of artifact.</p>
5154
5626
  */
5155
5627
  type?: TestGridSessionArtifactType | string;
5156
5628
  /**
5629
+ * @public
5157
5630
  * <p>A semi-stable URL to the content of the object.</p>
5158
5631
  */
5159
5632
  url?: string;
@@ -5163,10 +5636,12 @@ export interface TestGridSessionArtifact {
5163
5636
  */
5164
5637
  export interface ListTestGridSessionArtifactsResult {
5165
5638
  /**
5639
+ * @public
5166
5640
  * <p>A list of test grid session artifacts for a <a>TestGridSession</a>.</p>
5167
5641
  */
5168
5642
  artifacts?: TestGridSessionArtifact[];
5169
5643
  /**
5644
+ * @public
5170
5645
  * <p>Pagination token.</p>
5171
5646
  */
5172
5647
  nextToken?: string;
@@ -5176,34 +5651,42 @@ export interface ListTestGridSessionArtifactsResult {
5176
5651
  */
5177
5652
  export interface ListTestGridSessionsRequest {
5178
5653
  /**
5654
+ * @public
5179
5655
  * <p>ARN of a <a>TestGridProject</a>.</p>
5180
5656
  */
5181
5657
  projectArn: string | undefined;
5182
5658
  /**
5659
+ * @public
5183
5660
  * <p>Return only sessions in this state.</p>
5184
5661
  */
5185
5662
  status?: TestGridSessionStatus | string;
5186
5663
  /**
5664
+ * @public
5187
5665
  * <p>Return only sessions created after this time.</p>
5188
5666
  */
5189
5667
  creationTimeAfter?: Date;
5190
5668
  /**
5669
+ * @public
5191
5670
  * <p>Return only sessions created before this time.</p>
5192
5671
  */
5193
5672
  creationTimeBefore?: Date;
5194
5673
  /**
5674
+ * @public
5195
5675
  * <p>Return only sessions that ended after this time.</p>
5196
5676
  */
5197
5677
  endTimeAfter?: Date;
5198
5678
  /**
5679
+ * @public
5199
5680
  * <p>Return only sessions that ended before this time.</p>
5200
5681
  */
5201
5682
  endTimeBefore?: Date;
5202
5683
  /**
5684
+ * @public
5203
5685
  * <p>Return only this many results at a time.</p>
5204
5686
  */
5205
5687
  maxResult?: number;
5206
5688
  /**
5689
+ * @public
5207
5690
  * <p>Pagination token.</p>
5208
5691
  */
5209
5692
  nextToken?: string;
@@ -5213,10 +5696,12 @@ export interface ListTestGridSessionsRequest {
5213
5696
  */
5214
5697
  export interface ListTestGridSessionsResult {
5215
5698
  /**
5699
+ * @public
5216
5700
  * <p>The sessions that match the criteria in a <a>ListTestGridSessionsRequest</a>. </p>
5217
5701
  */
5218
5702
  testGridSessions?: TestGridSession[];
5219
5703
  /**
5704
+ * @public
5220
5705
  * <p>Pagination token.</p>
5221
5706
  */
5222
5707
  nextToken?: string;
@@ -5227,10 +5712,12 @@ export interface ListTestGridSessionsResult {
5227
5712
  */
5228
5713
  export interface ListTestsRequest {
5229
5714
  /**
5715
+ * @public
5230
5716
  * <p>The test suite's Amazon Resource Name (ARN).</p>
5231
5717
  */
5232
5718
  arn: string | undefined;
5233
5719
  /**
5720
+ * @public
5234
5721
  * <p>An identifier that was returned from the previous call to this operation, which can
5235
5722
  * be used to return the next set of items in the list.</p>
5236
5723
  */
@@ -5242,10 +5729,12 @@ export interface ListTestsRequest {
5242
5729
  */
5243
5730
  export interface ListTestsResult {
5244
5731
  /**
5732
+ * @public
5245
5733
  * <p>Information about the tests.</p>
5246
5734
  */
5247
5735
  tests?: Test[];
5248
5736
  /**
5737
+ * @public
5249
5738
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
5250
5739
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
5251
5740
  * list.</p>
@@ -5258,10 +5747,12 @@ export interface ListTestsResult {
5258
5747
  */
5259
5748
  export interface ListUniqueProblemsRequest {
5260
5749
  /**
5750
+ * @public
5261
5751
  * <p>The unique problems' ARNs.</p>
5262
5752
  */
5263
5753
  arn: string | undefined;
5264
5754
  /**
5755
+ * @public
5265
5756
  * <p>An identifier that was returned from the previous call to this operation, which can
5266
5757
  * be used to return the next set of items in the list.</p>
5267
5758
  */
@@ -5273,10 +5764,12 @@ export interface ListUniqueProblemsRequest {
5273
5764
  */
5274
5765
  export interface ProblemDetail {
5275
5766
  /**
5767
+ * @public
5276
5768
  * <p>The problem detail's ARN.</p>
5277
5769
  */
5278
5770
  arn?: string;
5279
5771
  /**
5772
+ * @public
5280
5773
  * <p>The problem detail's name.</p>
5281
5774
  */
5282
5775
  name?: string;
@@ -5287,26 +5780,32 @@ export interface ProblemDetail {
5287
5780
  */
5288
5781
  export interface Problem {
5289
5782
  /**
5783
+ * @public
5290
5784
  * <p>Information about the associated run.</p>
5291
5785
  */
5292
5786
  run?: ProblemDetail;
5293
5787
  /**
5788
+ * @public
5294
5789
  * <p>Information about the associated job.</p>
5295
5790
  */
5296
5791
  job?: ProblemDetail;
5297
5792
  /**
5793
+ * @public
5298
5794
  * <p>Information about the associated suite.</p>
5299
5795
  */
5300
5796
  suite?: ProblemDetail;
5301
5797
  /**
5798
+ * @public
5302
5799
  * <p>Information about the associated test.</p>
5303
5800
  */
5304
5801
  test?: ProblemDetail;
5305
5802
  /**
5803
+ * @public
5306
5804
  * <p>Information about the associated device.</p>
5307
5805
  */
5308
5806
  device?: Device;
5309
5807
  /**
5808
+ * @public
5310
5809
  * <p>The problem's result.</p>
5311
5810
  * <p>Allowed values include:</p>
5312
5811
  * <ul>
@@ -5335,6 +5834,7 @@ export interface Problem {
5335
5834
  */
5336
5835
  result?: ExecutionResult | string;
5337
5836
  /**
5837
+ * @public
5338
5838
  * <p>A message about the problem's result.</p>
5339
5839
  */
5340
5840
  message?: string;
@@ -5345,10 +5845,12 @@ export interface Problem {
5345
5845
  */
5346
5846
  export interface UniqueProblem {
5347
5847
  /**
5848
+ * @public
5348
5849
  * <p>A message about the unique problems' result.</p>
5349
5850
  */
5350
5851
  message?: string;
5351
5852
  /**
5853
+ * @public
5352
5854
  * <p>Information about the problems.</p>
5353
5855
  */
5354
5856
  problems?: Problem[];
@@ -5359,6 +5861,7 @@ export interface UniqueProblem {
5359
5861
  */
5360
5862
  export interface ListUniqueProblemsResult {
5361
5863
  /**
5864
+ * @public
5362
5865
  * <p>Information about the unique problems.</p>
5363
5866
  * <p>Allowed values include:</p>
5364
5867
  * <ul>
@@ -5387,6 +5890,7 @@ export interface ListUniqueProblemsResult {
5387
5890
  */
5388
5891
  uniqueProblems?: Record<string, UniqueProblem[]>;
5389
5892
  /**
5893
+ * @public
5390
5894
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
5391
5895
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
5392
5896
  * list.</p>
@@ -5399,11 +5903,13 @@ export interface ListUniqueProblemsResult {
5399
5903
  */
5400
5904
  export interface ListUploadsRequest {
5401
5905
  /**
5906
+ * @public
5402
5907
  * <p>The Amazon Resource Name (ARN) of the project for which you want to list
5403
5908
  * uploads.</p>
5404
5909
  */
5405
5910
  arn: string | undefined;
5406
5911
  /**
5912
+ * @public
5407
5913
  * <p>The type of upload.</p>
5408
5914
  * <p>Must be one of the following values:</p>
5409
5915
  * <ul>
@@ -5507,6 +6013,7 @@ export interface ListUploadsRequest {
5507
6013
  */
5508
6014
  type?: UploadType | string;
5509
6015
  /**
6016
+ * @public
5510
6017
  * <p>An identifier that was returned from the previous call to this operation, which can
5511
6018
  * be used to return the next set of items in the list.</p>
5512
6019
  */
@@ -5518,10 +6025,12 @@ export interface ListUploadsRequest {
5518
6025
  */
5519
6026
  export interface ListUploadsResult {
5520
6027
  /**
6028
+ * @public
5521
6029
  * <p>Information about the uploads.</p>
5522
6030
  */
5523
6031
  uploads?: Upload[];
5524
6032
  /**
6033
+ * @public
5525
6034
  * <p>If the number of items that are returned is significantly large, this is an identifier that is also
5526
6035
  * returned. It can be used in a subsequent call to this operation to return the next set of items in the
5527
6036
  * list.</p>
@@ -5533,10 +6042,12 @@ export interface ListUploadsResult {
5533
6042
  */
5534
6043
  export interface ListVPCEConfigurationsRequest {
5535
6044
  /**
6045
+ * @public
5536
6046
  * <p>An integer that specifies the maximum number of items you want to return in the API response.</p>
5537
6047
  */
5538
6048
  maxResults?: number;
5539
6049
  /**
6050
+ * @public
5540
6051
  * <p>An identifier that was returned from the previous call to this operation, which can be
5541
6052
  * used to return the next set of items in the list.</p>
5542
6053
  */
@@ -5547,11 +6058,13 @@ export interface ListVPCEConfigurationsRequest {
5547
6058
  */
5548
6059
  export interface ListVPCEConfigurationsResult {
5549
6060
  /**
6061
+ * @public
5550
6062
  * <p>An array of <code>VPCEConfiguration</code> objects that contain information about your VPC endpoint
5551
6063
  * configuration.</p>
5552
6064
  */
5553
6065
  vpceConfigurations?: VPCEConfiguration[];
5554
6066
  /**
6067
+ * @public
5555
6068
  * <p>An identifier that was returned from the previous call to this operation, which can be
5556
6069
  * used to return the next set of items in the list.</p>
5557
6070
  */
@@ -5563,14 +6076,17 @@ export interface ListVPCEConfigurationsResult {
5563
6076
  */
5564
6077
  export interface PurchaseOfferingRequest {
5565
6078
  /**
6079
+ * @public
5566
6080
  * <p>The ID of the offering.</p>
5567
6081
  */
5568
6082
  offeringId: string | undefined;
5569
6083
  /**
6084
+ * @public
5570
6085
  * <p>The number of device slots to purchase in an offering request.</p>
5571
6086
  */
5572
6087
  quantity: number | undefined;
5573
6088
  /**
6089
+ * @public
5574
6090
  * <p>The ID of the offering promotion to be applied to the purchase.</p>
5575
6091
  */
5576
6092
  offeringPromotionId?: string;
@@ -5581,6 +6097,7 @@ export interface PurchaseOfferingRequest {
5581
6097
  */
5582
6098
  export interface PurchaseOfferingResult {
5583
6099
  /**
6100
+ * @public
5584
6101
  * <p>Represents the offering transaction for the purchase result.</p>
5585
6102
  */
5586
6103
  offeringTransaction?: OfferingTransaction;
@@ -5591,10 +6108,12 @@ export interface PurchaseOfferingResult {
5591
6108
  */
5592
6109
  export interface RenewOfferingRequest {
5593
6110
  /**
6111
+ * @public
5594
6112
  * <p>The ID of a request to renew an offering.</p>
5595
6113
  */
5596
6114
  offeringId: string | undefined;
5597
6115
  /**
6116
+ * @public
5598
6117
  * <p>The quantity requested in an offering renewal.</p>
5599
6118
  */
5600
6119
  quantity: number | undefined;
@@ -5605,6 +6124,7 @@ export interface RenewOfferingRequest {
5605
6124
  */
5606
6125
  export interface RenewOfferingResult {
5607
6126
  /**
6127
+ * @public
5608
6128
  * <p>Represents the status of the offering transaction for the renewal.</p>
5609
6129
  */
5610
6130
  offeringTransaction?: OfferingTransaction;
@@ -5628,6 +6148,7 @@ export declare class IdempotencyException extends __BaseException {
5628
6148
  */
5629
6149
  export interface DeviceSelectionConfiguration {
5630
6150
  /**
6151
+ * @public
5631
6152
  * <p>Used to dynamically select a set of devices for a test run. A filter is made up of an
5632
6153
  * attribute, an operator, and one or more values.</p>
5633
6154
  * <ul>
@@ -5753,6 +6274,7 @@ export interface DeviceSelectionConfiguration {
5753
6274
  */
5754
6275
  filters: DeviceFilter[] | undefined;
5755
6276
  /**
6277
+ * @public
5756
6278
  * <p>The maximum number of devices to be included in a test run.</p>
5757
6279
  */
5758
6280
  maxDevices: number | undefined;
@@ -5764,22 +6286,27 @@ export interface DeviceSelectionConfiguration {
5764
6286
  */
5765
6287
  export interface ExecutionConfiguration {
5766
6288
  /**
6289
+ * @public
5767
6290
  * <p>The number of minutes a test run executes before it times out.</p>
5768
6291
  */
5769
6292
  jobTimeoutMinutes?: number;
5770
6293
  /**
6294
+ * @public
5771
6295
  * <p>True if account cleanup is enabled at the beginning of the test. Otherwise, false.</p>
5772
6296
  */
5773
6297
  accountsCleanup?: boolean;
5774
6298
  /**
6299
+ * @public
5775
6300
  * <p>True if app package cleanup is enabled at the beginning of the test. Otherwise, false.</p>
5776
6301
  */
5777
6302
  appPackagesCleanup?: boolean;
5778
6303
  /**
6304
+ * @public
5779
6305
  * <p>Set to true to enable video capture. Otherwise, set to false. The default is true.</p>
5780
6306
  */
5781
6307
  videoCapture?: boolean;
5782
6308
  /**
6309
+ * @public
5783
6310
  * <p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public
5784
6311
  * devices, Device Farm always signs your apps again.</p>
5785
6312
  * <p>For more information about how Device Farm re-signs your apps, see <a href="http://aws.amazon.com/device-farm/faqs/">Do you modify my app?</a> in the <i>AWS Device
@@ -5793,19 +6320,23 @@ export interface ExecutionConfiguration {
5793
6320
  */
5794
6321
  export interface ScheduleRunRequest {
5795
6322
  /**
6323
+ * @public
5796
6324
  * <p>The ARN of the project for the run to be scheduled.</p>
5797
6325
  */
5798
6326
  projectArn: string | undefined;
5799
6327
  /**
6328
+ * @public
5800
6329
  * <p>The ARN of an application package to run tests against, created with <a>CreateUpload</a>.
5801
6330
  * See <a>ListUploads</a>.</p>
5802
6331
  */
5803
6332
  appArn?: string;
5804
6333
  /**
6334
+ * @public
5805
6335
  * <p>The ARN of the device pool for the run to be scheduled.</p>
5806
6336
  */
5807
6337
  devicePoolArn?: string;
5808
6338
  /**
6339
+ * @public
5809
6340
  * <p>The filter criteria used to dynamically select a set of devices for a test run and the maximum number of
5810
6341
  * devices to be included in the run.</p>
5811
6342
  * <p>Either <b>
@@ -5817,18 +6348,22 @@ export interface ScheduleRunRequest {
5817
6348
  */
5818
6349
  deviceSelectionConfiguration?: DeviceSelectionConfiguration;
5819
6350
  /**
6351
+ * @public
5820
6352
  * <p>The name for the run to be scheduled.</p>
5821
6353
  */
5822
6354
  name?: string;
5823
6355
  /**
6356
+ * @public
5824
6357
  * <p>Information about the test for the run to be scheduled.</p>
5825
6358
  */
5826
6359
  test: ScheduleRunTest | undefined;
5827
6360
  /**
6361
+ * @public
5828
6362
  * <p>Information about the settings for the run to be scheduled.</p>
5829
6363
  */
5830
6364
  configuration?: ScheduleRunConfiguration;
5831
6365
  /**
6366
+ * @public
5832
6367
  * <p>Specifies configuration information about a test run, such as the execution timeout
5833
6368
  * (in minutes).</p>
5834
6369
  */
@@ -5840,6 +6375,7 @@ export interface ScheduleRunRequest {
5840
6375
  */
5841
6376
  export interface ScheduleRunResult {
5842
6377
  /**
6378
+ * @public
5843
6379
  * <p>Information about the scheduled run.</p>
5844
6380
  */
5845
6381
  run?: Run;
@@ -5849,6 +6385,7 @@ export interface ScheduleRunResult {
5849
6385
  */
5850
6386
  export interface StopJobRequest {
5851
6387
  /**
6388
+ * @public
5852
6389
  * <p>Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.</p>
5853
6390
  */
5854
6391
  arn: string | undefined;
@@ -5858,6 +6395,7 @@ export interface StopJobRequest {
5858
6395
  */
5859
6396
  export interface StopJobResult {
5860
6397
  /**
6398
+ * @public
5861
6399
  * <p>The job that was stopped.</p>
5862
6400
  */
5863
6401
  job?: Job;
@@ -5868,6 +6406,7 @@ export interface StopJobResult {
5868
6406
  */
5869
6407
  export interface StopRemoteAccessSessionRequest {
5870
6408
  /**
6409
+ * @public
5871
6410
  * <p>The Amazon Resource Name (ARN) of the remote access session to stop.</p>
5872
6411
  */
5873
6412
  arn: string | undefined;
@@ -5879,6 +6418,7 @@ export interface StopRemoteAccessSessionRequest {
5879
6418
  */
5880
6419
  export interface StopRemoteAccessSessionResult {
5881
6420
  /**
6421
+ * @public
5882
6422
  * <p>A container that represents the metadata from the service about the remote access session you are
5883
6423
  * stopping.</p>
5884
6424
  */
@@ -5890,6 +6430,7 @@ export interface StopRemoteAccessSessionResult {
5890
6430
  */
5891
6431
  export interface StopRunRequest {
5892
6432
  /**
6433
+ * @public
5893
6434
  * <p>Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.</p>
5894
6435
  */
5895
6436
  arn: string | undefined;
@@ -5900,6 +6441,7 @@ export interface StopRunRequest {
5900
6441
  */
5901
6442
  export interface StopRunResult {
5902
6443
  /**
6444
+ * @public
5903
6445
  * <p>The run that was stopped.</p>
5904
6446
  */
5905
6447
  run?: Run;
@@ -5923,6 +6465,7 @@ export declare class TagPolicyException extends __BaseException {
5923
6465
  */
5924
6466
  export interface TagResourceRequest {
5925
6467
  /**
6468
+ * @public
5926
6469
  * <p>The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags
5927
6470
  * with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>,
5928
6471
  * <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>,
@@ -5931,6 +6474,7 @@ export interface TagResourceRequest {
5931
6474
  */
5932
6475
  ResourceARN: string | undefined;
5933
6476
  /**
6477
+ * @public
5934
6478
  * <p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum
5935
6479
  * character length of 128 characters. Tag values can have a maximum length of 256 characters.</p>
5936
6480
  */
@@ -5960,6 +6504,7 @@ export declare class TooManyTagsException extends __BaseException {
5960
6504
  */
5961
6505
  export interface UntagResourceRequest {
5962
6506
  /**
6507
+ * @public
5963
6508
  * <p>The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate
5964
6509
  * tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>,
5965
6510
  * <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>,
@@ -5968,6 +6513,7 @@ export interface UntagResourceRequest {
5968
6513
  */
5969
6514
  ResourceARN: string | undefined;
5970
6515
  /**
6516
+ * @public
5971
6517
  * <p>The keys of the tags to be removed.</p>
5972
6518
  */
5973
6519
  TagKeys: string[] | undefined;
@@ -5982,14 +6528,17 @@ export interface UntagResourceResponse {
5982
6528
  */
5983
6529
  export interface UpdateDeviceInstanceRequest {
5984
6530
  /**
6531
+ * @public
5985
6532
  * <p>The Amazon Resource Name (ARN) of the device instance.</p>
5986
6533
  */
5987
6534
  arn: string | undefined;
5988
6535
  /**
6536
+ * @public
5989
6537
  * <p>The ARN of the profile that you want to associate with the device instance.</p>
5990
6538
  */
5991
6539
  profileArn?: string;
5992
6540
  /**
6541
+ * @public
5993
6542
  * <p>An array of strings that you want to associate with the device instance.</p>
5994
6543
  */
5995
6544
  labels?: string[];
@@ -5999,6 +6548,7 @@ export interface UpdateDeviceInstanceRequest {
5999
6548
  */
6000
6549
  export interface UpdateDeviceInstanceResult {
6001
6550
  /**
6551
+ * @public
6002
6552
  * <p>An object that contains information about your device instance.</p>
6003
6553
  */
6004
6554
  deviceInstance?: DeviceInstance;
@@ -6009,23 +6559,28 @@ export interface UpdateDeviceInstanceResult {
6009
6559
  */
6010
6560
  export interface UpdateDevicePoolRequest {
6011
6561
  /**
6562
+ * @public
6012
6563
  * <p>The Amazon Resource Name (ARN) of the Device Farm device pool to update.</p>
6013
6564
  */
6014
6565
  arn: string | undefined;
6015
6566
  /**
6567
+ * @public
6016
6568
  * <p>A string that represents the name of the device pool to update.</p>
6017
6569
  */
6018
6570
  name?: string;
6019
6571
  /**
6572
+ * @public
6020
6573
  * <p>A description of the device pool to update.</p>
6021
6574
  */
6022
6575
  description?: string;
6023
6576
  /**
6577
+ * @public
6024
6578
  * <p>Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for
6025
6579
  * your request, the update replaces the existing rules.</p>
6026
6580
  */
6027
6581
  rules?: Rule[];
6028
6582
  /**
6583
+ * @public
6029
6584
  * <p>The number of devices that Device Farm can add to your device pool. Device Farm adds
6030
6585
  * devices that are available and that meet the criteria that you assign for the
6031
6586
  * <code>rules</code> parameter. Depending on how many devices meet these constraints,
@@ -6037,6 +6592,7 @@ export interface UpdateDevicePoolRequest {
6037
6592
  */
6038
6593
  maxDevices?: number;
6039
6594
  /**
6595
+ * @public
6040
6596
  * <p>Sets whether the <code>maxDevices</code> parameter applies to your device pool. If you set this parameter
6041
6597
  * to <code>true</code>, the <code>maxDevices</code> parameter does not apply, and Device Farm does not limit
6042
6598
  * the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices
@@ -6052,6 +6608,7 @@ export interface UpdateDevicePoolRequest {
6052
6608
  */
6053
6609
  export interface UpdateDevicePoolResult {
6054
6610
  /**
6611
+ * @public
6055
6612
  * <p>The device pool you just updated.</p>
6056
6613
  */
6057
6614
  devicePool?: DevicePool;
@@ -6061,23 +6618,28 @@ export interface UpdateDevicePoolResult {
6061
6618
  */
6062
6619
  export interface UpdateInstanceProfileRequest {
6063
6620
  /**
6621
+ * @public
6064
6622
  * <p>The Amazon Resource Name (ARN) of the instance profile.</p>
6065
6623
  */
6066
6624
  arn: string | undefined;
6067
6625
  /**
6626
+ * @public
6068
6627
  * <p>The updated name for your instance profile.</p>
6069
6628
  */
6070
6629
  name?: string;
6071
6630
  /**
6631
+ * @public
6072
6632
  * <p>The updated description for your instance profile.</p>
6073
6633
  */
6074
6634
  description?: string;
6075
6635
  /**
6636
+ * @public
6076
6637
  * <p>The updated choice for whether you want to specify package cleanup. The default value
6077
6638
  * is <code>false</code> for private devices.</p>
6078
6639
  */
6079
6640
  packageCleanup?: boolean;
6080
6641
  /**
6642
+ * @public
6081
6643
  * <p>An array of strings that specifies the list of app packages that should not be cleaned up from the device
6082
6644
  * after a test run is over.</p>
6083
6645
  * <p>The list of packages is only considered if you set <code>packageCleanup</code> to
@@ -6085,6 +6647,7 @@ export interface UpdateInstanceProfileRequest {
6085
6647
  */
6086
6648
  excludeAppPackagesFromCleanup?: string[];
6087
6649
  /**
6650
+ * @public
6088
6651
  * <p>The updated choice for whether you want to reboot the device after use. The default
6089
6652
  * value is <code>true</code>.</p>
6090
6653
  */
@@ -6095,6 +6658,7 @@ export interface UpdateInstanceProfileRequest {
6095
6658
  */
6096
6659
  export interface UpdateInstanceProfileResult {
6097
6660
  /**
6661
+ * @public
6098
6662
  * <p>An object that contains information about your instance profile.</p>
6099
6663
  */
6100
6664
  instanceProfile?: InstanceProfile;
@@ -6104,60 +6668,72 @@ export interface UpdateInstanceProfileResult {
6104
6668
  */
6105
6669
  export interface UpdateNetworkProfileRequest {
6106
6670
  /**
6671
+ * @public
6107
6672
  * <p>The Amazon Resource Name (ARN) of the project for which you want to update network
6108
6673
  * profile settings.</p>
6109
6674
  */
6110
6675
  arn: string | undefined;
6111
6676
  /**
6677
+ * @public
6112
6678
  * <p>The name of the network profile about which you are returning
6113
6679
  * information.</p>
6114
6680
  */
6115
6681
  name?: string;
6116
6682
  /**
6683
+ * @public
6117
6684
  * <p>The description of the network profile about which you are returning
6118
6685
  * information.</p>
6119
6686
  */
6120
6687
  description?: string;
6121
6688
  /**
6689
+ * @public
6122
6690
  * <p>The type of network profile to return information about. Valid values are listed here.</p>
6123
6691
  */
6124
6692
  type?: NetworkProfileType | string;
6125
6693
  /**
6694
+ * @public
6126
6695
  * <p>The data throughput rate in bits per second, as an integer from 0 to
6127
6696
  * 104857600.</p>
6128
6697
  */
6129
6698
  uplinkBandwidthBits?: number;
6130
6699
  /**
6700
+ * @public
6131
6701
  * <p>The data throughput rate in bits per second, as an integer from 0 to
6132
6702
  * 104857600.</p>
6133
6703
  */
6134
6704
  downlinkBandwidthBits?: number;
6135
6705
  /**
6706
+ * @public
6136
6707
  * <p>Delay time for all packets to destination in milliseconds as an integer from 0 to
6137
6708
  * 2000.</p>
6138
6709
  */
6139
6710
  uplinkDelayMs?: number;
6140
6711
  /**
6712
+ * @public
6141
6713
  * <p>Delay time for all packets to destination in milliseconds as an integer from 0 to
6142
6714
  * 2000.</p>
6143
6715
  */
6144
6716
  downlinkDelayMs?: number;
6145
6717
  /**
6718
+ * @public
6146
6719
  * <p>Time variation in the delay of received packets in milliseconds as an integer from
6147
6720
  * 0 to 2000.</p>
6148
6721
  */
6149
6722
  uplinkJitterMs?: number;
6150
6723
  /**
6724
+ * @public
6151
6725
  * <p>Time variation in the delay of received packets in milliseconds as an integer from
6152
6726
  * 0 to 2000.</p>
6153
6727
  */
6154
6728
  downlinkJitterMs?: number;
6155
6729
  /**
6730
+ * @public
6156
6731
  * <p>Proportion of transmitted packets that fail to arrive from 0 to 100
6157
6732
  * percent.</p>
6158
6733
  */
6159
6734
  uplinkLossPercent?: number;
6160
6735
  /**
6736
+ * @public
6161
6737
  * <p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>
6162
6738
  */
6163
6739
  downlinkLossPercent?: number;
@@ -6167,6 +6743,7 @@ export interface UpdateNetworkProfileRequest {
6167
6743
  */
6168
6744
  export interface UpdateNetworkProfileResult {
6169
6745
  /**
6746
+ * @public
6170
6747
  * <p>A list of the available network profiles.</p>
6171
6748
  */
6172
6749
  networkProfile?: NetworkProfile;
@@ -6177,18 +6754,22 @@ export interface UpdateNetworkProfileResult {
6177
6754
  */
6178
6755
  export interface UpdateProjectRequest {
6179
6756
  /**
6757
+ * @public
6180
6758
  * <p>The Amazon Resource Name (ARN) of the project whose name to update.</p>
6181
6759
  */
6182
6760
  arn: string | undefined;
6183
6761
  /**
6762
+ * @public
6184
6763
  * <p>A string that represents the new name of the project that you are updating.</p>
6185
6764
  */
6186
6765
  name?: string;
6187
6766
  /**
6767
+ * @public
6188
6768
  * <p>The number of minutes a test run in the project executes before it times out.</p>
6189
6769
  */
6190
6770
  defaultJobTimeoutMinutes?: number;
6191
6771
  /**
6772
+ * @public
6192
6773
  * <p>The VPC security groups and subnets that are attached to a project.</p>
6193
6774
  */
6194
6775
  vpcConfig?: VpcConfig;
@@ -6199,6 +6780,7 @@ export interface UpdateProjectRequest {
6199
6780
  */
6200
6781
  export interface UpdateProjectResult {
6201
6782
  /**
6783
+ * @public
6202
6784
  * <p>The project to update.</p>
6203
6785
  */
6204
6786
  project?: Project;
@@ -6208,18 +6790,22 @@ export interface UpdateProjectResult {
6208
6790
  */
6209
6791
  export interface UpdateTestGridProjectRequest {
6210
6792
  /**
6793
+ * @public
6211
6794
  * <p>ARN of the project to update.</p>
6212
6795
  */
6213
6796
  projectArn: string | undefined;
6214
6797
  /**
6798
+ * @public
6215
6799
  * <p>Human-readable name for the project.</p>
6216
6800
  */
6217
6801
  name?: string;
6218
6802
  /**
6803
+ * @public
6219
6804
  * <p>Human-readable description for the project.</p>
6220
6805
  */
6221
6806
  description?: string;
6222
6807
  /**
6808
+ * @public
6223
6809
  * <p>The VPC security groups and subnets that are attached to a project.</p>
6224
6810
  */
6225
6811
  vpcConfig?: TestGridVpcConfig;
@@ -6229,6 +6815,7 @@ export interface UpdateTestGridProjectRequest {
6229
6815
  */
6230
6816
  export interface UpdateTestGridProjectResult {
6231
6817
  /**
6818
+ * @public
6232
6819
  * <p>The project, including updated information.</p>
6233
6820
  */
6234
6821
  testGridProject?: TestGridProject;
@@ -6238,19 +6825,23 @@ export interface UpdateTestGridProjectResult {
6238
6825
  */
6239
6826
  export interface UpdateUploadRequest {
6240
6827
  /**
6828
+ * @public
6241
6829
  * <p>The Amazon Resource Name (ARN) of the uploaded test spec.</p>
6242
6830
  */
6243
6831
  arn: string | undefined;
6244
6832
  /**
6833
+ * @public
6245
6834
  * <p>The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file
6246
6835
  * name must end with the <code>.yaml</code> or <code>.yml</code> file extension.</p>
6247
6836
  */
6248
6837
  name?: string;
6249
6838
  /**
6839
+ * @public
6250
6840
  * <p>The upload's content type (for example, <code>application/x-yaml</code>).</p>
6251
6841
  */
6252
6842
  contentType?: string;
6253
6843
  /**
6844
+ * @public
6254
6845
  * <p>Set to true if the YAML file has changed and must be updated. Otherwise, set to false.</p>
6255
6846
  */
6256
6847
  editContent?: boolean;
@@ -6260,6 +6851,7 @@ export interface UpdateUploadRequest {
6260
6851
  */
6261
6852
  export interface UpdateUploadResult {
6262
6853
  /**
6854
+ * @public
6263
6855
  * <p>A test spec uploaded to Device Farm.</p>
6264
6856
  */
6265
6857
  upload?: Upload;
@@ -6269,25 +6861,30 @@ export interface UpdateUploadResult {
6269
6861
  */
6270
6862
  export interface UpdateVPCEConfigurationRequest {
6271
6863
  /**
6864
+ * @public
6272
6865
  * <p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
6273
6866
  * update.</p>
6274
6867
  */
6275
6868
  arn: string | undefined;
6276
6869
  /**
6870
+ * @public
6277
6871
  * <p>The friendly name you give to your VPC endpoint configuration to manage your configurations more
6278
6872
  * easily.</p>
6279
6873
  */
6280
6874
  vpceConfigurationName?: string;
6281
6875
  /**
6876
+ * @public
6282
6877
  * <p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>
6283
6878
  */
6284
6879
  vpceServiceName?: string;
6285
6880
  /**
6881
+ * @public
6286
6882
  * <p>The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already
6287
6883
  * be in use on the internet.</p>
6288
6884
  */
6289
6885
  serviceDnsName?: string;
6290
6886
  /**
6887
+ * @public
6291
6888
  * <p>An optional description that provides details about your VPC endpoint configuration.</p>
6292
6889
  */
6293
6890
  vpceConfigurationDescription?: string;
@@ -6297,6 +6894,7 @@ export interface UpdateVPCEConfigurationRequest {
6297
6894
  */
6298
6895
  export interface UpdateVPCEConfigurationResult {
6299
6896
  /**
6897
+ * @public
6300
6898
  * <p>An object that contains information about your VPC endpoint configuration.</p>
6301
6899
  */
6302
6900
  vpceConfiguration?: VPCEConfiguration;