@alicloud/emr-serverless-spark20230808 1.4.1 → 1.4.2

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.
package/dist/client.d.ts CHANGED
@@ -1,17 +1,44 @@
1
1
  /**
2
- *
3
2
  */
4
3
  import * as $Util from '@alicloud/tea-util';
5
4
  import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
6
5
  import * as $tea from '@alicloud/tea-typescript';
7
6
  export declare class Artifact extends $tea.Model {
7
+ /**
8
+ * @remarks
9
+ * This parameter is required.
10
+ */
8
11
  bizId?: string;
12
+ /**
13
+ * @remarks
14
+ * This parameter is required.
15
+ */
9
16
  creator?: number;
10
17
  credential?: Credential;
18
+ /**
19
+ * @remarks
20
+ * This parameter is required.
21
+ */
11
22
  gmtCreated?: string;
23
+ /**
24
+ * @remarks
25
+ * This parameter is required.
26
+ */
12
27
  gmtModified?: string;
28
+ /**
29
+ * @remarks
30
+ * This parameter is required.
31
+ */
13
32
  location?: string;
33
+ /**
34
+ * @remarks
35
+ * This parameter is required.
36
+ */
14
37
  modifier?: number;
38
+ /**
39
+ * @remarks
40
+ * This parameter is required.
41
+ */
15
42
  name?: string;
16
43
  static names(): {
17
44
  [key: string]: string;
@@ -24,13 +51,41 @@ export declare class Artifact extends $tea.Model {
24
51
  });
25
52
  }
26
53
  export declare class Category extends $tea.Model {
54
+ /**
55
+ * @remarks
56
+ * This parameter is required.
57
+ */
27
58
  bizId?: string;
59
+ /**
60
+ * @remarks
61
+ * This parameter is required.
62
+ */
28
63
  creator?: number;
64
+ /**
65
+ * @remarks
66
+ * This parameter is required.
67
+ */
29
68
  gmtCreated?: string;
69
+ /**
70
+ * @remarks
71
+ * This parameter is required.
72
+ */
30
73
  gmtModified?: string;
74
+ /**
75
+ * @remarks
76
+ * This parameter is required.
77
+ */
31
78
  modifier?: number;
79
+ /**
80
+ * @remarks
81
+ * This parameter is required.
82
+ */
32
83
  name?: string;
33
84
  parentBizId?: string;
85
+ /**
86
+ * @remarks
87
+ * This parameter is required.
88
+ */
34
89
  type?: string;
35
90
  static names(): {
36
91
  [key: string]: string;
@@ -69,12 +124,40 @@ export declare class ConfigurationOverrides extends $tea.Model {
69
124
  });
70
125
  }
71
126
  export declare class Credential extends $tea.Model {
127
+ /**
128
+ * @remarks
129
+ * This parameter is required.
130
+ */
72
131
  accessId?: string;
132
+ /**
133
+ * @remarks
134
+ * This parameter is required.
135
+ */
73
136
  dir?: string;
137
+ /**
138
+ * @remarks
139
+ * This parameter is required.
140
+ */
74
141
  expire?: string;
142
+ /**
143
+ * @remarks
144
+ * This parameter is required.
145
+ */
75
146
  host?: string;
147
+ /**
148
+ * @remarks
149
+ * This parameter is required.
150
+ */
76
151
  policy?: string;
152
+ /**
153
+ * @remarks
154
+ * This parameter is required.
155
+ */
77
156
  securityToken?: string;
157
+ /**
158
+ * @remarks
159
+ * This parameter is required.
160
+ */
78
161
  signature?: string;
79
162
  static names(): {
80
163
  [key: string]: string;
@@ -99,7 +182,15 @@ export declare class JobDriver extends $tea.Model {
99
182
  });
100
183
  }
101
184
  export declare class PrincipalAction extends $tea.Model {
185
+ /**
186
+ * @example
187
+ * acs:emr::workspaceId:action/create_queue
188
+ */
102
189
  actionArn?: string;
190
+ /**
191
+ * @example
192
+ * acs:emr::workspaceId:user/237593691541622267
193
+ */
103
194
  principalArn?: string;
104
195
  static names(): {
105
196
  [key: string]: string;
@@ -141,7 +232,15 @@ export declare class RunLog extends $tea.Model {
141
232
  });
142
233
  }
143
234
  export declare class SparkConf extends $tea.Model {
235
+ /**
236
+ * @remarks
237
+ * This parameter is required.
238
+ */
144
239
  key?: string;
240
+ /**
241
+ * @remarks
242
+ * This parameter is required.
243
+ */
145
244
  value?: string;
146
245
  static names(): {
147
246
  [key: string]: string;
@@ -167,7 +266,21 @@ export declare class SqlOutput extends $tea.Model {
167
266
  });
168
267
  }
169
268
  export declare class Tag extends $tea.Model {
269
+ /**
270
+ * @remarks
271
+ * 标签key值。
272
+ *
273
+ * @example
274
+ * workflowId
275
+ */
170
276
  key?: string;
277
+ /**
278
+ * @remarks
279
+ * 标签key值。
280
+ *
281
+ * @example
282
+ * wf-123test
283
+ */
171
284
  value?: string;
172
285
  static names(): {
173
286
  [key: string]: string;
@@ -182,9 +295,17 @@ export declare class Tag extends $tea.Model {
182
295
  export declare class Task extends $tea.Model {
183
296
  archives?: string[];
184
297
  artifactUrl?: string;
298
+ /**
299
+ * @remarks
300
+ * This parameter is required.
301
+ */
185
302
  bizId?: string;
186
303
  categoryBizId?: string;
187
304
  content?: string;
305
+ /**
306
+ * @remarks
307
+ * This parameter is required.
308
+ */
188
309
  creator?: number;
189
310
  defaultCatalogId?: string;
190
311
  defaultDatabase?: string;
@@ -194,30 +315,87 @@ export declare class Task extends $tea.Model {
194
315
  extraArtifactIds?: string[];
195
316
  extraSparkSubmitParams?: string;
196
317
  files?: string[];
318
+ fusion?: boolean;
319
+ /**
320
+ * @remarks
321
+ * This parameter is required.
322
+ */
197
323
  gmtCreated?: string;
324
+ /**
325
+ * @remarks
326
+ * This parameter is required.
327
+ */
198
328
  gmtModified?: string;
199
329
  hasChanged?: boolean;
330
+ /**
331
+ * @remarks
332
+ * This parameter is required.
333
+ */
200
334
  hasCommited?: boolean;
201
335
  isStreaming?: boolean;
202
336
  jars?: string[];
203
337
  lastRunResourceQueueId?: string;
338
+ /**
339
+ * @remarks
340
+ * This parameter is required.
341
+ */
204
342
  modifier?: number;
343
+ /**
344
+ * @remarks
345
+ * This parameter is required.
346
+ */
205
347
  name?: string;
206
348
  pyFiles?: string[];
349
+ /**
350
+ * @example
351
+ * 100
352
+ */
207
353
  sparkArgs?: string;
208
354
  sparkConf?: SparkConf[];
355
+ /**
356
+ * @remarks
357
+ * This parameter is required.
358
+ */
209
359
  sparkDriverCores?: number;
360
+ /**
361
+ * @remarks
362
+ * This parameter is required.
363
+ */
210
364
  sparkDriverMemory?: number;
211
365
  sparkEntrypoint?: string;
366
+ /**
367
+ * @remarks
368
+ * This parameter is required.
369
+ */
212
370
  sparkExecutorCores?: number;
371
+ /**
372
+ * @remarks
373
+ * This parameter is required.
374
+ */
213
375
  sparkExecutorMemory?: number;
376
+ /**
377
+ * @remarks
378
+ * This parameter is required.
379
+ */
214
380
  sparkLogLevel?: string;
381
+ /**
382
+ * @remarks
383
+ * This parameter is required.
384
+ */
215
385
  sparkLogPath?: string;
216
386
  sparkSubmitClause?: string;
387
+ /**
388
+ * @remarks
389
+ * This parameter is required.
390
+ */
217
391
  sparkVersion?: string;
218
392
  tags?: {
219
393
  [key: string]: string;
220
394
  };
395
+ /**
396
+ * @remarks
397
+ * This parameter is required.
398
+ */
221
399
  type?: string;
222
400
  static names(): {
223
401
  [key: string]: string;
@@ -267,17 +445,63 @@ export declare class TaskSnapshot extends $tea.Model {
267
445
  });
268
446
  }
269
447
  export declare class Template extends $tea.Model {
448
+ /**
449
+ * @remarks
450
+ * This parameter is required.
451
+ */
270
452
  creator?: number;
453
+ displaySparkVersion?: string;
454
+ fusion?: boolean;
455
+ /**
456
+ * @remarks
457
+ * This parameter is required.
458
+ */
271
459
  gmtCreated?: string;
460
+ /**
461
+ * @remarks
462
+ * This parameter is required.
463
+ */
272
464
  gmtModified?: string;
465
+ /**
466
+ * @remarks
467
+ * This parameter is required.
468
+ */
273
469
  modifier?: number;
274
470
  sparkConf?: SparkConf[];
471
+ /**
472
+ * @remarks
473
+ * This parameter is required.
474
+ */
275
475
  sparkDriverCores?: number;
476
+ /**
477
+ * @remarks
478
+ * This parameter is required.
479
+ */
276
480
  sparkDriverMemory?: number;
481
+ /**
482
+ * @remarks
483
+ * This parameter is required.
484
+ */
277
485
  sparkExecutorCores?: number;
486
+ /**
487
+ * @remarks
488
+ * This parameter is required.
489
+ */
278
490
  sparkExecutorMemory?: number;
491
+ /**
492
+ * @remarks
493
+ * This parameter is required.
494
+ */
279
495
  sparkLogLevel?: string;
496
+ /**
497
+ * @remarks
498
+ * This parameter is required.
499
+ */
280
500
  sparkLogPath?: string;
501
+ /**
502
+ * @remarks
503
+ * This parameter is required.
504
+ */
281
505
  sparkVersion?: string;
282
506
  templateType?: string;
283
507
  static names(): {
@@ -291,7 +515,21 @@ export declare class Template extends $tea.Model {
291
515
  });
292
516
  }
293
517
  export declare class TimeRange extends $tea.Model {
518
+ /**
519
+ * @remarks
520
+ * 时间范围结束时间。
521
+ *
522
+ * @example
523
+ * 1688370894339
524
+ */
294
525
  endTime?: number;
526
+ /**
527
+ * @remarks
528
+ * 时间范围开始时间。
529
+ *
530
+ * @example
531
+ * 1688370894339
532
+ */
295
533
  startTime?: number;
296
534
  static names(): {
297
535
  [key: string]: string;
@@ -304,8 +542,28 @@ export declare class TimeRange extends $tea.Model {
304
542
  });
305
543
  }
306
544
  export declare class AddMembersRequest extends $tea.Model {
545
+ /**
546
+ * @remarks
547
+ * This parameter is required.
548
+ */
307
549
  memberArns?: string[];
550
+ /**
551
+ * @remarks
552
+ * The workspace ID.
553
+ *
554
+ * This parameter is required.
555
+ *
556
+ * @example
557
+ * w-975bcfda9625****
558
+ */
308
559
  workspaceId?: string;
560
+ /**
561
+ * @remarks
562
+ * The region ID.
563
+ *
564
+ * @example
565
+ * cn-hangzhou
566
+ */
309
567
  regionId?: string;
310
568
  static names(): {
311
569
  [key: string]: string;
@@ -318,6 +576,13 @@ export declare class AddMembersRequest extends $tea.Model {
318
576
  });
319
577
  }
320
578
  export declare class AddMembersResponseBody extends $tea.Model {
579
+ /**
580
+ * @remarks
581
+ * The request ID.
582
+ *
583
+ * @example
584
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
585
+ */
321
586
  requestId?: string;
322
587
  static names(): {
323
588
  [key: string]: string;
@@ -346,6 +611,13 @@ export declare class AddMembersResponse extends $tea.Model {
346
611
  });
347
612
  }
348
613
  export declare class CancelJobRunRequest extends $tea.Model {
614
+ /**
615
+ * @remarks
616
+ * The region ID.
617
+ *
618
+ * @example
619
+ * cn-hangzhou
620
+ */
349
621
  regionId?: string;
350
622
  static names(): {
351
623
  [key: string]: string;
@@ -358,7 +630,21 @@ export declare class CancelJobRunRequest extends $tea.Model {
358
630
  });
359
631
  }
360
632
  export declare class CancelJobRunResponseBody extends $tea.Model {
633
+ /**
634
+ * @remarks
635
+ * The job ID.
636
+ *
637
+ * @example
638
+ * jr-1a2bc3
639
+ */
361
640
  jobRunId?: string;
641
+ /**
642
+ * @remarks
643
+ * The request ID.
644
+ *
645
+ * @example
646
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
647
+ */
362
648
  requestId?: string;
363
649
  static names(): {
364
650
  [key: string]: string;
@@ -387,11 +673,53 @@ export declare class CancelJobRunResponse extends $tea.Model {
387
673
  });
388
674
  }
389
675
  export declare class CreateSqlStatementRequest extends $tea.Model {
676
+ /**
677
+ * @remarks
678
+ * The SQL code. You can specify one or more SQL statements.
679
+ *
680
+ * @example
681
+ * SHOW TABLES
682
+ */
390
683
  codeContent?: string;
684
+ /**
685
+ * @remarks
686
+ * The default Data Lake Formation (DLF) catalog ID.
687
+ *
688
+ * @example
689
+ * default_catalog
690
+ */
391
691
  defaultCatalog?: string;
692
+ /**
693
+ * @remarks
694
+ * The name of the default database.
695
+ *
696
+ * @example
697
+ * default
698
+ */
392
699
  defaultDatabase?: string;
700
+ /**
701
+ * @remarks
702
+ * The maximum number of entries to return. Valid values: 1 to 10000.
703
+ *
704
+ * @example
705
+ * 1000
706
+ */
393
707
  limit?: number;
708
+ /**
709
+ * @remarks
710
+ * The SQL compute ID. You can create an SQL compute in the workspace created in EMR Serverless Spark.
711
+ *
712
+ * @example
713
+ * sc-dfahdfjafhajd****
714
+ */
394
715
  sqlComputeId?: string;
716
+ /**
717
+ * @remarks
718
+ * The region ID.
719
+ *
720
+ * @example
721
+ * cn-hangzhou
722
+ */
395
723
  regionId?: string;
396
724
  static names(): {
397
725
  [key: string]: string;
@@ -404,7 +732,18 @@ export declare class CreateSqlStatementRequest extends $tea.Model {
404
732
  });
405
733
  }
406
734
  export declare class CreateSqlStatementResponseBody extends $tea.Model {
735
+ /**
736
+ * @remarks
737
+ * The data returned.
738
+ */
407
739
  data?: CreateSqlStatementResponseBodyData;
740
+ /**
741
+ * @remarks
742
+ * The request ID.
743
+ *
744
+ * @example
745
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
746
+ */
408
747
  requestId?: string;
409
748
  static names(): {
410
749
  [key: string]: string;
@@ -433,6 +772,13 @@ export declare class CreateSqlStatementResponse extends $tea.Model {
433
772
  });
434
773
  }
435
774
  export declare class GetJobRunRequest extends $tea.Model {
775
+ /**
776
+ * @remarks
777
+ * The region ID.
778
+ *
779
+ * @example
780
+ * cn-hangzhou
781
+ */
436
782
  regionId?: string;
437
783
  static names(): {
438
784
  [key: string]: string;
@@ -445,7 +791,18 @@ export declare class GetJobRunRequest extends $tea.Model {
445
791
  });
446
792
  }
447
793
  export declare class GetJobRunResponseBody extends $tea.Model {
794
+ /**
795
+ * @remarks
796
+ * The details of the job.
797
+ */
448
798
  jobRun?: GetJobRunResponseBodyJobRun;
799
+ /**
800
+ * @remarks
801
+ * The request ID.
802
+ *
803
+ * @example
804
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
805
+ */
449
806
  requestId?: string;
450
807
  static names(): {
451
808
  [key: string]: string;
@@ -474,6 +831,13 @@ export declare class GetJobRunResponse extends $tea.Model {
474
831
  });
475
832
  }
476
833
  export declare class GetSqlStatementRequest extends $tea.Model {
834
+ /**
835
+ * @remarks
836
+ * The region ID.
837
+ *
838
+ * @example
839
+ * cn-hangzhou
840
+ */
477
841
  regionId?: string;
478
842
  static names(): {
479
843
  [key: string]: string;
@@ -486,7 +850,18 @@ export declare class GetSqlStatementRequest extends $tea.Model {
486
850
  });
487
851
  }
488
852
  export declare class GetSqlStatementResponseBody extends $tea.Model {
853
+ /**
854
+ * @remarks
855
+ * The data returned.
856
+ */
489
857
  data?: GetSqlStatementResponseBodyData;
858
+ /**
859
+ * @remarks
860
+ * The request ID.
861
+ *
862
+ * @example
863
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
864
+ */
490
865
  requestId?: string;
491
866
  static names(): {
492
867
  [key: string]: string;
@@ -515,8 +890,22 @@ export declare class GetSqlStatementResponse extends $tea.Model {
515
890
  });
516
891
  }
517
892
  export declare class GrantRoleToUsersRequest extends $tea.Model {
893
+ /**
894
+ * @remarks
895
+ * The Alibaba Cloud Resource Name (ARN) of the role.
896
+ *
897
+ * @example
898
+ * acs:emr::w-975bcfda9625****:role/Owner
899
+ */
518
900
  roleArn?: string;
519
901
  userArns?: string[];
902
+ /**
903
+ * @remarks
904
+ * The region ID.
905
+ *
906
+ * @example
907
+ * cn-hangzhou
908
+ */
520
909
  regionId?: string;
521
910
  static names(): {
522
911
  [key: string]: string;
@@ -529,6 +918,13 @@ export declare class GrantRoleToUsersRequest extends $tea.Model {
529
918
  });
530
919
  }
531
920
  export declare class GrantRoleToUsersResponseBody extends $tea.Model {
921
+ /**
922
+ * @remarks
923
+ * The request ID.
924
+ *
925
+ * @example
926
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
927
+ */
532
928
  requestId?: string;
533
929
  static names(): {
534
930
  [key: string]: string;
@@ -557,17 +953,85 @@ export declare class GrantRoleToUsersResponse extends $tea.Model {
557
953
  });
558
954
  }
559
955
  export declare class ListJobRunsRequest extends $tea.Model {
956
+ /**
957
+ * @remarks
958
+ * The ID of the user who creates a Spark job.
959
+ *
960
+ * @example
961
+ * 1509789347011222
962
+ */
560
963
  creator?: string;
964
+ /**
965
+ * @remarks
966
+ * The range of end time.
967
+ */
561
968
  endTime?: ListJobRunsRequestEndTime;
562
969
  jobRunDeploymentId?: string;
970
+ /**
971
+ * @remarks
972
+ * The job ID.
973
+ *
974
+ * @example
975
+ * j-xxx
976
+ */
563
977
  jobRunId?: string;
978
+ /**
979
+ * @remarks
980
+ * The maximum number of entries to return.
981
+ *
982
+ * @example
983
+ * 20
984
+ */
564
985
  maxResults?: number;
986
+ /**
987
+ * @remarks
988
+ * The job name.
989
+ *
990
+ * @example
991
+ * emr-spark-demo-job
992
+ */
565
993
  name?: string;
994
+ /**
995
+ * @remarks
996
+ * The pagination token that is used in the request to retrieve a new page of results.
997
+ *
998
+ * @example
999
+ * DD6B1B2A-5837-5237-ABE4-FF0C89568980
1000
+ */
566
1001
  nextToken?: string;
1002
+ /**
1003
+ * @remarks
1004
+ * The region ID.
1005
+ *
1006
+ * @example
1007
+ * cn-hangzhou
1008
+ */
567
1009
  regionId?: string;
1010
+ /**
1011
+ * @remarks
1012
+ * The name of the resource queue on which the Spark jobs run.
1013
+ *
1014
+ * @example
1015
+ * dev_queue
1016
+ */
568
1017
  resourceQueueId?: string;
1018
+ /**
1019
+ * @remarks
1020
+ * The range of start time.
1021
+ */
569
1022
  startTime?: ListJobRunsRequestStartTime;
1023
+ /**
1024
+ * @remarks
1025
+ * The job states.
1026
+ *
1027
+ * @example
1028
+ * ["Running","Submitted"]
1029
+ */
570
1030
  states?: string[];
1031
+ /**
1032
+ * @remarks
1033
+ * The tags of the job.
1034
+ */
571
1035
  tags?: ListJobRunsRequestTags[];
572
1036
  static names(): {
573
1037
  [key: string]: string;
@@ -580,17 +1044,85 @@ export declare class ListJobRunsRequest extends $tea.Model {
580
1044
  });
581
1045
  }
582
1046
  export declare class ListJobRunsShrinkRequest extends $tea.Model {
1047
+ /**
1048
+ * @remarks
1049
+ * The ID of the user who creates a Spark job.
1050
+ *
1051
+ * @example
1052
+ * 1509789347011222
1053
+ */
583
1054
  creator?: string;
1055
+ /**
1056
+ * @remarks
1057
+ * The range of end time.
1058
+ */
584
1059
  endTimeShrink?: string;
585
1060
  jobRunDeploymentId?: string;
1061
+ /**
1062
+ * @remarks
1063
+ * The job ID.
1064
+ *
1065
+ * @example
1066
+ * j-xxx
1067
+ */
586
1068
  jobRunId?: string;
1069
+ /**
1070
+ * @remarks
1071
+ * The maximum number of entries to return.
1072
+ *
1073
+ * @example
1074
+ * 20
1075
+ */
587
1076
  maxResults?: number;
1077
+ /**
1078
+ * @remarks
1079
+ * The job name.
1080
+ *
1081
+ * @example
1082
+ * emr-spark-demo-job
1083
+ */
588
1084
  name?: string;
1085
+ /**
1086
+ * @remarks
1087
+ * The pagination token that is used in the request to retrieve a new page of results.
1088
+ *
1089
+ * @example
1090
+ * DD6B1B2A-5837-5237-ABE4-FF0C89568980
1091
+ */
589
1092
  nextToken?: string;
1093
+ /**
1094
+ * @remarks
1095
+ * The region ID.
1096
+ *
1097
+ * @example
1098
+ * cn-hangzhou
1099
+ */
590
1100
  regionId?: string;
1101
+ /**
1102
+ * @remarks
1103
+ * The name of the resource queue on which the Spark jobs run.
1104
+ *
1105
+ * @example
1106
+ * dev_queue
1107
+ */
591
1108
  resourceQueueId?: string;
1109
+ /**
1110
+ * @remarks
1111
+ * The range of start time.
1112
+ */
592
1113
  startTimeShrink?: string;
1114
+ /**
1115
+ * @remarks
1116
+ * The job states.
1117
+ *
1118
+ * @example
1119
+ * ["Running","Submitted"]
1120
+ */
593
1121
  statesShrink?: string;
1122
+ /**
1123
+ * @remarks
1124
+ * The tags of the job.
1125
+ */
594
1126
  tagsShrink?: string;
595
1127
  static names(): {
596
1128
  [key: string]: string;
@@ -603,10 +1135,42 @@ export declare class ListJobRunsShrinkRequest extends $tea.Model {
603
1135
  });
604
1136
  }
605
1137
  export declare class ListJobRunsResponseBody extends $tea.Model {
1138
+ /**
1139
+ * @remarks
1140
+ * The list of Spark jobs.
1141
+ */
606
1142
  jobRuns?: ListJobRunsResponseBodyJobRuns[];
1143
+ /**
1144
+ * @remarks
1145
+ * The maximum number of entries returned.
1146
+ *
1147
+ * @example
1148
+ * 20
1149
+ */
607
1150
  maxResults?: number;
1151
+ /**
1152
+ * @remarks
1153
+ * A pagination token. It can be used in the next request to retrieve a new page of results.
1154
+ *
1155
+ * @example
1156
+ * DD6B1B2A-5837-5237-ABE4-FF0C89568980
1157
+ */
608
1158
  nextToken?: string;
1159
+ /**
1160
+ * @remarks
1161
+ * The request ID.
1162
+ *
1163
+ * @example
1164
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
1165
+ */
609
1166
  requestId?: string;
1167
+ /**
1168
+ * @remarks
1169
+ * The total number of entries returned.
1170
+ *
1171
+ * @example
1172
+ * 200
1173
+ */
610
1174
  totalCount?: number;
611
1175
  static names(): {
612
1176
  [key: string]: string;
@@ -635,9 +1199,47 @@ export declare class ListJobRunsResponse extends $tea.Model {
635
1199
  });
636
1200
  }
637
1201
  export declare class ListReleaseVersionsRequest extends $tea.Model {
1202
+ /**
1203
+ * @remarks
1204
+ * The region ID.
1205
+ *
1206
+ * @example
1207
+ * cn-hangzhou
1208
+ */
638
1209
  regionId?: string;
1210
+ /**
1211
+ * @remarks
1212
+ * The type of the version.
1213
+ *
1214
+ * Valid values:
1215
+ *
1216
+ * * stable
1217
+ * * beta
1218
+ *
1219
+ * @example
1220
+ * stable
1221
+ */
639
1222
  releaseType?: string;
1223
+ /**
1224
+ * @remarks
1225
+ * The version of Serverless Spark.
1226
+ *
1227
+ * @example
1228
+ * esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)
1229
+ */
640
1230
  releaseVersion?: string;
1231
+ /**
1232
+ * @remarks
1233
+ * The status of the version. Valid values:
1234
+ *
1235
+ * Valid values:
1236
+ *
1237
+ * * ONLINE
1238
+ * * OFFLINE
1239
+ *
1240
+ * @example
1241
+ * ONLINE
1242
+ */
641
1243
  releaseVersionStatus?: string;
642
1244
  static names(): {
643
1245
  [key: string]: string;
@@ -650,10 +1252,42 @@ export declare class ListReleaseVersionsRequest extends $tea.Model {
650
1252
  });
651
1253
  }
652
1254
  export declare class ListReleaseVersionsResponseBody extends $tea.Model {
1255
+ /**
1256
+ * @remarks
1257
+ * The maximum number of entries returned.
1258
+ *
1259
+ * @example
1260
+ * 20
1261
+ */
653
1262
  maxResults?: number;
1263
+ /**
1264
+ * @remarks
1265
+ * A pagination token. It can be used in the next request to retrieve a new page of results.
1266
+ *
1267
+ * @example
1268
+ * 1
1269
+ */
654
1270
  nextToken?: string;
1271
+ /**
1272
+ * @remarks
1273
+ * The versions.
1274
+ */
655
1275
  releaseVersions?: ListReleaseVersionsResponseBodyReleaseVersions[];
1276
+ /**
1277
+ * @remarks
1278
+ * The request ID.
1279
+ *
1280
+ * @example
1281
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
1282
+ */
656
1283
  requestId?: string;
1284
+ /**
1285
+ * @remarks
1286
+ * The total number of entries returned.
1287
+ *
1288
+ * @example
1289
+ * 200
1290
+ */
657
1291
  totalCount?: number;
658
1292
  static names(): {
659
1293
  [key: string]: string;
@@ -683,10 +1317,45 @@ export declare class ListReleaseVersionsResponse extends $tea.Model {
683
1317
  }
684
1318
  export declare class ListSessionClustersRequest extends $tea.Model {
685
1319
  kind?: string;
1320
+ /**
1321
+ * @remarks
1322
+ * The maximum number of entries to return.
1323
+ *
1324
+ * @example
1325
+ * 20
1326
+ */
686
1327
  maxResults?: number;
1328
+ /**
1329
+ * @remarks
1330
+ * The pagination token that is used in the request to retrieve a new page of results.
1331
+ *
1332
+ * @example
1333
+ * DD6B1B2A-5837-5237-ABE4-FF0C89568980
1334
+ */
687
1335
  nextToken?: string;
1336
+ /**
1337
+ * @remarks
1338
+ * The name of the queue.
1339
+ *
1340
+ * @example
1341
+ * root
1342
+ */
688
1343
  queueName?: string;
1344
+ /**
1345
+ * @remarks
1346
+ * The region ID.
1347
+ *
1348
+ * @example
1349
+ * cn-hangzhou
1350
+ */
689
1351
  regionId?: string;
1352
+ /**
1353
+ * @remarks
1354
+ * The name of the job.
1355
+ *
1356
+ * @example
1357
+ * emr-spark-demo-job
1358
+ */
690
1359
  sessionClusterId?: string;
691
1360
  static names(): {
692
1361
  [key: string]: string;
@@ -699,10 +1368,42 @@ export declare class ListSessionClustersRequest extends $tea.Model {
699
1368
  });
700
1369
  }
701
1370
  export declare class ListSessionClustersResponseBody extends $tea.Model {
1371
+ /**
1372
+ * @remarks
1373
+ * The maximum number of entries returned.
1374
+ *
1375
+ * @example
1376
+ * 20
1377
+ */
702
1378
  maxResults?: number;
1379
+ /**
1380
+ * @remarks
1381
+ * A pagination token. It can be used in the next request to retrieve a new page of results.
1382
+ *
1383
+ * @example
1384
+ * DD6B1B2A-5837-5237-ABE4-FF0C89568980
1385
+ */
703
1386
  nextToken?: string;
1387
+ /**
1388
+ * @remarks
1389
+ * The request ID.
1390
+ *
1391
+ * @example
1392
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
1393
+ */
704
1394
  requestId?: string;
1395
+ /**
1396
+ * @remarks
1397
+ * The SQL computes.
1398
+ */
705
1399
  sessionClusters?: ListSessionClustersResponseBodySessionClusters[];
1400
+ /**
1401
+ * @remarks
1402
+ * The total number of entries returned.
1403
+ *
1404
+ * @example
1405
+ * 200
1406
+ */
706
1407
  totalCount?: number;
707
1408
  static names(): {
708
1409
  [key: string]: string;
@@ -731,7 +1432,26 @@ export declare class ListSessionClustersResponse extends $tea.Model {
731
1432
  });
732
1433
  }
733
1434
  export declare class ListWorkspaceQueuesRequest extends $tea.Model {
1435
+ /**
1436
+ * @remarks
1437
+ * The environment type.
1438
+ *
1439
+ * Valid values:
1440
+ *
1441
+ * * dev
1442
+ * * production
1443
+ *
1444
+ * @example
1445
+ * production
1446
+ */
734
1447
  environment?: string;
1448
+ /**
1449
+ * @remarks
1450
+ * The region ID.
1451
+ *
1452
+ * @example
1453
+ * cn-hangzhou
1454
+ */
735
1455
  regionId?: string;
736
1456
  static names(): {
737
1457
  [key: string]: string;
@@ -744,10 +1464,42 @@ export declare class ListWorkspaceQueuesRequest extends $tea.Model {
744
1464
  });
745
1465
  }
746
1466
  export declare class ListWorkspaceQueuesResponseBody extends $tea.Model {
1467
+ /**
1468
+ * @remarks
1469
+ * The maximum number of entries returned.
1470
+ *
1471
+ * @example
1472
+ * 20
1473
+ */
747
1474
  maxResults?: number;
1475
+ /**
1476
+ * @remarks
1477
+ * A pagination token. It can be used in the next request to retrieve a new page of results.
1478
+ *
1479
+ * @example
1480
+ * 1
1481
+ */
748
1482
  nextToken?: string;
1483
+ /**
1484
+ * @remarks
1485
+ * The list of queues.
1486
+ */
749
1487
  queues?: ListWorkspaceQueuesResponseBodyQueues[];
1488
+ /**
1489
+ * @remarks
1490
+ * The request ID.
1491
+ *
1492
+ * @example
1493
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
1494
+ */
750
1495
  requestId?: string;
1496
+ /**
1497
+ * @remarks
1498
+ * The total number of entries returned.
1499
+ *
1500
+ * @example
1501
+ * 200
1502
+ */
751
1503
  totalCount?: number;
752
1504
  static names(): {
753
1505
  [key: string]: string;
@@ -776,10 +1528,45 @@ export declare class ListWorkspaceQueuesResponse extends $tea.Model {
776
1528
  });
777
1529
  }
778
1530
  export declare class ListWorkspacesRequest extends $tea.Model {
1531
+ /**
1532
+ * @remarks
1533
+ * The maximum number of entries to return.
1534
+ *
1535
+ * @example
1536
+ * 20
1537
+ */
779
1538
  maxResults?: number;
1539
+ /**
1540
+ * @remarks
1541
+ * Fuzzy match is supported.
1542
+ *
1543
+ * @example
1544
+ * test_workspace
1545
+ */
780
1546
  name?: string;
1547
+ /**
1548
+ * @remarks
1549
+ * The pagination token that is used in the next request to retrieve a new page of results.
1550
+ *
1551
+ * @example
1552
+ * 1
1553
+ */
781
1554
  nextToken?: string;
1555
+ /**
1556
+ * @remarks
1557
+ * The region ID.
1558
+ *
1559
+ * @example
1560
+ * cn-hangzhou
1561
+ */
782
1562
  regionId?: string;
1563
+ /**
1564
+ * @remarks
1565
+ * The workspace status.
1566
+ *
1567
+ * @example
1568
+ * running
1569
+ */
783
1570
  state?: string;
784
1571
  static names(): {
785
1572
  [key: string]: string;
@@ -792,10 +1579,42 @@ export declare class ListWorkspacesRequest extends $tea.Model {
792
1579
  });
793
1580
  }
794
1581
  export declare class ListWorkspacesResponseBody extends $tea.Model {
1582
+ /**
1583
+ * @remarks
1584
+ * The maximum number of entries returned.
1585
+ *
1586
+ * @example
1587
+ * 20
1588
+ */
795
1589
  maxResults?: number;
1590
+ /**
1591
+ * @remarks
1592
+ * A pagination token. It can be used in the next request to retrieve a new page of results.
1593
+ *
1594
+ * @example
1595
+ * 1
1596
+ */
796
1597
  nextToken?: string;
1598
+ /**
1599
+ * @remarks
1600
+ * The request ID.
1601
+ *
1602
+ * @example
1603
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
1604
+ */
797
1605
  requestId?: string;
1606
+ /**
1607
+ * @remarks
1608
+ * The total number of entries returned.
1609
+ *
1610
+ * @example
1611
+ * 200
1612
+ */
798
1613
  totalCount?: number;
1614
+ /**
1615
+ * @remarks
1616
+ * The workspaces.
1617
+ */
799
1618
  workspaces?: ListWorkspacesResponseBodyWorkspaces[];
800
1619
  static names(): {
801
1620
  [key: string]: string;
@@ -824,16 +1643,90 @@ export declare class ListWorkspacesResponse extends $tea.Model {
824
1643
  });
825
1644
  }
826
1645
  export declare class StartJobRunRequest extends $tea.Model {
1646
+ /**
1647
+ * @remarks
1648
+ * The client token that is used to ensure the idempotence of the request.
1649
+ *
1650
+ * @example
1651
+ * 8e6aae2810c8f67229ca70bb31cd6028
1652
+ */
827
1653
  clientToken?: string;
1654
+ /**
1655
+ * @remarks
1656
+ * The code type of the job. Valid values:
1657
+ *
1658
+ * * SQL
1659
+ * * JAR
1660
+ * * PYTHON
1661
+ *
1662
+ * @example
1663
+ * SQL
1664
+ */
828
1665
  codeType?: string;
1666
+ /**
1667
+ * @remarks
1668
+ * The advanced configurations of Spark.
1669
+ */
829
1670
  configurationOverrides?: StartJobRunRequestConfigurationOverrides;
1671
+ displayReleaseVersion?: string;
1672
+ /**
1673
+ * @remarks
1674
+ * The timeout period of the job.
1675
+ *
1676
+ * @example
1677
+ * 100
1678
+ */
830
1679
  executionTimeoutSeconds?: number;
1680
+ fusion?: boolean;
1681
+ /**
1682
+ * @remarks
1683
+ * The information about Spark Driver.
1684
+ */
831
1685
  jobDriver?: JobDriver;
1686
+ /**
1687
+ * @remarks
1688
+ * The job ID.
1689
+ *
1690
+ * @example
1691
+ * jr-12345
1692
+ */
832
1693
  jobId?: string;
1694
+ /**
1695
+ * @remarks
1696
+ * The job name.
1697
+ *
1698
+ * @example
1699
+ * spark_job_name
1700
+ */
833
1701
  name?: string;
1702
+ /**
1703
+ * @remarks
1704
+ * The version number of Spark.
1705
+ *
1706
+ * @example
1707
+ * esr-3.3.1
1708
+ */
834
1709
  releaseVersion?: string;
1710
+ /**
1711
+ * @remarks
1712
+ * The name of the resource queue on which the Spark job runs.
1713
+ *
1714
+ * @example
1715
+ * dev_queue
1716
+ */
835
1717
  resourceQueueId?: string;
1718
+ /**
1719
+ * @remarks
1720
+ * The tags of the job.
1721
+ */
836
1722
  tags?: Tag[];
1723
+ /**
1724
+ * @remarks
1725
+ * The region ID.
1726
+ *
1727
+ * @example
1728
+ * cn-hangzhou
1729
+ */
837
1730
  regionId?: string;
838
1731
  static names(): {
839
1732
  [key: string]: string;
@@ -846,7 +1739,21 @@ export declare class StartJobRunRequest extends $tea.Model {
846
1739
  });
847
1740
  }
848
1741
  export declare class StartJobRunResponseBody extends $tea.Model {
1742
+ /**
1743
+ * @remarks
1744
+ * The job ID.
1745
+ *
1746
+ * @example
1747
+ * jr-54321
1748
+ */
849
1749
  jobRunId?: string;
1750
+ /**
1751
+ * @remarks
1752
+ * The request ID.
1753
+ *
1754
+ * @example
1755
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
1756
+ */
850
1757
  requestId?: string;
851
1758
  static names(): {
852
1759
  [key: string]: string;
@@ -875,6 +1782,13 @@ export declare class StartJobRunResponse extends $tea.Model {
875
1782
  });
876
1783
  }
877
1784
  export declare class TerminateSqlStatementRequest extends $tea.Model {
1785
+ /**
1786
+ * @remarks
1787
+ * The region ID.
1788
+ *
1789
+ * @example
1790
+ * cn-hangzhou
1791
+ */
878
1792
  regionId?: string;
879
1793
  static names(): {
880
1794
  [key: string]: string;
@@ -887,6 +1801,13 @@ export declare class TerminateSqlStatementRequest extends $tea.Model {
887
1801
  });
888
1802
  }
889
1803
  export declare class TerminateSqlStatementResponseBody extends $tea.Model {
1804
+ /**
1805
+ * @remarks
1806
+ * The request ID.
1807
+ *
1808
+ * @example
1809
+ * DD6B1B2A-5837-5237-ABE4-FF0C8944****
1810
+ */
890
1811
  requestId?: string;
891
1812
  static names(): {
892
1813
  [key: string]: string;
@@ -943,6 +1864,10 @@ export declare class JobDriverSparkSubmit extends $tea.Model {
943
1864
  });
944
1865
  }
945
1866
  export declare class SqlOutputRows extends $tea.Model {
1867
+ /**
1868
+ * @example
1869
+ * null
1870
+ */
946
1871
  values?: string[];
947
1872
  static names(): {
948
1873
  [key: string]: string;
@@ -981,6 +1906,13 @@ export declare class SqlOutputSchema extends $tea.Model {
981
1906
  });
982
1907
  }
983
1908
  export declare class CreateSqlStatementResponseBodyData extends $tea.Model {
1909
+ /**
1910
+ * @remarks
1911
+ * The ID of the SQL query.
1912
+ *
1913
+ * @example
1914
+ * st-1231dfafadfa***
1915
+ */
984
1916
  statementId?: string;
985
1917
  static names(): {
986
1918
  [key: string]: string;
@@ -993,6 +1925,10 @@ export declare class CreateSqlStatementResponseBodyData extends $tea.Model {
993
1925
  });
994
1926
  }
995
1927
  export declare class GetJobRunResponseBodyJobRunConfigurationOverrides extends $tea.Model {
1928
+ /**
1929
+ * @remarks
1930
+ * The configurations.
1931
+ */
996
1932
  configurations?: Configuration[];
997
1933
  static names(): {
998
1934
  [key: string]: string;
@@ -1005,7 +1941,21 @@ export declare class GetJobRunResponseBodyJobRunConfigurationOverrides extends $
1005
1941
  });
1006
1942
  }
1007
1943
  export declare class GetJobRunResponseBodyJobRunStateChangeReason extends $tea.Model {
1944
+ /**
1945
+ * @remarks
1946
+ * The error code.
1947
+ *
1948
+ * @example
1949
+ * ERR-100000
1950
+ */
1008
1951
  code?: string;
1952
+ /**
1953
+ * @remarks
1954
+ * The error message.
1955
+ *
1956
+ * @example
1957
+ * connection refused
1958
+ */
1009
1959
  message?: string;
1010
1960
  static names(): {
1011
1961
  [key: string]: string;
@@ -1018,22 +1968,132 @@ export declare class GetJobRunResponseBodyJobRunStateChangeReason extends $tea.M
1018
1968
  });
1019
1969
  }
1020
1970
  export declare class GetJobRunResponseBodyJobRun extends $tea.Model {
1971
+ /**
1972
+ * @remarks
1973
+ * The code type of the job. Valid values:
1974
+ *
1975
+ * * SQL
1976
+ * * JAR
1977
+ * * PYTHON
1978
+ *
1979
+ * @example
1980
+ * SQL
1981
+ */
1021
1982
  codeType?: string;
1983
+ /**
1984
+ * @remarks
1985
+ * The job configurations of Spark.
1986
+ */
1022
1987
  configurationOverrides?: GetJobRunResponseBodyJobRunConfigurationOverrides;
1988
+ displayReleaseVersion?: string;
1989
+ /**
1990
+ * @remarks
1991
+ * The end time of the job.
1992
+ *
1993
+ * @example
1994
+ * 1684119314000
1995
+ */
1023
1996
  endTime?: number;
1997
+ /**
1998
+ * @remarks
1999
+ * The timeout period of the job.
2000
+ *
2001
+ * @example
2002
+ * 3600
2003
+ */
1024
2004
  executionTimeoutSeconds?: number;
2005
+ fusion?: boolean;
2006
+ /**
2007
+ * @remarks
2008
+ * The information about Spark Driver.
2009
+ */
1025
2010
  jobDriver?: JobDriver;
2011
+ /**
2012
+ * @remarks
2013
+ * The job ID.
2014
+ *
2015
+ * @example
2016
+ * jr-231231
2017
+ */
1026
2018
  jobRunId?: string;
2019
+ /**
2020
+ * @remarks
2021
+ * The path where the operational logs are stored.
2022
+ */
1027
2023
  log?: RunLog;
2024
+ /**
2025
+ * @remarks
2026
+ * The job name.
2027
+ *
2028
+ * @example
2029
+ * jobName
2030
+ */
1028
2031
  name?: string;
2032
+ /**
2033
+ * @remarks
2034
+ * The version of the Spark engine on which the job runs.
2035
+ *
2036
+ * @example
2037
+ * esr-3.3.1
2038
+ */
1029
2039
  releaseVersion?: string;
2040
+ /**
2041
+ * @remarks
2042
+ * The ID of the user who created the job.
2043
+ *
2044
+ * @example
2045
+ * 1509789347011222
2046
+ */
1030
2047
  resourceOwnerId?: string;
2048
+ /**
2049
+ * @remarks
2050
+ * The name of the queue on which the job runs.
2051
+ *
2052
+ * @example
2053
+ * root_queue
2054
+ */
1031
2055
  resourceQueueId?: string;
2056
+ /**
2057
+ * @remarks
2058
+ * The job state.
2059
+ *
2060
+ * @example
2061
+ * Running
2062
+ */
1032
2063
  state?: string;
2064
+ /**
2065
+ * @remarks
2066
+ * The reason of the job status change.
2067
+ */
1033
2068
  stateChangeReason?: GetJobRunResponseBodyJobRunStateChangeReason;
2069
+ /**
2070
+ * @remarks
2071
+ * The time when the job was submitted.
2072
+ *
2073
+ * @example
2074
+ * 1684119314000
2075
+ */
1034
2076
  submitTime?: number;
2077
+ /**
2078
+ * @remarks
2079
+ * The tags of the job.
2080
+ */
1035
2081
  tags?: Tag[];
2082
+ /**
2083
+ * @remarks
2084
+ * The web UI of the job.
2085
+ *
2086
+ * @example
2087
+ * http://spark-ui
2088
+ */
1036
2089
  webUI?: string;
2090
+ /**
2091
+ * @remarks
2092
+ * The workspace ID.
2093
+ *
2094
+ * @example
2095
+ * w-1234abcd
2096
+ */
1037
2097
  workspaceId?: string;
1038
2098
  static names(): {
1039
2099
  [key: string]: string;
@@ -1046,7 +2106,21 @@ export declare class GetJobRunResponseBodyJobRun extends $tea.Model {
1046
2106
  });
1047
2107
  }
1048
2108
  export declare class GetSqlStatementResponseBodyDataSqlOutputs extends $tea.Model {
2109
+ /**
2110
+ * @remarks
2111
+ * The queried data, which is a string in the JSON format.
2112
+ *
2113
+ * @example
2114
+ * [{\\"values\\":[\\"test_db\\",\\"test_table\\",false]}
2115
+ */
1049
2116
  rows?: string;
2117
+ /**
2118
+ * @remarks
2119
+ * The information about the schema, which is a string in the JSON format.
2120
+ *
2121
+ * @example
2122
+ * {\\"type\\":\\"struct\\",\\"fields\\":[{\\"name\\":\\"namespace\\",\\"type\\":\\"string\\",\\"nullable\\":false,\\"metadata\\":{}},{\\"name\\":\\"tableName\\",\\"type\\":\\"string\\",\\"nullable\\":false,\\"metadata\\":{}},{\\"name\\":\\"isTemporary\\",\\"type\\":\\"boolean\\",\\"nullable\\":false,\\"metadata\\":{}}]}
2123
+ */
1050
2124
  schema?: string;
1051
2125
  static names(): {
1052
2126
  [key: string]: string;
@@ -1059,11 +2133,55 @@ export declare class GetSqlStatementResponseBodyDataSqlOutputs extends $tea.Mode
1059
2133
  });
1060
2134
  }
1061
2135
  export declare class GetSqlStatementResponseBodyData extends $tea.Model {
2136
+ /**
2137
+ * @remarks
2138
+ * The list of time that is consumed by SQL queries.
2139
+ */
1062
2140
  executionTime?: number[];
2141
+ /**
2142
+ * @remarks
2143
+ * The error code.
2144
+ *
2145
+ * @example
2146
+ * ERROR-102
2147
+ */
1063
2148
  sqlErrorCode?: string;
2149
+ /**
2150
+ * @remarks
2151
+ * The error message.
2152
+ *
2153
+ * @example
2154
+ * error message
2155
+ */
1064
2156
  sqlErrorMessage?: string;
2157
+ /**
2158
+ * @remarks
2159
+ * The query results.
2160
+ */
1065
2161
  sqlOutputs?: GetSqlStatementResponseBodyDataSqlOutputs[];
2162
+ /**
2163
+ * @remarks
2164
+ * The query status.
2165
+ *
2166
+ * Valid values:
2167
+ *
2168
+ * * running
2169
+ * * available
2170
+ * * cancelled
2171
+ * * error
2172
+ * * cancelling
2173
+ *
2174
+ * @example
2175
+ * running
2176
+ */
1066
2177
  state?: string;
2178
+ /**
2179
+ * @remarks
2180
+ * The query ID.
2181
+ *
2182
+ * @example
2183
+ * st-1231311abadfaa
2184
+ */
1067
2185
  statementId?: string;
1068
2186
  static names(): {
1069
2187
  [key: string]: string;
@@ -1076,7 +2194,21 @@ export declare class GetSqlStatementResponseBodyData extends $tea.Model {
1076
2194
  });
1077
2195
  }
1078
2196
  export declare class ListJobRunsRequestEndTime extends $tea.Model {
2197
+ /**
2198
+ * @remarks
2199
+ * The end of the end time range.
2200
+ *
2201
+ * @example
2202
+ * 1710432000000
2203
+ */
1079
2204
  endTime?: number;
2205
+ /**
2206
+ * @remarks
2207
+ * The beginning of the end time range.
2208
+ *
2209
+ * @example
2210
+ * 1709740800000
2211
+ */
1080
2212
  startTime?: number;
1081
2213
  static names(): {
1082
2214
  [key: string]: string;
@@ -1089,7 +2221,21 @@ export declare class ListJobRunsRequestEndTime extends $tea.Model {
1089
2221
  });
1090
2222
  }
1091
2223
  export declare class ListJobRunsRequestStartTime extends $tea.Model {
2224
+ /**
2225
+ * @remarks
2226
+ * The end of the start time range.
2227
+ *
2228
+ * @example
2229
+ * 1710432000000
2230
+ */
1092
2231
  endTime?: number;
2232
+ /**
2233
+ * @remarks
2234
+ * The beginning of the start time range.
2235
+ *
2236
+ * @example
2237
+ * 1709740800000
2238
+ */
1093
2239
  startTime?: number;
1094
2240
  static names(): {
1095
2241
  [key: string]: string;
@@ -1102,8 +2248,22 @@ export declare class ListJobRunsRequestStartTime extends $tea.Model {
1102
2248
  });
1103
2249
  }
1104
2250
  export declare class ListJobRunsRequestTags extends $tea.Model {
2251
+ /**
2252
+ * @remarks
2253
+ * The key of tag N.
2254
+ *
2255
+ * @example
2256
+ * tag_key
2257
+ */
1105
2258
  key?: string;
1106
- value?: string;
2259
+ /**
2260
+ * @remarks
2261
+ * The value of tag N.
2262
+ *
2263
+ * @example
2264
+ * value
2265
+ */
2266
+ value?: string;
1107
2267
  static names(): {
1108
2268
  [key: string]: string;
1109
2269
  };
@@ -1115,6 +2275,10 @@ export declare class ListJobRunsRequestTags extends $tea.Model {
1115
2275
  });
1116
2276
  }
1117
2277
  export declare class ListJobRunsResponseBodyJobRunsConfigurationOverrides extends $tea.Model {
2278
+ /**
2279
+ * @remarks
2280
+ * The SparkConf objects.
2281
+ */
1118
2282
  configurations?: Configuration[];
1119
2283
  static names(): {
1120
2284
  [key: string]: string;
@@ -1127,7 +2291,21 @@ export declare class ListJobRunsResponseBodyJobRunsConfigurationOverrides extend
1127
2291
  });
1128
2292
  }
1129
2293
  export declare class ListJobRunsResponseBodyJobRunsStateChangeReason extends $tea.Model {
2294
+ /**
2295
+ * @remarks
2296
+ * The error code.
2297
+ *
2298
+ * @example
2299
+ * 0
2300
+ */
1130
2301
  code?: string;
2302
+ /**
2303
+ * @remarks
2304
+ * The error message.
2305
+ *
2306
+ * @example
2307
+ * success
2308
+ */
1131
2309
  message?: string;
1132
2310
  static names(): {
1133
2311
  [key: string]: string;
@@ -1140,21 +2318,126 @@ export declare class ListJobRunsResponseBodyJobRunsStateChangeReason extends $te
1140
2318
  });
1141
2319
  }
1142
2320
  export declare class ListJobRunsResponseBodyJobRuns extends $tea.Model {
2321
+ /**
2322
+ * @remarks
2323
+ * The code type of the job. Valid values:
2324
+ *
2325
+ * SQL
2326
+ *
2327
+ * JAR
2328
+ *
2329
+ * PYTHON
2330
+ *
2331
+ * @example
2332
+ * SQL
2333
+ */
1143
2334
  codeType?: string;
2335
+ /**
2336
+ * @remarks
2337
+ * The advanced configurations of Spark.
2338
+ */
1144
2339
  configurationOverrides?: ListJobRunsResponseBodyJobRunsConfigurationOverrides;
2340
+ /**
2341
+ * @remarks
2342
+ * The ID of the user who created the job.
2343
+ *
2344
+ * @example
2345
+ * 1509789347011222
2346
+ */
1145
2347
  creator?: string;
2348
+ displayReleaseVersion?: string;
2349
+ /**
2350
+ * @remarks
2351
+ * The end time of the job.
2352
+ *
2353
+ * @example
2354
+ * 1684119314000
2355
+ */
1146
2356
  endTime?: number;
2357
+ /**
2358
+ * @remarks
2359
+ * The timeout period of the job.
2360
+ *
2361
+ * @example
2362
+ * 3600
2363
+ */
1147
2364
  executionTimeoutSeconds?: number;
2365
+ fusion?: boolean;
2366
+ /**
2367
+ * @remarks
2368
+ * The information about Spark Driver.
2369
+ */
1148
2370
  jobDriver?: JobDriver;
2371
+ /**
2372
+ * @remarks
2373
+ * The job ID.
2374
+ *
2375
+ * @example
2376
+ * jr-231231
2377
+ */
1149
2378
  jobRunId?: string;
2379
+ /**
2380
+ * @remarks
2381
+ * The path where the operational logs are stored.
2382
+ */
1150
2383
  log?: RunLog;
2384
+ /**
2385
+ * @remarks
2386
+ * The job name.
2387
+ *
2388
+ * @example
2389
+ * jobName
2390
+ */
1151
2391
  name?: string;
2392
+ /**
2393
+ * @remarks
2394
+ * The version of Spark on which the jobs run.
2395
+ *
2396
+ * @example
2397
+ * esr-native-3.4.0
2398
+ */
1152
2399
  releaseVersion?: string;
2400
+ /**
2401
+ * @remarks
2402
+ * The job state.
2403
+ *
2404
+ * @example
2405
+ * Running
2406
+ */
1153
2407
  state?: string;
2408
+ /**
2409
+ * @remarks
2410
+ * The reason of the job status change.
2411
+ */
1154
2412
  stateChangeReason?: ListJobRunsResponseBodyJobRunsStateChangeReason;
2413
+ /**
2414
+ * @remarks
2415
+ * The time when the job was submitted.
2416
+ *
2417
+ * @example
2418
+ * 1684119314000
2419
+ */
1155
2420
  submitTime?: number;
2421
+ /**
2422
+ * @remarks
2423
+ * The tags of the job.
2424
+ */
1156
2425
  tags?: Tag[];
2426
+ /**
2427
+ * @remarks
2428
+ * The web UI of the job.
2429
+ *
2430
+ * @example
2431
+ * http://spark-ui
2432
+ */
1157
2433
  webUI?: string;
2434
+ /**
2435
+ * @remarks
2436
+ * The workspace ID.
2437
+ *
2438
+ * @example
2439
+ * w-1234abcd
2440
+ */
1158
2441
  workspaceId?: string;
1159
2442
  static names(): {
1160
2443
  [key: string]: string;
@@ -1167,13 +2450,68 @@ export declare class ListJobRunsResponseBodyJobRuns extends $tea.Model {
1167
2450
  });
1168
2451
  }
1169
2452
  export declare class ListReleaseVersionsResponseBodyReleaseVersions extends $tea.Model {
2453
+ /**
2454
+ * @remarks
2455
+ * The version number of open source Spark.
2456
+ *
2457
+ * @example
2458
+ * Spark 3.3.1
2459
+ */
1170
2460
  communityVersion?: string;
2461
+ /**
2462
+ * @remarks
2463
+ * The CPU architectures.
2464
+ */
1171
2465
  cpuArchitectures?: string[];
2466
+ displayReleaseVersion?: string;
2467
+ fusion?: boolean;
2468
+ /**
2469
+ * @remarks
2470
+ * The creation time.
2471
+ *
2472
+ * @example
2473
+ * 1716215854101
2474
+ */
1172
2475
  gmtCreate?: number;
2476
+ /**
2477
+ * @remarks
2478
+ * The type of the Infrastructure as a Service (IaaS) layer.
2479
+ *
2480
+ * @example
2481
+ * ASI
2482
+ */
1173
2483
  iaasType?: string;
2484
+ /**
2485
+ * @remarks
2486
+ * The version.
2487
+ *
2488
+ * @example
2489
+ * esr-2.1 (Spark 3.3.1, Scala 2.12, Java Runtime)
2490
+ */
1174
2491
  releaseVersion?: string;
2492
+ /**
2493
+ * @remarks
2494
+ * The version of Scala.
2495
+ *
2496
+ * @example
2497
+ * 2.12
2498
+ */
1175
2499
  scalaVersion?: string;
2500
+ /**
2501
+ * @remarks
2502
+ * The status of the version.
2503
+ *
2504
+ * @example
2505
+ * ONLINE
2506
+ */
1176
2507
  state?: string;
2508
+ /**
2509
+ * @remarks
2510
+ * The type of the version.
2511
+ *
2512
+ * @example
2513
+ * stable
2514
+ */
1177
2515
  type?: string;
1178
2516
  static names(): {
1179
2517
  [key: string]: string;
@@ -1186,8 +2524,29 @@ export declare class ListReleaseVersionsResponseBodyReleaseVersions extends $tea
1186
2524
  });
1187
2525
  }
1188
2526
  export declare class ListSessionClustersResponseBodySessionClustersApplicationConfigs extends $tea.Model {
2527
+ /**
2528
+ * @remarks
2529
+ * The name of the configuration file.
2530
+ *
2531
+ * @example
2532
+ * spark-default.conf
2533
+ */
1189
2534
  configFileName?: string;
2535
+ /**
2536
+ * @remarks
2537
+ * The key of the configuration item.
2538
+ *
2539
+ * @example
2540
+ * spark.app.name
2541
+ */
1190
2542
  configItemKey?: string;
2543
+ /**
2544
+ * @remarks
2545
+ * The value of the configuration item.
2546
+ *
2547
+ * @example
2548
+ * test_application
2549
+ */
1191
2550
  configItemValue?: string;
1192
2551
  static names(): {
1193
2552
  [key: string]: string;
@@ -1200,6 +2559,13 @@ export declare class ListSessionClustersResponseBodySessionClustersApplicationCo
1200
2559
  });
1201
2560
  }
1202
2561
  export declare class ListSessionClustersResponseBodySessionClustersAutoStartConfiguration extends $tea.Model {
2562
+ /**
2563
+ * @remarks
2564
+ * Indicates whether automatic startup is enabled.
2565
+ *
2566
+ * @example
2567
+ * true
2568
+ */
1203
2569
  enable?: boolean;
1204
2570
  static names(): {
1205
2571
  [key: string]: string;
@@ -1212,7 +2578,21 @@ export declare class ListSessionClustersResponseBodySessionClustersAutoStartConf
1212
2578
  });
1213
2579
  }
1214
2580
  export declare class ListSessionClustersResponseBodySessionClustersAutoStopConfiguration extends $tea.Model {
2581
+ /**
2582
+ * @remarks
2583
+ * Indicates whether automatic termination is enabled.
2584
+ *
2585
+ * @example
2586
+ * false
2587
+ */
1215
2588
  enable?: boolean;
2589
+ /**
2590
+ * @remarks
2591
+ * The idle timeout period. The SQL Compute is automatically terminated if the idle timeout period is exceeded.
2592
+ *
2593
+ * @example
2594
+ * 45
2595
+ */
1216
2596
  idleTimeoutMinutes?: number;
1217
2597
  static names(): {
1218
2598
  [key: string]: string;
@@ -1225,7 +2605,21 @@ export declare class ListSessionClustersResponseBodySessionClustersAutoStopConfi
1225
2605
  });
1226
2606
  }
1227
2607
  export declare class ListSessionClustersResponseBodySessionClustersStateChangeReason extends $tea.Model {
2608
+ /**
2609
+ * @remarks
2610
+ * The status change code.
2611
+ *
2612
+ * @example
2613
+ * 200
2614
+ */
1228
2615
  code?: string;
2616
+ /**
2617
+ * @remarks
2618
+ * The status change message.
2619
+ *
2620
+ * @example
2621
+ * ok
2622
+ */
1229
2623
  message?: string;
1230
2624
  static names(): {
1231
2625
  [key: string]: string;
@@ -1238,21 +2632,88 @@ export declare class ListSessionClustersResponseBodySessionClustersStateChangeRe
1238
2632
  });
1239
2633
  }
1240
2634
  export declare class ListSessionClustersResponseBodySessionClusters extends $tea.Model {
2635
+ /**
2636
+ * @remarks
2637
+ * The SQL Compute configurations, which are equivalent to the configurations of the Spark job.
2638
+ */
1241
2639
  applicationConfigs?: ListSessionClustersResponseBodySessionClustersApplicationConfigs[];
2640
+ /**
2641
+ * @remarks
2642
+ * The automatic startup configurations.
2643
+ */
1242
2644
  autoStartConfiguration?: ListSessionClustersResponseBodySessionClustersAutoStartConfiguration;
2645
+ /**
2646
+ * @remarks
2647
+ * The automatic termination configurations.
2648
+ */
1243
2649
  autoStopConfiguration?: ListSessionClustersResponseBodySessionClustersAutoStopConfiguration;
2650
+ displayReleaseVersion?: string;
1244
2651
  domain?: string;
1245
2652
  draftId?: string;
2653
+ fusion?: boolean;
1246
2654
  kind?: string;
2655
+ /**
2656
+ * @remarks
2657
+ * The name of the SQL Compute.
2658
+ *
2659
+ * @example
2660
+ * adhoc_query
2661
+ */
1247
2662
  name?: string;
2663
+ /**
2664
+ * @remarks
2665
+ * The name of the queue on which the SQL Compute runs.
2666
+ *
2667
+ * @example
2668
+ * dev_queue
2669
+ */
1248
2670
  queueName?: string;
1249
2671
  releaseVersion?: string;
2672
+ /**
2673
+ * @remarks
2674
+ * The SQL Compute ID.
2675
+ *
2676
+ * @example
2677
+ * sc-123131
2678
+ */
1250
2679
  sessionClusterId?: string;
2680
+ /**
2681
+ * @remarks
2682
+ * The status of the SQL Compute.
2683
+ *
2684
+ * @example
2685
+ * Running
2686
+ */
1251
2687
  state?: string;
2688
+ /**
2689
+ * @remarks
2690
+ * The details of the last status change of the SQL Compute.
2691
+ */
1252
2692
  stateChangeReason?: ListSessionClustersResponseBodySessionClustersStateChangeReason;
2693
+ /**
2694
+ * @remarks
2695
+ * The user ID.
2696
+ *
2697
+ * @example
2698
+ * 123131
2699
+ */
1253
2700
  userId?: string;
2701
+ /**
2702
+ * @remarks
2703
+ * The name of the user.
2704
+ *
2705
+ * @example
2706
+ * test_user
2707
+ */
1254
2708
  userName?: string;
1255
2709
  webUI?: string;
2710
+ /**
2711
+ * @remarks
2712
+ * The workspace ID.
2713
+ *
2714
+ * @example
2715
+ * w-1234abcd
2716
+ */
1256
2717
  workspaceId?: string;
1257
2718
  static names(): {
1258
2719
  [key: string]: string;
@@ -1265,10 +2726,45 @@ export declare class ListSessionClustersResponseBodySessionClusters extends $tea
1265
2726
  });
1266
2727
  }
1267
2728
  export declare class ListWorkspaceQueuesResponseBodyQueuesAllowActions extends $tea.Model {
2729
+ /**
2730
+ * @remarks
2731
+ * The Alibaba Cloud Resource Name (ARN) of a behavior.
2732
+ *
2733
+ * @example
2734
+ * acs:emr::workspaceId:action/create_queue
2735
+ */
1268
2736
  actionArn?: string;
2737
+ /**
2738
+ * @remarks
2739
+ * The name of the permission.
2740
+ *
2741
+ * @example
2742
+ * view
2743
+ */
1269
2744
  actionName?: string;
2745
+ /**
2746
+ * @remarks
2747
+ * The dependencies of the operation.
2748
+ *
2749
+ * @example
2750
+ * ["view"]
2751
+ */
1270
2752
  dependencies?: string[];
2753
+ /**
2754
+ * @remarks
2755
+ * The description of the operation.
2756
+ *
2757
+ * @example
2758
+ * 文件目录遍历、文件浏览
2759
+ */
1271
2760
  description?: string;
2761
+ /**
2762
+ * @remarks
2763
+ * The display name of the permission.
2764
+ *
2765
+ * @example
2766
+ * 文件目录遍历、文件浏览
2767
+ */
1272
2768
  displayName?: string;
1273
2769
  static names(): {
1274
2770
  [key: string]: string;
@@ -1281,18 +2777,103 @@ export declare class ListWorkspaceQueuesResponseBodyQueuesAllowActions extends $
1281
2777
  });
1282
2778
  }
1283
2779
  export declare class ListWorkspaceQueuesResponseBodyQueues extends $tea.Model {
2780
+ /**
2781
+ * @remarks
2782
+ * The operations allowed for the queue.
2783
+ */
1284
2784
  allowActions?: ListWorkspaceQueuesResponseBodyQueuesAllowActions[];
2785
+ /**
2786
+ * @remarks
2787
+ * The ID of the user who created the queue.
2788
+ *
2789
+ * @example
2790
+ * 237109
2791
+ */
1285
2792
  creator?: string;
2793
+ /**
2794
+ * @remarks
2795
+ * The environment types of the queue.
2796
+ */
1286
2797
  environments?: string[];
2798
+ /**
2799
+ * @remarks
2800
+ * The maximum capacity of resources that can be used in the queue.
2801
+ *
2802
+ * @example
2803
+ * {"cpu": "2","memory": "2Gi"}
2804
+ */
1287
2805
  maxResource?: string;
2806
+ /**
2807
+ * @remarks
2808
+ * The minimum capacity of resources that can be used in the queue.
2809
+ *
2810
+ * @example
2811
+ * {"cpu": "2","memory": "2Gi"}
2812
+ */
1288
2813
  minResource?: string;
2814
+ /**
2815
+ * @remarks
2816
+ * The queue label.
2817
+ *
2818
+ * @example
2819
+ * dev_queue
2820
+ */
1289
2821
  properties?: string;
2822
+ /**
2823
+ * @remarks
2824
+ * The name of the queue.
2825
+ *
2826
+ * @example
2827
+ * dev_queue
2828
+ */
1290
2829
  queueName?: string;
2830
+ /**
2831
+ * @remarks
2832
+ * The queue architecture.
2833
+ *
2834
+ * @example
2835
+ * {"arch": "x86"}
2836
+ */
1291
2837
  queueScope?: string;
2838
+ /**
2839
+ * @remarks
2840
+ * The status of the queue.
2841
+ *
2842
+ * @example
2843
+ * RUNNING
2844
+ */
1292
2845
  queueStatus?: string;
2846
+ /**
2847
+ * @remarks
2848
+ * The queue type.
2849
+ *
2850
+ * @example
2851
+ * instance, instanceChildren
2852
+ */
1293
2853
  queueType?: string;
2854
+ /**
2855
+ * @remarks
2856
+ * The region ID.
2857
+ *
2858
+ * @example
2859
+ * cn-hangzhou
2860
+ */
1294
2861
  regionId?: string;
2862
+ /**
2863
+ * @remarks
2864
+ * The capacity of resources that are used in the queue.
2865
+ *
2866
+ * @example
2867
+ * {"cpu": "2","memory": "2Gi"}
2868
+ */
1295
2869
  usedResource?: string;
2870
+ /**
2871
+ * @remarks
2872
+ * The workspace ID.
2873
+ *
2874
+ * @example
2875
+ * w-1234abcd
2876
+ */
1296
2877
  workspaceId?: string;
1297
2878
  static names(): {
1298
2879
  [key: string]: string;
@@ -1305,7 +2886,21 @@ export declare class ListWorkspaceQueuesResponseBodyQueues extends $tea.Model {
1305
2886
  });
1306
2887
  }
1307
2888
  export declare class ListWorkspacesResponseBodyWorkspacesStateChangeReason extends $tea.Model {
2889
+ /**
2890
+ * @remarks
2891
+ * The error code.
2892
+ *
2893
+ * @example
2894
+ * 0
2895
+ */
1308
2896
  code?: string;
2897
+ /**
2898
+ * @remarks
2899
+ * The error message.
2900
+ *
2901
+ * @example
2902
+ * Success
2903
+ */
1309
2904
  message?: string;
1310
2905
  static names(): {
1311
2906
  [key: string]: string;
@@ -1318,24 +2913,155 @@ export declare class ListWorkspacesResponseBodyWorkspacesStateChangeReason exten
1318
2913
  });
1319
2914
  }
1320
2915
  export declare class ListWorkspacesResponseBodyWorkspaces extends $tea.Model {
2916
+ /**
2917
+ * @remarks
2918
+ * Indicates whether auto-renewal is enabled. This parameter is required only if the paymentType parameter is set to Subscription.
2919
+ *
2920
+ * @example
2921
+ * true
2922
+ */
1321
2923
  autoRenew?: boolean;
2924
+ /**
2925
+ * @remarks
2926
+ * The auto-renewal duration. This parameter is required only if the paymentType parameter is set to Subscription.
2927
+ *
2928
+ * @example
2929
+ * 1
2930
+ */
1322
2931
  autoRenewPeriod?: number;
2932
+ /**
2933
+ * @remarks
2934
+ * The unit of the auto-renewal duration. This parameter is required only if the paymentType parameter is set to Subscription.
2935
+ *
2936
+ * @example
2937
+ * YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
2938
+ */
1323
2939
  autoRenewPeriodUnit?: string;
2940
+ /**
2941
+ * @remarks
2942
+ * The time when the workspace was created.
2943
+ *
2944
+ * @example
2945
+ * 1684115879955
2946
+ */
1324
2947
  createTime?: number;
2948
+ /**
2949
+ * @remarks
2950
+ * The information of the Data Lake Formation (DLF) catalog.
2951
+ *
2952
+ * @example
2953
+ * default
2954
+ */
1325
2955
  dlfCatalogId?: string;
2956
+ dlfType?: string;
2957
+ /**
2958
+ * @remarks
2959
+ * The subscription period. This parameter is required only if the paymentType parameter is set to Subscription.
2960
+ *
2961
+ * @example
2962
+ * 1
2963
+ */
1326
2964
  duration?: number;
2965
+ /**
2966
+ * @remarks
2967
+ * The time when the workspace was released.
2968
+ *
2969
+ * @example
2970
+ * 1687103999999
2971
+ */
1327
2972
  endTime?: number;
2973
+ /**
2974
+ * @remarks
2975
+ * The reason for the failure.
2976
+ *
2977
+ * @example
2978
+ * out of stock
2979
+ */
1328
2980
  failReason?: string;
2981
+ /**
2982
+ * @remarks
2983
+ * The unit of the subscription duration. This parameter is required only if the paymentType parameter is set to Subscription.
2984
+ *
2985
+ * @example
2986
+ * YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
2987
+ */
1329
2988
  paymentDurationUnit?: string;
2989
+ /**
2990
+ * @remarks
2991
+ * The status of the payment.
2992
+ *
2993
+ * @example
2994
+ * PAID/UNPAID
2995
+ */
1330
2996
  paymentStatus?: string;
2997
+ /**
2998
+ * @remarks
2999
+ * The payment type.
3000
+ *
3001
+ * @example
3002
+ * PayAsYouGo or Subscription
3003
+ */
1331
3004
  paymentType?: string;
3005
+ /**
3006
+ * @remarks
3007
+ * The region ID.
3008
+ *
3009
+ * @example
3010
+ * cn-shanghai
3011
+ */
1332
3012
  regionId?: string;
3013
+ /**
3014
+ * @remarks
3015
+ * The reason why the workspace is released.
3016
+ *
3017
+ * @example
3018
+ * SERVICE_RELEASE
3019
+ */
1333
3020
  releaseType?: string;
3021
+ /**
3022
+ * @remarks
3023
+ * The resource specifications.
3024
+ *
3025
+ * @example
3026
+ * 100cu
3027
+ */
1334
3028
  resourceSpec?: string;
3029
+ /**
3030
+ * @remarks
3031
+ * The information about the workspace status change.
3032
+ */
1335
3033
  stateChangeReason?: ListWorkspacesResponseBodyWorkspacesStateChangeReason;
3034
+ /**
3035
+ * @remarks
3036
+ * The Object Storage Service (OSS) path.
3037
+ *
3038
+ * @example
3039
+ * spark-result
3040
+ */
1336
3041
  storage?: string;
3042
+ /**
3043
+ * @remarks
3044
+ * The workspace ID.
3045
+ *
3046
+ * @example
3047
+ * w-******
3048
+ */
1337
3049
  workspaceId?: string;
3050
+ /**
3051
+ * @remarks
3052
+ * The name of the workspace.
3053
+ *
3054
+ * @example
3055
+ * spark批作业空间-1
3056
+ */
1338
3057
  workspaceName?: string;
3058
+ /**
3059
+ * @remarks
3060
+ * The workspace status.
3061
+ *
3062
+ * @example
3063
+ * STARTING,RUNNING,TERMINATED
3064
+ */
1339
3065
  workspaceStatus?: string;
1340
3066
  static names(): {
1341
3067
  [key: string]: string;
@@ -1348,8 +3074,29 @@ export declare class ListWorkspacesResponseBodyWorkspaces extends $tea.Model {
1348
3074
  });
1349
3075
  }
1350
3076
  export declare class StartJobRunRequestConfigurationOverridesConfigurations extends $tea.Model {
3077
+ /**
3078
+ * @remarks
3079
+ * The configuration file of SparkConf.
3080
+ *
3081
+ * @example
3082
+ * spark-default.conf
3083
+ */
1351
3084
  configFileName?: string;
3085
+ /**
3086
+ * @remarks
3087
+ * The key of SparkConf.
3088
+ *
3089
+ * @example
3090
+ * spark.app.name
3091
+ */
1352
3092
  configItemKey?: string;
3093
+ /**
3094
+ * @remarks
3095
+ * The value of SparkConf.
3096
+ *
3097
+ * @example
3098
+ * test_app
3099
+ */
1353
3100
  configItemValue?: string;
1354
3101
  static names(): {
1355
3102
  [key: string]: string;
@@ -1362,6 +3109,10 @@ export declare class StartJobRunRequestConfigurationOverridesConfigurations exte
1362
3109
  });
1363
3110
  }
1364
3111
  export declare class StartJobRunRequestConfigurationOverrides extends $tea.Model {
3112
+ /**
3113
+ * @remarks
3114
+ * The SparkConf objects.
3115
+ */
1365
3116
  configurations?: StartJobRunRequestConfigurationOverridesConfigurations[];
1366
3117
  static names(): {
1367
3118
  [key: string]: string;
@@ -1379,237 +3130,237 @@ export default class Client extends OpenApi {
1379
3130
  [key: string]: string;
1380
3131
  }, endpoint: string): string;
1381
3132
  /**
1382
- * @summary Adds a RAM user or RAM role to a workspace as a member.
3133
+ * Adds a RAM user or RAM role to a workspace as a member.
1383
3134
  *
1384
- * @param request AddMembersRequest
1385
- * @param headers map
1386
- * @param runtime runtime options for this request RuntimeOptions
1387
- * @return AddMembersResponse
3135
+ * @param request - AddMembersRequest
3136
+ * @param headers - map
3137
+ * @param runtime - runtime options for this request RuntimeOptions
3138
+ * @returns AddMembersResponse
1388
3139
  */
1389
3140
  addMembersWithOptions(request: AddMembersRequest, headers: {
1390
3141
  [key: string]: string;
1391
3142
  }, runtime: $Util.RuntimeOptions): Promise<AddMembersResponse>;
1392
3143
  /**
1393
- * @summary Adds a RAM user or RAM role to a workspace as a member.
3144
+ * Adds a RAM user or RAM role to a workspace as a member.
1394
3145
  *
1395
- * @param request AddMembersRequest
1396
- * @return AddMembersResponse
3146
+ * @param request - AddMembersRequest
3147
+ * @returns AddMembersResponse
1397
3148
  */
1398
3149
  addMembers(request: AddMembersRequest): Promise<AddMembersResponse>;
1399
3150
  /**
1400
- * @summary Terminates a Spark job.
3151
+ * Terminates a Spark job.
1401
3152
  *
1402
- * @param request CancelJobRunRequest
1403
- * @param headers map
1404
- * @param runtime runtime options for this request RuntimeOptions
1405
- * @return CancelJobRunResponse
3153
+ * @param request - CancelJobRunRequest
3154
+ * @param headers - map
3155
+ * @param runtime - runtime options for this request RuntimeOptions
3156
+ * @returns CancelJobRunResponse
1406
3157
  */
1407
3158
  cancelJobRunWithOptions(workspaceId: string, jobRunId: string, request: CancelJobRunRequest, headers: {
1408
3159
  [key: string]: string;
1409
3160
  }, runtime: $Util.RuntimeOptions): Promise<CancelJobRunResponse>;
1410
3161
  /**
1411
- * @summary Terminates a Spark job.
3162
+ * Terminates a Spark job.
1412
3163
  *
1413
- * @param request CancelJobRunRequest
1414
- * @return CancelJobRunResponse
3164
+ * @param request - CancelJobRunRequest
3165
+ * @returns CancelJobRunResponse
1415
3166
  */
1416
3167
  cancelJobRun(workspaceId: string, jobRunId: string, request: CancelJobRunRequest): Promise<CancelJobRunResponse>;
1417
3168
  /**
1418
- * @summary 使用session运行SQL
3169
+ * 使用session运行SQL
1419
3170
  *
1420
- * @param request CreateSqlStatementRequest
1421
- * @param headers map
1422
- * @param runtime runtime options for this request RuntimeOptions
1423
- * @return CreateSqlStatementResponse
3171
+ * @param request - CreateSqlStatementRequest
3172
+ * @param headers - map
3173
+ * @param runtime - runtime options for this request RuntimeOptions
3174
+ * @returns CreateSqlStatementResponse
1424
3175
  */
1425
3176
  createSqlStatementWithOptions(workspaceId: string, request: CreateSqlStatementRequest, headers: {
1426
3177
  [key: string]: string;
1427
3178
  }, runtime: $Util.RuntimeOptions): Promise<CreateSqlStatementResponse>;
1428
3179
  /**
1429
- * @summary 使用session运行SQL
3180
+ * 使用session运行SQL
1430
3181
  *
1431
- * @param request CreateSqlStatementRequest
1432
- * @return CreateSqlStatementResponse
3182
+ * @param request - CreateSqlStatementRequest
3183
+ * @returns CreateSqlStatementResponse
1433
3184
  */
1434
3185
  createSqlStatement(workspaceId: string, request: CreateSqlStatementRequest): Promise<CreateSqlStatementResponse>;
1435
3186
  /**
1436
- * @summary Obtain the job details.
3187
+ * Obtain the job details.
1437
3188
  *
1438
- * @param request GetJobRunRequest
1439
- * @param headers map
1440
- * @param runtime runtime options for this request RuntimeOptions
1441
- * @return GetJobRunResponse
3189
+ * @param request - GetJobRunRequest
3190
+ * @param headers - map
3191
+ * @param runtime - runtime options for this request RuntimeOptions
3192
+ * @returns GetJobRunResponse
1442
3193
  */
1443
3194
  getJobRunWithOptions(workspaceId: string, jobRunId: string, request: GetJobRunRequest, headers: {
1444
3195
  [key: string]: string;
1445
3196
  }, runtime: $Util.RuntimeOptions): Promise<GetJobRunResponse>;
1446
3197
  /**
1447
- * @summary Obtain the job details.
3198
+ * Obtain the job details.
1448
3199
  *
1449
- * @param request GetJobRunRequest
1450
- * @return GetJobRunResponse
3200
+ * @param request - GetJobRunRequest
3201
+ * @returns GetJobRunResponse
1451
3202
  */
1452
3203
  getJobRun(workspaceId: string, jobRunId: string, request: GetJobRunRequest): Promise<GetJobRunResponse>;
1453
3204
  /**
1454
- * @summary 获取Sql Statement状态
3205
+ * 获取Sql Statement状态
1455
3206
  *
1456
- * @param request GetSqlStatementRequest
1457
- * @param headers map
1458
- * @param runtime runtime options for this request RuntimeOptions
1459
- * @return GetSqlStatementResponse
3207
+ * @param request - GetSqlStatementRequest
3208
+ * @param headers - map
3209
+ * @param runtime - runtime options for this request RuntimeOptions
3210
+ * @returns GetSqlStatementResponse
1460
3211
  */
1461
3212
  getSqlStatementWithOptions(workspaceId: string, statementId: string, request: GetSqlStatementRequest, headers: {
1462
3213
  [key: string]: string;
1463
3214
  }, runtime: $Util.RuntimeOptions): Promise<GetSqlStatementResponse>;
1464
3215
  /**
1465
- * @summary 获取Sql Statement状态
3216
+ * 获取Sql Statement状态
1466
3217
  *
1467
- * @param request GetSqlStatementRequest
1468
- * @return GetSqlStatementResponse
3218
+ * @param request - GetSqlStatementRequest
3219
+ * @returns GetSqlStatementResponse
1469
3220
  */
1470
3221
  getSqlStatement(workspaceId: string, statementId: string, request: GetSqlStatementRequest): Promise<GetSqlStatementResponse>;
1471
3222
  /**
1472
- * @summary Assigns a specified role to users.
3223
+ * Assigns a specified role to users.
1473
3224
  *
1474
- * @param request GrantRoleToUsersRequest
1475
- * @param headers map
1476
- * @param runtime runtime options for this request RuntimeOptions
1477
- * @return GrantRoleToUsersResponse
3225
+ * @param request - GrantRoleToUsersRequest
3226
+ * @param headers - map
3227
+ * @param runtime - runtime options for this request RuntimeOptions
3228
+ * @returns GrantRoleToUsersResponse
1478
3229
  */
1479
3230
  grantRoleToUsersWithOptions(request: GrantRoleToUsersRequest, headers: {
1480
3231
  [key: string]: string;
1481
3232
  }, runtime: $Util.RuntimeOptions): Promise<GrantRoleToUsersResponse>;
1482
3233
  /**
1483
- * @summary Assigns a specified role to users.
3234
+ * Assigns a specified role to users.
1484
3235
  *
1485
- * @param request GrantRoleToUsersRequest
1486
- * @return GrantRoleToUsersResponse
3236
+ * @param request - GrantRoleToUsersRequest
3237
+ * @returns GrantRoleToUsersResponse
1487
3238
  */
1488
3239
  grantRoleToUsers(request: GrantRoleToUsersRequest): Promise<GrantRoleToUsersResponse>;
1489
3240
  /**
1490
- * @summary Queries a list of Spark jobs.
3241
+ * Queries a list of Spark jobs.
1491
3242
  *
1492
- * @param tmpReq ListJobRunsRequest
1493
- * @param headers map
1494
- * @param runtime runtime options for this request RuntimeOptions
1495
- * @return ListJobRunsResponse
3243
+ * @param tmpReq - ListJobRunsRequest
3244
+ * @param headers - map
3245
+ * @param runtime - runtime options for this request RuntimeOptions
3246
+ * @returns ListJobRunsResponse
1496
3247
  */
1497
3248
  listJobRunsWithOptions(workspaceId: string, tmpReq: ListJobRunsRequest, headers: {
1498
3249
  [key: string]: string;
1499
3250
  }, runtime: $Util.RuntimeOptions): Promise<ListJobRunsResponse>;
1500
3251
  /**
1501
- * @summary Queries a list of Spark jobs.
3252
+ * Queries a list of Spark jobs.
1502
3253
  *
1503
- * @param request ListJobRunsRequest
1504
- * @return ListJobRunsResponse
3254
+ * @param request - ListJobRunsRequest
3255
+ * @returns ListJobRunsResponse
1505
3256
  */
1506
3257
  listJobRuns(workspaceId: string, request: ListJobRunsRequest): Promise<ListJobRunsResponse>;
1507
3258
  /**
1508
- * @summary 获取发布版本列表
3259
+ * 获取发布版本列表
1509
3260
  *
1510
- * @param request ListReleaseVersionsRequest
1511
- * @param headers map
1512
- * @param runtime runtime options for this request RuntimeOptions
1513
- * @return ListReleaseVersionsResponse
3261
+ * @param request - ListReleaseVersionsRequest
3262
+ * @param headers - map
3263
+ * @param runtime - runtime options for this request RuntimeOptions
3264
+ * @returns ListReleaseVersionsResponse
1514
3265
  */
1515
3266
  listReleaseVersionsWithOptions(request: ListReleaseVersionsRequest, headers: {
1516
3267
  [key: string]: string;
1517
3268
  }, runtime: $Util.RuntimeOptions): Promise<ListReleaseVersionsResponse>;
1518
3269
  /**
1519
- * @summary 获取发布版本列表
3270
+ * 获取发布版本列表
1520
3271
  *
1521
- * @param request ListReleaseVersionsRequest
1522
- * @return ListReleaseVersionsResponse
3272
+ * @param request - ListReleaseVersionsRequest
3273
+ * @returns ListReleaseVersionsResponse
1523
3274
  */
1524
3275
  listReleaseVersions(request: ListReleaseVersionsRequest): Promise<ListReleaseVersionsResponse>;
1525
3276
  /**
1526
- * @summary 查询run列表
3277
+ * 查询run列表
1527
3278
  *
1528
- * @param request ListSessionClustersRequest
1529
- * @param headers map
1530
- * @param runtime runtime options for this request RuntimeOptions
1531
- * @return ListSessionClustersResponse
3279
+ * @param request - ListSessionClustersRequest
3280
+ * @param headers - map
3281
+ * @param runtime - runtime options for this request RuntimeOptions
3282
+ * @returns ListSessionClustersResponse
1532
3283
  */
1533
3284
  listSessionClustersWithOptions(workspaceId: string, request: ListSessionClustersRequest, headers: {
1534
3285
  [key: string]: string;
1535
3286
  }, runtime: $Util.RuntimeOptions): Promise<ListSessionClustersResponse>;
1536
3287
  /**
1537
- * @summary 查询run列表
3288
+ * 查询run列表
1538
3289
  *
1539
- * @param request ListSessionClustersRequest
1540
- * @return ListSessionClustersResponse
3290
+ * @param request - ListSessionClustersRequest
3291
+ * @returns ListSessionClustersResponse
1541
3292
  */
1542
3293
  listSessionClusters(workspaceId: string, request: ListSessionClustersRequest): Promise<ListSessionClustersResponse>;
1543
3294
  /**
1544
- * @summary 查看工作空间队列列表
3295
+ * 查看工作空间队列列表
1545
3296
  *
1546
- * @param request ListWorkspaceQueuesRequest
1547
- * @param headers map
1548
- * @param runtime runtime options for this request RuntimeOptions
1549
- * @return ListWorkspaceQueuesResponse
3297
+ * @param request - ListWorkspaceQueuesRequest
3298
+ * @param headers - map
3299
+ * @param runtime - runtime options for this request RuntimeOptions
3300
+ * @returns ListWorkspaceQueuesResponse
1550
3301
  */
1551
3302
  listWorkspaceQueuesWithOptions(workspaceId: string, request: ListWorkspaceQueuesRequest, headers: {
1552
3303
  [key: string]: string;
1553
3304
  }, runtime: $Util.RuntimeOptions): Promise<ListWorkspaceQueuesResponse>;
1554
3305
  /**
1555
- * @summary 查看工作空间队列列表
3306
+ * 查看工作空间队列列表
1556
3307
  *
1557
- * @param request ListWorkspaceQueuesRequest
1558
- * @return ListWorkspaceQueuesResponse
3308
+ * @param request - ListWorkspaceQueuesRequest
3309
+ * @returns ListWorkspaceQueuesResponse
1559
3310
  */
1560
3311
  listWorkspaceQueues(workspaceId: string, request: ListWorkspaceQueuesRequest): Promise<ListWorkspaceQueuesResponse>;
1561
3312
  /**
1562
- * @summary Queries a list of workspaces.
3313
+ * Queries a list of workspaces.
1563
3314
  *
1564
- * @param request ListWorkspacesRequest
1565
- * @param headers map
1566
- * @param runtime runtime options for this request RuntimeOptions
1567
- * @return ListWorkspacesResponse
3315
+ * @param request - ListWorkspacesRequest
3316
+ * @param headers - map
3317
+ * @param runtime - runtime options for this request RuntimeOptions
3318
+ * @returns ListWorkspacesResponse
1568
3319
  */
1569
3320
  listWorkspacesWithOptions(request: ListWorkspacesRequest, headers: {
1570
3321
  [key: string]: string;
1571
3322
  }, runtime: $Util.RuntimeOptions): Promise<ListWorkspacesResponse>;
1572
3323
  /**
1573
- * @summary Queries a list of workspaces.
3324
+ * Queries a list of workspaces.
1574
3325
  *
1575
- * @param request ListWorkspacesRequest
1576
- * @return ListWorkspacesResponse
3326
+ * @param request - ListWorkspacesRequest
3327
+ * @returns ListWorkspacesResponse
1577
3328
  */
1578
3329
  listWorkspaces(request: ListWorkspacesRequest): Promise<ListWorkspacesResponse>;
1579
3330
  /**
1580
- * @summary Starts a Spark job.
3331
+ * Starts a Spark job.
1581
3332
  *
1582
- * @param request StartJobRunRequest
1583
- * @param headers map
1584
- * @param runtime runtime options for this request RuntimeOptions
1585
- * @return StartJobRunResponse
3333
+ * @param request - StartJobRunRequest
3334
+ * @param headers - map
3335
+ * @param runtime - runtime options for this request RuntimeOptions
3336
+ * @returns StartJobRunResponse
1586
3337
  */
1587
3338
  startJobRunWithOptions(workspaceId: string, request: StartJobRunRequest, headers: {
1588
3339
  [key: string]: string;
1589
3340
  }, runtime: $Util.RuntimeOptions): Promise<StartJobRunResponse>;
1590
3341
  /**
1591
- * @summary Starts a Spark job.
3342
+ * Starts a Spark job.
1592
3343
  *
1593
- * @param request StartJobRunRequest
1594
- * @return StartJobRunResponse
3344
+ * @param request - StartJobRunRequest
3345
+ * @returns StartJobRunResponse
1595
3346
  */
1596
3347
  startJobRun(workspaceId: string, request: StartJobRunRequest): Promise<StartJobRunResponse>;
1597
3348
  /**
1598
- * @summary 终止 session statement
3349
+ * 终止 session statement
1599
3350
  *
1600
- * @param request TerminateSqlStatementRequest
1601
- * @param headers map
1602
- * @param runtime runtime options for this request RuntimeOptions
1603
- * @return TerminateSqlStatementResponse
3351
+ * @param request - TerminateSqlStatementRequest
3352
+ * @param headers - map
3353
+ * @param runtime - runtime options for this request RuntimeOptions
3354
+ * @returns TerminateSqlStatementResponse
1604
3355
  */
1605
3356
  terminateSqlStatementWithOptions(workspaceId: string, statementId: string, request: TerminateSqlStatementRequest, headers: {
1606
3357
  [key: string]: string;
1607
3358
  }, runtime: $Util.RuntimeOptions): Promise<TerminateSqlStatementResponse>;
1608
3359
  /**
1609
- * @summary 终止 session statement
3360
+ * 终止 session statement
1610
3361
  *
1611
- * @param request TerminateSqlStatementRequest
1612
- * @return TerminateSqlStatementResponse
3362
+ * @param request - TerminateSqlStatementRequest
3363
+ * @returns TerminateSqlStatementResponse
1613
3364
  */
1614
3365
  terminateSqlStatement(workspaceId: string, statementId: string, request: TerminateSqlStatementRequest): Promise<TerminateSqlStatementResponse>;
1615
3366
  }