@aws-sdk/client-m2 3.378.0 → 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.
@@ -20,19 +20,23 @@ export declare class AccessDeniedException extends __BaseException {
20
20
  */
21
21
  export interface AlternateKey {
22
22
  /**
23
+ * @public
23
24
  * <p>The name of the alternate key.</p>
24
25
  */
25
26
  name?: string;
26
27
  /**
28
+ * @public
27
29
  * <p>A positive integer value representing the offset to mark the start of the alternate key
28
30
  * part in the record byte array.</p>
29
31
  */
30
32
  offset: number | undefined;
31
33
  /**
34
+ * @public
32
35
  * <p>A strictly positive integer value representing the length of the alternate key.</p>
33
36
  */
34
37
  length: number | undefined;
35
38
  /**
39
+ * @public
36
40
  * <p>Indicates whether the alternate key values are supposed to be unique for the given data
37
41
  * set.</p>
38
42
  */
@@ -43,10 +47,12 @@ export interface AlternateKey {
43
47
  */
44
48
  export interface CancelBatchJobExecutionRequest {
45
49
  /**
50
+ * @public
46
51
  * <p>The unique identifier of the application.</p>
47
52
  */
48
53
  applicationId: string | undefined;
49
54
  /**
55
+ * @public
50
56
  * <p>The unique identifier of the batch job execution.</p>
51
57
  */
52
58
  executionId: string | undefined;
@@ -64,10 +70,12 @@ export declare class ConflictException extends __BaseException {
64
70
  readonly name: "ConflictException";
65
71
  readonly $fault: "client";
66
72
  /**
73
+ * @public
67
74
  * <p>The ID of the conflicting resource.</p>
68
75
  */
69
76
  resourceId?: string;
70
77
  /**
78
+ * @public
71
79
  * <p>The type of the conflicting resource.</p>
72
80
  */
73
81
  resourceType?: string;
@@ -85,6 +93,7 @@ export declare class InternalServerException extends __BaseException {
85
93
  readonly $fault: "server";
86
94
  $retryable: {};
87
95
  /**
96
+ * @public
88
97
  * <p>The number of seconds to wait before retrying the request.</p>
89
98
  */
90
99
  retryAfterSeconds?: number;
@@ -101,10 +110,12 @@ export declare class ResourceNotFoundException extends __BaseException {
101
110
  readonly name: "ResourceNotFoundException";
102
111
  readonly $fault: "client";
103
112
  /**
113
+ * @public
104
114
  * <p>The ID of the missing resource.</p>
105
115
  */
106
116
  resourceId?: string;
107
117
  /**
118
+ * @public
108
119
  * <p>The type of the missing resource.</p>
109
120
  */
110
121
  resourceType?: string;
@@ -124,14 +135,17 @@ export declare class ThrottlingException extends __BaseException {
124
135
  throttling: boolean;
125
136
  };
126
137
  /**
138
+ * @public
127
139
  * <p>The identifier of the service that the throttled request was made to.</p>
128
140
  */
129
141
  serviceCode?: string;
130
142
  /**
143
+ * @public
131
144
  * <p>The identifier of the throttled reuqest.</p>
132
145
  */
133
146
  quotaCode?: string;
134
147
  /**
148
+ * @public
135
149
  * <p>The number of seconds to wait before retrying the request.</p>
136
150
  */
137
151
  retryAfterSeconds?: number;
@@ -146,10 +160,12 @@ export declare class ThrottlingException extends __BaseException {
146
160
  */
147
161
  export interface ValidationExceptionField {
148
162
  /**
163
+ * @public
149
164
  * <p>The name of the exception field.</p>
150
165
  */
151
166
  name: string | undefined;
152
167
  /**
168
+ * @public
153
169
  * <p>The message of the exception field.</p>
154
170
  */
155
171
  message: string | undefined;
@@ -176,10 +192,12 @@ export declare class ValidationException extends __BaseException {
176
192
  readonly name: "ValidationException";
177
193
  readonly $fault: "client";
178
194
  /**
195
+ * @public
179
196
  * <p>The reason why it failed service validation.</p>
180
197
  */
181
198
  reason?: ValidationExceptionReason | string;
182
199
  /**
200
+ * @public
183
201
  * <p>The list of fields that failed service validation.</p>
184
202
  */
185
203
  fieldList?: ValidationExceptionField[];
@@ -198,6 +216,7 @@ export type Definition = Definition.ContentMember | Definition.S3LocationMember
198
216
  */
199
217
  export declare namespace Definition {
200
218
  /**
219
+ * @public
201
220
  * <p>The S3 bucket that contains the application definition.</p>
202
221
  */
203
222
  interface S3LocationMember {
@@ -206,6 +225,7 @@ export declare namespace Definition {
206
225
  $unknown?: never;
207
226
  }
208
227
  /**
228
+ * @public
209
229
  * <p>The content of the application definition. This is a JSON object that contains the
210
230
  * resource configuration/definitions that identify an application.</p>
211
231
  */
@@ -214,6 +234,9 @@ export declare namespace Definition {
214
234
  content: string;
215
235
  $unknown?: never;
216
236
  }
237
+ /**
238
+ * @public
239
+ */
217
240
  interface $UnknownMember {
218
241
  s3Location?: never;
219
242
  content?: never;
@@ -243,27 +266,33 @@ export type EngineType = (typeof EngineType)[keyof typeof EngineType];
243
266
  */
244
267
  export interface CreateApplicationRequest {
245
268
  /**
269
+ * @public
246
270
  * <p>The unique identifier of the application.</p>
247
271
  */
248
272
  name: string | undefined;
249
273
  /**
274
+ * @public
250
275
  * <p>The description of the application.</p>
251
276
  */
252
277
  description?: string;
253
278
  /**
279
+ * @public
254
280
  * <p>The type of the target platform for this application.</p>
255
281
  */
256
282
  engineType: EngineType | string | undefined;
257
283
  /**
284
+ * @public
258
285
  * <p>The application definition for this application. You can specify either inline JSON or
259
286
  * an S3 bucket location.</p>
260
287
  */
261
288
  definition: Definition | undefined;
262
289
  /**
290
+ * @public
263
291
  * <p>A list of tags to apply to the application.</p>
264
292
  */
265
293
  tags?: Record<string, string>;
266
294
  /**
295
+ * @public
267
296
  * <p>Unique, case-sensitive identifier the service generates to ensure the idempotency of the
268
297
  * request to create an application. The service generates the clientToken when the API call
269
298
  * is triggered. The token expires after one hour, so if you retry the API within this
@@ -272,10 +301,12 @@ export interface CreateApplicationRequest {
272
301
  */
273
302
  clientToken?: string;
274
303
  /**
304
+ * @public
275
305
  * <p>The identifier of a customer managed key.</p>
276
306
  */
277
307
  kmsKeyId?: string;
278
308
  /**
309
+ * @public
279
310
  * <p>The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources
280
311
  * that are not part of the application or are in a different Amazon Web Services account.</p>
281
312
  */
@@ -286,14 +317,17 @@ export interface CreateApplicationRequest {
286
317
  */
287
318
  export interface CreateApplicationResponse {
288
319
  /**
320
+ * @public
289
321
  * <p>The Amazon Resource Name (ARN) of the application.</p>
290
322
  */
291
323
  applicationArn: string | undefined;
292
324
  /**
325
+ * @public
293
326
  * <p>The unique application identifier.</p>
294
327
  */
295
328
  applicationId: string | undefined;
296
329
  /**
330
+ * @public
297
331
  * <p>The version number of the application.</p>
298
332
  */
299
333
  applicationVersion: number | undefined;
@@ -306,18 +340,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
306
340
  readonly name: "ServiceQuotaExceededException";
307
341
  readonly $fault: "client";
308
342
  /**
343
+ * @public
309
344
  * <p>The ID of the resource that is exceeding the quota limit.</p>
310
345
  */
311
346
  resourceId?: string;
312
347
  /**
348
+ * @public
313
349
  * <p>The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.</p>
314
350
  */
315
351
  resourceType?: string;
316
352
  /**
353
+ * @public
317
354
  * <p>A code that identifies the service that the exceeded quota belongs to.</p>
318
355
  */
319
356
  serviceCode?: string;
320
357
  /**
358
+ * @public
321
359
  * <p>The identifier of the exceeded quota.</p>
322
360
  */
323
361
  quotaCode?: string;
@@ -336,10 +374,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
336
374
  */
337
375
  export interface GdgAttributes {
338
376
  /**
377
+ * @public
339
378
  * <p>The maximum number of generation data sets, up to 255, in a GDG.</p>
340
379
  */
341
380
  limit?: number;
342
381
  /**
382
+ * @public
343
383
  * <p>The disposition of the data set in the catalog.</p>
344
384
  */
345
385
  rollDisposition?: string;
@@ -350,14 +390,17 @@ export interface GdgAttributes {
350
390
  */
351
391
  export interface PoAttributes {
352
392
  /**
393
+ * @public
353
394
  * <p>The format of the data set records.</p>
354
395
  */
355
396
  format: string | undefined;
356
397
  /**
398
+ * @public
357
399
  * <p>The character set encoding of the data set.</p>
358
400
  */
359
401
  encoding?: string;
360
402
  /**
403
+ * @public
361
404
  * <p>An array containing one or more filename extensions, allowing you to specify which files
362
405
  * to be included as PDS member.</p>
363
406
  */
@@ -369,10 +412,12 @@ export interface PoAttributes {
369
412
  */
370
413
  export interface PsAttributes {
371
414
  /**
415
+ * @public
372
416
  * <p>The format of the data set records.</p>
373
417
  */
374
418
  format: string | undefined;
375
419
  /**
420
+ * @public
376
421
  * <p>The character set encoding of the data set.</p>
377
422
  */
378
423
  encoding?: string;
@@ -383,15 +428,18 @@ export interface PsAttributes {
383
428
  */
384
429
  export interface PrimaryKey {
385
430
  /**
431
+ * @public
386
432
  * <p>A name for the Primary Key.</p>
387
433
  */
388
434
  name?: string;
389
435
  /**
436
+ * @public
390
437
  * <p>A positive integer value representing the offset to mark the start of the primary key in
391
438
  * the record byte array.</p>
392
439
  */
393
440
  offset: number | undefined;
394
441
  /**
442
+ * @public
395
443
  * <p>A strictly positive integer value representing the length of the primary key. </p>
396
444
  */
397
445
  length: number | undefined;
@@ -402,23 +450,28 @@ export interface PrimaryKey {
402
450
  */
403
451
  export interface VsamAttributes {
404
452
  /**
453
+ * @public
405
454
  * <p>The record format of the data set.</p>
406
455
  */
407
456
  format: string | undefined;
408
457
  /**
458
+ * @public
409
459
  * <p>The character set used by the data set. Can be ASCII, EBCDIC, or unknown.</p>
410
460
  */
411
461
  encoding?: string;
412
462
  /**
463
+ * @public
413
464
  * <p>Indicates whether indexes for this dataset are stored as compressed values. If you have
414
465
  * a large data set (typically &gt; 100 Mb), consider setting this flag to True.</p>
415
466
  */
416
467
  compressed?: boolean;
417
468
  /**
469
+ * @public
418
470
  * <p>The primary key of the data set.</p>
419
471
  */
420
472
  primaryKey?: PrimaryKey;
421
473
  /**
474
+ * @public
422
475
  * <p>The alternate key definitions, if any. A legacy dataset might not have any alternate key
423
476
  * defined, but if those alternate keys definitions exist, provide them as some applications
424
477
  * will make use of them.</p>
@@ -437,6 +490,7 @@ export type DatasetOrgAttributes = DatasetOrgAttributes.GdgMember | DatasetOrgAt
437
490
  */
438
491
  export declare namespace DatasetOrgAttributes {
439
492
  /**
493
+ * @public
440
494
  * <p>The details of a VSAM data set.</p>
441
495
  */
442
496
  interface VsamMember {
@@ -447,6 +501,7 @@ export declare namespace DatasetOrgAttributes {
447
501
  $unknown?: never;
448
502
  }
449
503
  /**
504
+ * @public
450
505
  * <p>The generation data group of the data set.</p>
451
506
  */
452
507
  interface GdgMember {
@@ -457,6 +512,7 @@ export declare namespace DatasetOrgAttributes {
457
512
  $unknown?: never;
458
513
  }
459
514
  /**
515
+ * @public
460
516
  * <p>The details of a PO type data set.</p>
461
517
  */
462
518
  interface PoMember {
@@ -467,6 +523,7 @@ export declare namespace DatasetOrgAttributes {
467
523
  $unknown?: never;
468
524
  }
469
525
  /**
526
+ * @public
470
527
  * <p>The details of a PS type data set.</p>
471
528
  */
472
529
  interface PsMember {
@@ -476,6 +533,9 @@ export declare namespace DatasetOrgAttributes {
476
533
  ps: PsAttributes;
477
534
  $unknown?: never;
478
535
  }
536
+ /**
537
+ * @public
538
+ */
479
539
  interface $UnknownMember {
480
540
  vsam?: never;
481
541
  gdg?: never;
@@ -498,10 +558,12 @@ export declare namespace DatasetOrgAttributes {
498
558
  */
499
559
  export interface RecordLength {
500
560
  /**
561
+ * @public
501
562
  * <p>The minimum record length of a record.</p>
502
563
  */
503
564
  min: number | undefined;
504
565
  /**
566
+ * @public
505
567
  * <p>The maximum record length. In case of fixed, both minimum and maximum are the
506
568
  * same.</p>
507
569
  */
@@ -513,24 +575,29 @@ export interface RecordLength {
513
575
  */
514
576
  export interface DataSet {
515
577
  /**
578
+ * @public
516
579
  * <p>The storage type of the data set: database or file system. For Micro Focus, database
517
580
  * corresponds to datastore and file system corresponds to EFS/FSX. For Blu Age, there is no
518
581
  * support of file system and database corresponds to Blusam. </p>
519
582
  */
520
583
  storageType?: string;
521
584
  /**
585
+ * @public
522
586
  * <p>The logical identifier for a specific data set (in mainframe format).</p>
523
587
  */
524
588
  datasetName: string | undefined;
525
589
  /**
590
+ * @public
526
591
  * <p>The type of dataset. The only supported value is VSAM.</p>
527
592
  */
528
593
  datasetOrg: DatasetOrgAttributes | undefined;
529
594
  /**
595
+ * @public
530
596
  * <p>The relative location of the data set in the database or file system. </p>
531
597
  */
532
598
  relativePath?: string;
533
599
  /**
600
+ * @public
534
601
  * <p>The length of a record.</p>
535
602
  */
536
603
  recordLength: RecordLength | undefined;
@@ -545,12 +612,16 @@ export type ExternalLocation = ExternalLocation.S3LocationMember | ExternalLocat
545
612
  */
546
613
  export declare namespace ExternalLocation {
547
614
  /**
615
+ * @public
548
616
  * <p>The URI of the Amazon S3 bucket.</p>
549
617
  */
550
618
  interface S3LocationMember {
551
619
  s3Location: string;
552
620
  $unknown?: never;
553
621
  }
622
+ /**
623
+ * @public
624
+ */
554
625
  interface $UnknownMember {
555
626
  s3Location?: never;
556
627
  $unknown: [string, any];
@@ -567,10 +638,12 @@ export declare namespace ExternalLocation {
567
638
  */
568
639
  export interface DataSetImportItem {
569
640
  /**
641
+ * @public
570
642
  * <p>The data set.</p>
571
643
  */
572
644
  dataSet: DataSet | undefined;
573
645
  /**
646
+ * @public
574
647
  * <p>The location of the data set.</p>
575
648
  */
576
649
  externalLocation: ExternalLocation | undefined;
@@ -585,6 +658,7 @@ export type DataSetImportConfig = DataSetImportConfig.DataSetsMember | DataSetIm
585
658
  */
586
659
  export declare namespace DataSetImportConfig {
587
660
  /**
661
+ * @public
588
662
  * <p>The Amazon S3 location of the data sets.</p>
589
663
  */
590
664
  interface S3LocationMember {
@@ -593,6 +667,7 @@ export declare namespace DataSetImportConfig {
593
667
  $unknown?: never;
594
668
  }
595
669
  /**
670
+ * @public
596
671
  * <p>The data sets.</p>
597
672
  */
598
673
  interface DataSetsMember {
@@ -600,6 +675,9 @@ export declare namespace DataSetImportConfig {
600
675
  dataSets: DataSetImportItem[];
601
676
  $unknown?: never;
602
677
  }
678
+ /**
679
+ * @public
680
+ */
603
681
  interface $UnknownMember {
604
682
  s3Location?: never;
605
683
  dataSets?: never;
@@ -617,14 +695,17 @@ export declare namespace DataSetImportConfig {
617
695
  */
618
696
  export interface CreateDataSetImportTaskRequest {
619
697
  /**
698
+ * @public
620
699
  * <p>The unique identifier of the application for which you want to import data sets.</p>
621
700
  */
622
701
  applicationId: string | undefined;
623
702
  /**
703
+ * @public
624
704
  * <p>The data set import task configuration.</p>
625
705
  */
626
706
  importConfig: DataSetImportConfig | undefined;
627
707
  /**
708
+ * @public
628
709
  * <p> Unique, case-sensitive identifier you provide to ensure the idempotency of the request
629
710
  * to create a data set import. The service generates the clientToken when the API call is
630
711
  * triggered. The token expires after one hour, so if you retry the API within this timeframe
@@ -638,6 +719,7 @@ export interface CreateDataSetImportTaskRequest {
638
719
  */
639
720
  export interface CreateDataSetImportTaskResponse {
640
721
  /**
722
+ * @public
641
723
  * <p>The task identifier. This operation is asynchronous. Use this identifier with the <a>GetDataSetImportTask</a> operation to obtain the status of this task.</p>
642
724
  */
643
725
  taskId: string | undefined;
@@ -647,19 +729,23 @@ export interface CreateDataSetImportTaskResponse {
647
729
  */
648
730
  export interface CreateDeploymentRequest {
649
731
  /**
732
+ * @public
650
733
  * <p>The identifier of the runtime environment where you want to deploy this
651
734
  * application.</p>
652
735
  */
653
736
  environmentId: string | undefined;
654
737
  /**
738
+ * @public
655
739
  * <p>The application identifier.</p>
656
740
  */
657
741
  applicationId: string | undefined;
658
742
  /**
743
+ * @public
659
744
  * <p>The version of the application to deploy.</p>
660
745
  */
661
746
  applicationVersion: number | undefined;
662
747
  /**
748
+ * @public
663
749
  * <p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request
664
750
  * to create a deployment. The service generates the clientToken when the API call is
665
751
  * triggered. The token expires after one hour, so if you retry the API within this timeframe
@@ -673,6 +759,7 @@ export interface CreateDeploymentRequest {
673
759
  */
674
760
  export interface CreateDeploymentResponse {
675
761
  /**
762
+ * @public
676
763
  * <p>The unique identifier of the deployment.</p>
677
764
  */
678
765
  deploymentId: string | undefined;
@@ -682,6 +769,7 @@ export interface CreateDeploymentResponse {
682
769
  */
683
770
  export interface DeleteApplicationRequest {
684
771
  /**
772
+ * @public
685
773
  * <p>The unique identifier of the application you want to delete.</p>
686
774
  */
687
775
  applicationId: string | undefined;
@@ -696,10 +784,12 @@ export interface DeleteApplicationResponse {
696
784
  */
697
785
  export interface DeleteApplicationFromEnvironmentRequest {
698
786
  /**
787
+ * @public
699
788
  * <p>The unique identifier of the application you want to delete.</p>
700
789
  */
701
790
  applicationId: string | undefined;
702
791
  /**
792
+ * @public
703
793
  * <p>The unique identifier of the runtime environment where the application was previously
704
794
  * deployed.</p>
705
795
  */
@@ -715,6 +805,7 @@ export interface DeleteApplicationFromEnvironmentResponse {
715
805
  */
716
806
  export interface GetApplicationRequest {
717
807
  /**
808
+ * @public
718
809
  * <p>The identifier of the application.</p>
719
810
  */
720
811
  applicationId: string | undefined;
@@ -738,14 +829,17 @@ export type DeploymentLifecycle = (typeof DeploymentLifecycle)[keyof typeof Depl
738
829
  */
739
830
  export interface DeployedVersionSummary {
740
831
  /**
832
+ * @public
741
833
  * <p>The version of the deployed application.</p>
742
834
  */
743
835
  applicationVersion: number | undefined;
744
836
  /**
837
+ * @public
745
838
  * <p>The status of the deployment.</p>
746
839
  */
747
840
  status: DeploymentLifecycle | string | undefined;
748
841
  /**
842
+ * @public
749
843
  * <p>The reason for the reported status.</p>
750
844
  */
751
845
  statusReason?: string;
@@ -769,18 +863,22 @@ export type ApplicationVersionLifecycle = (typeof ApplicationVersionLifecycle)[k
769
863
  */
770
864
  export interface ApplicationVersionSummary {
771
865
  /**
866
+ * @public
772
867
  * <p>The application version.</p>
773
868
  */
774
869
  applicationVersion: number | undefined;
775
870
  /**
871
+ * @public
776
872
  * <p>The status of the application.</p>
777
873
  */
778
874
  status: ApplicationVersionLifecycle | string | undefined;
779
875
  /**
876
+ * @public
780
877
  * <p>The reason for the reported status.</p>
781
878
  */
782
879
  statusReason?: string;
783
880
  /**
881
+ * @public
784
882
  * <p>The timestamp when the application version was created.</p>
785
883
  */
786
884
  creationTime: Date | undefined;
@@ -792,10 +890,12 @@ export interface ApplicationVersionSummary {
792
890
  */
793
891
  export interface LogGroupSummary {
794
892
  /**
893
+ * @public
795
894
  * <p>The type of log.</p>
796
895
  */
797
896
  logType: string | undefined;
798
897
  /**
898
+ * @public
799
899
  * <p>The name of the log group.</p>
800
900
  */
801
901
  logGroupName: string | undefined;
@@ -826,90 +926,110 @@ export type ApplicationLifecycle = (typeof ApplicationLifecycle)[keyof typeof Ap
826
926
  */
827
927
  export interface GetApplicationResponse {
828
928
  /**
929
+ * @public
829
930
  * <p>The unique identifier of the application.</p>
830
931
  */
831
932
  name: string | undefined;
832
933
  /**
934
+ * @public
833
935
  * <p>The description of the application.</p>
834
936
  */
835
937
  description?: string;
836
938
  /**
939
+ * @public
837
940
  * <p>The identifier of the application.</p>
838
941
  */
839
942
  applicationId: string | undefined;
840
943
  /**
944
+ * @public
841
945
  * <p>The Amazon Resource Name (ARN) of the application.</p>
842
946
  */
843
947
  applicationArn: string | undefined;
844
948
  /**
949
+ * @public
845
950
  * <p>The status of the application.</p>
846
951
  */
847
952
  status: ApplicationLifecycle | string | undefined;
848
953
  /**
954
+ * @public
849
955
  * <p>The latest version of the application.</p>
850
956
  */
851
957
  latestVersion: ApplicationVersionSummary | undefined;
852
958
  /**
959
+ * @public
853
960
  * <p>The version of the application that is deployed.</p>
854
961
  */
855
962
  deployedVersion?: DeployedVersionSummary;
856
963
  /**
964
+ * @public
857
965
  * <p>The type of the target platform for the application.</p>
858
966
  */
859
967
  engineType: EngineType | string | undefined;
860
968
  /**
969
+ * @public
861
970
  * <p>The list of log summaries. Each log summary includes the log type as well as the log
862
971
  * group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under
863
972
  * the customer's account.</p>
864
973
  */
865
974
  logGroups?: LogGroupSummary[];
866
975
  /**
976
+ * @public
867
977
  * <p>The timestamp when this application was created.</p>
868
978
  */
869
979
  creationTime: Date | undefined;
870
980
  /**
981
+ * @public
871
982
  * <p>The timestamp when you last started the application. Null until the application runs for
872
983
  * the first time.</p>
873
984
  */
874
985
  lastStartTime?: Date;
875
986
  /**
987
+ * @public
876
988
  * <p>A list of tags associated with the application.</p>
877
989
  */
878
990
  tags?: Record<string, string>;
879
991
  /**
992
+ * @public
880
993
  * <p>The identifier of the runtime environment where you want to deploy the
881
994
  * application.</p>
882
995
  */
883
996
  environmentId?: string;
884
997
  /**
998
+ * @public
885
999
  * <p>Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the
886
1000
  * network load balancer.</p>
887
1001
  */
888
1002
  targetGroupArns?: string[];
889
1003
  /**
1004
+ * @public
890
1005
  * <p>The Amazon Resource Name (ARN) for the network load balancer listener created in your
891
1006
  * Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an
892
1007
  * application.</p>
893
1008
  */
894
1009
  listenerArns?: string[];
895
1010
  /**
1011
+ * @public
896
1012
  * <p>The port associated with the network load balancer listener created in your Amazon Web Services
897
1013
  * account.</p>
898
1014
  */
899
1015
  listenerPorts?: number[];
900
1016
  /**
1017
+ * @public
901
1018
  * <p>The public DNS name of the load balancer created in your Amazon Web Services account.</p>
902
1019
  */
903
1020
  loadBalancerDnsName?: string;
904
1021
  /**
1022
+ * @public
905
1023
  * <p>The reason for the reported status.</p>
906
1024
  */
907
1025
  statusReason?: string;
908
1026
  /**
1027
+ * @public
909
1028
  * <p>The identifier of a customer managed key.</p>
910
1029
  */
911
1030
  kmsKeyId?: string;
912
1031
  /**
1032
+ * @public
913
1033
  * <p>The Amazon Resource Name (ARN) of the role associated with the application.</p>
914
1034
  */
915
1035
  roleArn?: string;
@@ -919,10 +1039,12 @@ export interface GetApplicationResponse {
919
1039
  */
920
1040
  export interface GetApplicationVersionRequest {
921
1041
  /**
1042
+ * @public
922
1043
  * <p>The unique identifier of the application.</p>
923
1044
  */
924
1045
  applicationId: string | undefined;
925
1046
  /**
1047
+ * @public
926
1048
  * <p>The specific version of the application.</p>
927
1049
  */
928
1050
  applicationVersion: number | undefined;
@@ -932,31 +1054,38 @@ export interface GetApplicationVersionRequest {
932
1054
  */
933
1055
  export interface GetApplicationVersionResponse {
934
1056
  /**
1057
+ * @public
935
1058
  * <p>The name of the application version.</p>
936
1059
  */
937
1060
  name: string | undefined;
938
1061
  /**
1062
+ * @public
939
1063
  * <p>The specific version of the application.</p>
940
1064
  */
941
1065
  applicationVersion: number | undefined;
942
1066
  /**
1067
+ * @public
943
1068
  * <p>The application description.</p>
944
1069
  */
945
1070
  description?: string;
946
1071
  /**
1072
+ * @public
947
1073
  * <p>The content of the application definition. This is a JSON object that contains the
948
1074
  * resource configuration and definitions that identify an application.</p>
949
1075
  */
950
1076
  definitionContent: string | undefined;
951
1077
  /**
1078
+ * @public
952
1079
  * <p>The status of the application version.</p>
953
1080
  */
954
1081
  status: ApplicationVersionLifecycle | string | undefined;
955
1082
  /**
1083
+ * @public
956
1084
  * <p>The timestamp when the application version was created.</p>
957
1085
  */
958
1086
  creationTime: Date | undefined;
959
1087
  /**
1088
+ * @public
960
1089
  * <p>The reason for the reported status.</p>
961
1090
  */
962
1091
  statusReason?: string;
@@ -966,10 +1095,12 @@ export interface GetApplicationVersionResponse {
966
1095
  */
967
1096
  export interface GetBatchJobExecutionRequest {
968
1097
  /**
1098
+ * @public
969
1099
  * <p>The identifier of the application.</p>
970
1100
  */
971
1101
  applicationId: string | undefined;
972
1102
  /**
1103
+ * @public
973
1104
  * <p>The unique identifier of the batch job execution.</p>
974
1105
  */
975
1106
  executionId: string | undefined;
@@ -981,10 +1112,12 @@ export interface GetBatchJobExecutionRequest {
981
1112
  */
982
1113
  export interface FileBatchJobIdentifier {
983
1114
  /**
1115
+ * @public
984
1116
  * <p>The file name for the batch job identifier.</p>
985
1117
  */
986
1118
  fileName: string | undefined;
987
1119
  /**
1120
+ * @public
988
1121
  * <p>The relative path to the file name for the batch job identifier.</p>
989
1122
  */
990
1123
  folderPath?: string;
@@ -996,6 +1129,7 @@ export interface FileBatchJobIdentifier {
996
1129
  */
997
1130
  export interface ScriptBatchJobIdentifier {
998
1131
  /**
1132
+ * @public
999
1133
  * <p>The name of the script containing the batch job definition.</p>
1000
1134
  */
1001
1135
  scriptName: string | undefined;
@@ -1010,6 +1144,7 @@ export type BatchJobIdentifier = BatchJobIdentifier.FileBatchJobIdentifierMember
1010
1144
  */
1011
1145
  export declare namespace BatchJobIdentifier {
1012
1146
  /**
1147
+ * @public
1013
1148
  * <p>Specifies a file associated with a specific batch job.</p>
1014
1149
  */
1015
1150
  interface FileBatchJobIdentifierMember {
@@ -1018,6 +1153,7 @@ export declare namespace BatchJobIdentifier {
1018
1153
  $unknown?: never;
1019
1154
  }
1020
1155
  /**
1156
+ * @public
1021
1157
  * <p>A batch job identifier in which the batch job to run is identified by the script
1022
1158
  * name.</p>
1023
1159
  */
@@ -1026,6 +1162,9 @@ export declare namespace BatchJobIdentifier {
1026
1162
  scriptBatchJobIdentifier: ScriptBatchJobIdentifier;
1027
1163
  $unknown?: never;
1028
1164
  }
1165
+ /**
1166
+ * @public
1167
+ */
1029
1168
  interface $UnknownMember {
1030
1169
  fileBatchJobIdentifier?: never;
1031
1170
  scriptBatchJobIdentifier?: never;
@@ -1075,46 +1214,57 @@ export type BatchJobExecutionStatus = (typeof BatchJobExecutionStatus)[keyof typ
1075
1214
  */
1076
1215
  export interface GetBatchJobExecutionResponse {
1077
1216
  /**
1217
+ * @public
1078
1218
  * <p>The unique identifier for this batch job execution.</p>
1079
1219
  */
1080
1220
  executionId: string | undefined;
1081
1221
  /**
1222
+ * @public
1082
1223
  * <p>The identifier of the application.</p>
1083
1224
  */
1084
1225
  applicationId: string | undefined;
1085
1226
  /**
1227
+ * @public
1086
1228
  * <p>The unique identifier for this batch job.</p>
1087
1229
  */
1088
1230
  jobId?: string;
1089
1231
  /**
1232
+ * @public
1090
1233
  * <p>The name of this batch job.</p>
1091
1234
  */
1092
1235
  jobName?: string;
1093
1236
  /**
1237
+ * @public
1094
1238
  * <p>The user for the job.</p>
1095
1239
  */
1096
1240
  jobUser?: string;
1097
1241
  /**
1242
+ * @public
1098
1243
  * <p>The type of job.</p>
1099
1244
  */
1100
1245
  jobType?: BatchJobType | string;
1101
1246
  /**
1247
+ * @public
1102
1248
  * <p>The status of the batch job execution.</p>
1103
1249
  */
1104
1250
  status: BatchJobExecutionStatus | string | undefined;
1105
1251
  /**
1252
+ * @public
1106
1253
  * <p>The timestamp when the batch job execution started.</p>
1107
1254
  */
1108
1255
  startTime: Date | undefined;
1109
1256
  /**
1257
+ * @public
1110
1258
  * <p>The timestamp when the batch job execution ended.</p>
1111
1259
  */
1112
1260
  endTime?: Date;
1113
1261
  /**
1262
+ * @public
1114
1263
  * <p>The reason for the reported status.</p>
1115
1264
  */
1116
1265
  statusReason?: string;
1117
1266
  /**
1267
+ * @public
1118
1268
  * <p>The batch job return code from either the Blu Age or Micro Focus runtime engines. For more
1119
1269
  * information, see <a href="https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes">Batch return
1120
1270
  * codes</a> in the <i>IBM WebSphere Application Server</i>
@@ -1122,6 +1272,7 @@ export interface GetBatchJobExecutionResponse {
1122
1272
  */
1123
1273
  returnCode?: string;
1124
1274
  /**
1275
+ * @public
1125
1276
  * <p>The unique identifier of this batch job.</p>
1126
1277
  */
1127
1278
  batchJobIdentifier?: BatchJobIdentifier;
@@ -1131,10 +1282,12 @@ export interface GetBatchJobExecutionResponse {
1131
1282
  */
1132
1283
  export interface GetDataSetDetailsRequest {
1133
1284
  /**
1285
+ * @public
1134
1286
  * <p>The unique identifier of the application that this data set is associated with.</p>
1135
1287
  */
1136
1288
  applicationId: string | undefined;
1137
1289
  /**
1290
+ * @public
1138
1291
  * <p>The name of the data set.</p>
1139
1292
  */
1140
1293
  dataSetName: string | undefined;
@@ -1149,10 +1302,12 @@ export interface GetDataSetDetailsRequest {
1149
1302
  */
1150
1303
  export interface GdgDetailAttributes {
1151
1304
  /**
1305
+ * @public
1152
1306
  * <p>The maximum number of generation data sets, up to 255, in a GDG.</p>
1153
1307
  */
1154
1308
  limit?: number;
1155
1309
  /**
1310
+ * @public
1156
1311
  * <p>The disposition of the data set in the catalog.</p>
1157
1312
  */
1158
1313
  rollDisposition?: string;
@@ -1163,10 +1318,12 @@ export interface GdgDetailAttributes {
1163
1318
  */
1164
1319
  export interface PoDetailAttributes {
1165
1320
  /**
1321
+ * @public
1166
1322
  * <p>The format of the data set records.</p>
1167
1323
  */
1168
1324
  format: string | undefined;
1169
1325
  /**
1326
+ * @public
1170
1327
  * <p>The character set encoding of the data set.</p>
1171
1328
  */
1172
1329
  encoding: string | undefined;
@@ -1177,10 +1334,12 @@ export interface PoDetailAttributes {
1177
1334
  */
1178
1335
  export interface PsDetailAttributes {
1179
1336
  /**
1337
+ * @public
1180
1338
  * <p>The format of the data set records.</p>
1181
1339
  */
1182
1340
  format: string | undefined;
1183
1341
  /**
1342
+ * @public
1184
1343
  * <p>The character set encoding of the data set.</p>
1185
1344
  */
1186
1345
  encoding: string | undefined;
@@ -1191,28 +1350,34 @@ export interface PsDetailAttributes {
1191
1350
  */
1192
1351
  export interface VsamDetailAttributes {
1193
1352
  /**
1353
+ * @public
1194
1354
  * <p>The character set used by the data set. Can be ASCII, EBCDIC, or unknown.</p>
1195
1355
  */
1196
1356
  encoding?: string;
1197
1357
  /**
1358
+ * @public
1198
1359
  * <p>The record format of the data set.</p>
1199
1360
  */
1200
1361
  recordFormat?: string;
1201
1362
  /**
1363
+ * @public
1202
1364
  * <p>Indicates whether indexes for this dataset are stored as compressed values. If you have
1203
1365
  * a large data set (typically &gt; 100 Mb), consider setting this flag to True.</p>
1204
1366
  */
1205
1367
  compressed?: boolean;
1206
1368
  /**
1369
+ * @public
1207
1370
  * <p>If set to True, enforces loading the data set into cache before it’s used by the
1208
1371
  * application.</p>
1209
1372
  */
1210
1373
  cacheAtStartup?: boolean;
1211
1374
  /**
1375
+ * @public
1212
1376
  * <p>The primary key of the data set.</p>
1213
1377
  */
1214
1378
  primaryKey?: PrimaryKey;
1215
1379
  /**
1380
+ * @public
1216
1381
  * <p>The alternate key definitions, if any. A legacy dataset might not have any alternate key
1217
1382
  * defined, but if those alternate keys definitions exist, provide them as some applications
1218
1383
  * will make use of them.</p>
@@ -1231,6 +1396,7 @@ export type DatasetDetailOrgAttributes = DatasetDetailOrgAttributes.GdgMember |
1231
1396
  */
1232
1397
  export declare namespace DatasetDetailOrgAttributes {
1233
1398
  /**
1399
+ * @public
1234
1400
  * <p>The details of a VSAM data set.</p>
1235
1401
  */
1236
1402
  interface VsamMember {
@@ -1241,6 +1407,7 @@ export declare namespace DatasetDetailOrgAttributes {
1241
1407
  $unknown?: never;
1242
1408
  }
1243
1409
  /**
1410
+ * @public
1244
1411
  * <p>The generation data group of the data set.</p>
1245
1412
  */
1246
1413
  interface GdgMember {
@@ -1251,6 +1418,7 @@ export declare namespace DatasetDetailOrgAttributes {
1251
1418
  $unknown?: never;
1252
1419
  }
1253
1420
  /**
1421
+ * @public
1254
1422
  * <p>The details of a PO type data set.</p>
1255
1423
  */
1256
1424
  interface PoMember {
@@ -1261,6 +1429,7 @@ export declare namespace DatasetDetailOrgAttributes {
1261
1429
  $unknown?: never;
1262
1430
  }
1263
1431
  /**
1432
+ * @public
1264
1433
  * <p>The details of a PS type data set.</p>
1265
1434
  */
1266
1435
  interface PsMember {
@@ -1270,6 +1439,9 @@ export declare namespace DatasetDetailOrgAttributes {
1270
1439
  ps: PsDetailAttributes;
1271
1440
  $unknown?: never;
1272
1441
  }
1442
+ /**
1443
+ * @public
1444
+ */
1273
1445
  interface $UnknownMember {
1274
1446
  vsam?: never;
1275
1447
  gdg?: never;
@@ -1291,34 +1463,42 @@ export declare namespace DatasetDetailOrgAttributes {
1291
1463
  */
1292
1464
  export interface GetDataSetDetailsResponse {
1293
1465
  /**
1466
+ * @public
1294
1467
  * <p>The name of the data set.</p>
1295
1468
  */
1296
1469
  dataSetName: string | undefined;
1297
1470
  /**
1471
+ * @public
1298
1472
  * <p>The type of data set. The only supported value is VSAM.</p>
1299
1473
  */
1300
1474
  dataSetOrg?: DatasetDetailOrgAttributes;
1301
1475
  /**
1476
+ * @public
1302
1477
  * <p>The length of records in the data set.</p>
1303
1478
  */
1304
1479
  recordLength?: number;
1305
1480
  /**
1481
+ * @public
1306
1482
  * <p>The location where the data set is stored.</p>
1307
1483
  */
1308
1484
  location?: string;
1309
1485
  /**
1486
+ * @public
1310
1487
  * <p>The size of the block on disk. </p>
1311
1488
  */
1312
1489
  blocksize?: number;
1313
1490
  /**
1491
+ * @public
1314
1492
  * <p>The timestamp when the data set was created.</p>
1315
1493
  */
1316
1494
  creationTime?: Date;
1317
1495
  /**
1496
+ * @public
1318
1497
  * <p>The last time the data set was updated.</p>
1319
1498
  */
1320
1499
  lastUpdatedTime?: Date;
1321
1500
  /**
1501
+ * @public
1322
1502
  * <p>The last time the data set was referenced.</p>
1323
1503
  */
1324
1504
  lastReferencedTime?: Date;
@@ -1328,10 +1508,12 @@ export interface GetDataSetDetailsResponse {
1328
1508
  */
1329
1509
  export interface GetDataSetImportTaskRequest {
1330
1510
  /**
1511
+ * @public
1331
1512
  * <p>The application identifier.</p>
1332
1513
  */
1333
1514
  applicationId: string | undefined;
1334
1515
  /**
1516
+ * @public
1335
1517
  * <p>The task identifier returned by the <a>CreateDataSetImportTask</a> operation.
1336
1518
  * </p>
1337
1519
  */
@@ -1356,22 +1538,27 @@ export type DataSetTaskLifecycle = (typeof DataSetTaskLifecycle)[keyof typeof Da
1356
1538
  */
1357
1539
  export interface DataSetImportSummary {
1358
1540
  /**
1541
+ * @public
1359
1542
  * <p>The total number of data set imports.</p>
1360
1543
  */
1361
1544
  total: number | undefined;
1362
1545
  /**
1546
+ * @public
1363
1547
  * <p>The number of data set imports that have succeeded.</p>
1364
1548
  */
1365
1549
  succeeded: number | undefined;
1366
1550
  /**
1551
+ * @public
1367
1552
  * <p>The number of data set imports that have failed.</p>
1368
1553
  */
1369
1554
  failed: number | undefined;
1370
1555
  /**
1556
+ * @public
1371
1557
  * <p>The number of data set imports that are pending.</p>
1372
1558
  */
1373
1559
  pending: number | undefined;
1374
1560
  /**
1561
+ * @public
1375
1562
  * <p>The number of data set imports that are in progress.</p>
1376
1563
  */
1377
1564
  inProgress: number | undefined;
@@ -1381,14 +1568,17 @@ export interface DataSetImportSummary {
1381
1568
  */
1382
1569
  export interface GetDataSetImportTaskResponse {
1383
1570
  /**
1571
+ * @public
1384
1572
  * <p>The task identifier.</p>
1385
1573
  */
1386
1574
  taskId: string | undefined;
1387
1575
  /**
1576
+ * @public
1388
1577
  * <p>The status of the task.</p>
1389
1578
  */
1390
1579
  status: DataSetTaskLifecycle | string | undefined;
1391
1580
  /**
1581
+ * @public
1392
1582
  * <p>A summary of the status of the task.</p>
1393
1583
  */
1394
1584
  summary?: DataSetImportSummary;
@@ -1398,10 +1588,12 @@ export interface GetDataSetImportTaskResponse {
1398
1588
  */
1399
1589
  export interface GetDeploymentRequest {
1400
1590
  /**
1591
+ * @public
1401
1592
  * <p>The unique identifier for the deployment.</p>
1402
1593
  */
1403
1594
  deploymentId: string | undefined;
1404
1595
  /**
1596
+ * @public
1405
1597
  * <p>The unique identifier of the application.</p>
1406
1598
  */
1407
1599
  applicationId: string | undefined;
@@ -1411,30 +1603,37 @@ export interface GetDeploymentRequest {
1411
1603
  */
1412
1604
  export interface GetDeploymentResponse {
1413
1605
  /**
1606
+ * @public
1414
1607
  * <p>The unique identifier of the deployment.</p>
1415
1608
  */
1416
1609
  deploymentId: string | undefined;
1417
1610
  /**
1611
+ * @public
1418
1612
  * <p>The unique identifier of the application.</p>
1419
1613
  */
1420
1614
  applicationId: string | undefined;
1421
1615
  /**
1616
+ * @public
1422
1617
  * <p>The unique identifier of the runtime environment.</p>
1423
1618
  */
1424
1619
  environmentId: string | undefined;
1425
1620
  /**
1621
+ * @public
1426
1622
  * <p>The application version.</p>
1427
1623
  */
1428
1624
  applicationVersion: number | undefined;
1429
1625
  /**
1626
+ * @public
1430
1627
  * <p>The status of the deployment.</p>
1431
1628
  */
1432
1629
  status: DeploymentLifecycle | string | undefined;
1433
1630
  /**
1631
+ * @public
1434
1632
  * <p>The timestamp when the deployment was created.</p>
1435
1633
  */
1436
1634
  creationTime: Date | undefined;
1437
1635
  /**
1636
+ * @public
1438
1637
  * <p>The reason for the reported status.</p>
1439
1638
  */
1440
1639
  statusReason?: string;
@@ -1444,18 +1643,22 @@ export interface GetDeploymentResponse {
1444
1643
  */
1445
1644
  export interface ListApplicationsRequest {
1446
1645
  /**
1646
+ * @public
1447
1647
  * <p>A pagination token to control the number of applications displayed in the list.</p>
1448
1648
  */
1449
1649
  nextToken?: string;
1450
1650
  /**
1651
+ * @public
1451
1652
  * <p>The maximum number of applications to return.</p>
1452
1653
  */
1453
1654
  maxResults?: number;
1454
1655
  /**
1656
+ * @public
1455
1657
  * <p>The names of the applications.</p>
1456
1658
  */
1457
1659
  names?: string[];
1458
1660
  /**
1661
+ * @public
1459
1662
  * <p>The unique identifier of the runtime environment where the applications are
1460
1663
  * deployed.</p>
1461
1664
  */
@@ -1479,56 +1682,69 @@ export type ApplicationDeploymentLifecycle = (typeof ApplicationDeploymentLifecy
1479
1682
  */
1480
1683
  export interface ApplicationSummary {
1481
1684
  /**
1685
+ * @public
1482
1686
  * <p>The name of the application.</p>
1483
1687
  */
1484
1688
  name: string | undefined;
1485
1689
  /**
1690
+ * @public
1486
1691
  * <p>The description of the application.</p>
1487
1692
  */
1488
1693
  description?: string;
1489
1694
  /**
1695
+ * @public
1490
1696
  * <p>The unique identifier of the application.</p>
1491
1697
  */
1492
1698
  applicationId: string | undefined;
1493
1699
  /**
1700
+ * @public
1494
1701
  * <p>The Amazon Resource Name (ARN) of the application.</p>
1495
1702
  */
1496
1703
  applicationArn: string | undefined;
1497
1704
  /**
1705
+ * @public
1498
1706
  * <p>The version of the application.</p>
1499
1707
  */
1500
1708
  applicationVersion: number | undefined;
1501
1709
  /**
1710
+ * @public
1502
1711
  * <p>The status of the application.</p>
1503
1712
  */
1504
1713
  status: ApplicationLifecycle | string | undefined;
1505
1714
  /**
1715
+ * @public
1506
1716
  * <p>The type of the target platform for this application.</p>
1507
1717
  */
1508
1718
  engineType: EngineType | string | undefined;
1509
1719
  /**
1720
+ * @public
1510
1721
  * <p>The timestamp when the application was created.</p>
1511
1722
  */
1512
1723
  creationTime: Date | undefined;
1513
1724
  /**
1725
+ * @public
1514
1726
  * <p>The unique identifier of the runtime environment that hosts this application.</p>
1515
1727
  */
1516
1728
  environmentId?: string;
1517
1729
  /**
1730
+ * @public
1518
1731
  * <p>The timestamp when you last started the application. Null until the application runs for
1519
1732
  * the first time.</p>
1520
1733
  */
1521
1734
  lastStartTime?: Date;
1522
1735
  /**
1736
+ * @public
1523
1737
  * <p>Indicates the status of the latest version of the application.</p>
1524
1738
  */
1525
1739
  versionStatus?: ApplicationVersionLifecycle | string;
1526
1740
  /**
1741
+ * @public
1527
1742
  * <p>Indicates either an ongoing deployment or if the application has ever deployed
1528
1743
  * successfully.</p>
1529
1744
  */
1530
1745
  deploymentStatus?: ApplicationDeploymentLifecycle | string;
1531
1746
  /**
1747
+ * @public
1532
1748
  * <p>The Amazon Resource Name (ARN) of the role associated with the application.</p>
1533
1749
  */
1534
1750
  roleArn?: string;
@@ -1538,11 +1754,13 @@ export interface ApplicationSummary {
1538
1754
  */
1539
1755
  export interface ListApplicationsResponse {
1540
1756
  /**
1757
+ * @public
1541
1758
  * <p>Returns a list of summary details for all the applications in a runtime
1542
1759
  * environment.</p>
1543
1760
  */
1544
1761
  applications: ApplicationSummary[] | undefined;
1545
1762
  /**
1763
+ * @public
1546
1764
  * <p>A pagination token that's returned when the response doesn't contain all
1547
1765
  * applications.</p>
1548
1766
  */
@@ -1553,16 +1771,19 @@ export interface ListApplicationsResponse {
1553
1771
  */
1554
1772
  export interface ListApplicationVersionsRequest {
1555
1773
  /**
1774
+ * @public
1556
1775
  * <p>A pagination token returned from a previous call to
1557
1776
  * this operation. This specifies the next item to return. To return to the beginning of the
1558
1777
  * list, exclude this parameter.</p>
1559
1778
  */
1560
1779
  nextToken?: string;
1561
1780
  /**
1781
+ * @public
1562
1782
  * <p>The maximum number of application versions to return.</p>
1563
1783
  */
1564
1784
  maxResults?: number;
1565
1785
  /**
1786
+ * @public
1566
1787
  * <p>The unique identifier of the application.</p>
1567
1788
  */
1568
1789
  applicationId: string | undefined;
@@ -1572,10 +1793,12 @@ export interface ListApplicationVersionsRequest {
1572
1793
  */
1573
1794
  export interface ListApplicationVersionsResponse {
1574
1795
  /**
1796
+ * @public
1575
1797
  * <p>The list of application versions.</p>
1576
1798
  */
1577
1799
  applicationVersions: ApplicationVersionSummary[] | undefined;
1578
1800
  /**
1801
+ * @public
1579
1802
  * <p>If there are more items to return, this contains a token
1580
1803
  * that is passed to a subsequent call to this operation to retrieve the next set of items.</p>
1581
1804
  */
@@ -1586,20 +1809,24 @@ export interface ListApplicationVersionsResponse {
1586
1809
  */
1587
1810
  export interface ListBatchJobDefinitionsRequest {
1588
1811
  /**
1812
+ * @public
1589
1813
  * <p>A pagination token returned from a previous call to
1590
1814
  * this operation. This specifies the next item to return. To return to the beginning of the
1591
1815
  * list, exclude this parameter.</p>
1592
1816
  */
1593
1817
  nextToken?: string;
1594
1818
  /**
1819
+ * @public
1595
1820
  * <p>The maximum number of batch job definitions to return.</p>
1596
1821
  */
1597
1822
  maxResults?: number;
1598
1823
  /**
1824
+ * @public
1599
1825
  * <p>The identifier of the application.</p>
1600
1826
  */
1601
1827
  applicationId: string | undefined;
1602
1828
  /**
1829
+ * @public
1603
1830
  * <p>If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search
1604
1831
  * on the file names of FileBatchJobDefinitions.</p>
1605
1832
  */
@@ -1611,10 +1838,12 @@ export interface ListBatchJobDefinitionsRequest {
1611
1838
  */
1612
1839
  export interface FileBatchJobDefinition {
1613
1840
  /**
1841
+ * @public
1614
1842
  * <p>The name of the file containing the batch job definition.</p>
1615
1843
  */
1616
1844
  fileName: string | undefined;
1617
1845
  /**
1846
+ * @public
1618
1847
  * <p>The path to the file containing the batch job definition.</p>
1619
1848
  */
1620
1849
  folderPath?: string;
@@ -1625,6 +1854,7 @@ export interface FileBatchJobDefinition {
1625
1854
  */
1626
1855
  export interface ScriptBatchJobDefinition {
1627
1856
  /**
1857
+ * @public
1628
1858
  * <p>The name of the script containing the batch job definition.</p>
1629
1859
  */
1630
1860
  scriptName: string | undefined;
@@ -1639,6 +1869,7 @@ export type BatchJobDefinition = BatchJobDefinition.FileBatchJobDefinitionMember
1639
1869
  */
1640
1870
  export declare namespace BatchJobDefinition {
1641
1871
  /**
1872
+ * @public
1642
1873
  * <p>Specifies a file containing a batch job definition.</p>
1643
1874
  */
1644
1875
  interface FileBatchJobDefinitionMember {
@@ -1647,6 +1878,7 @@ export declare namespace BatchJobDefinition {
1647
1878
  $unknown?: never;
1648
1879
  }
1649
1880
  /**
1881
+ * @public
1650
1882
  * <p>A script containing a batch job definition.</p>
1651
1883
  */
1652
1884
  interface ScriptBatchJobDefinitionMember {
@@ -1654,6 +1886,9 @@ export declare namespace BatchJobDefinition {
1654
1886
  scriptBatchJobDefinition: ScriptBatchJobDefinition;
1655
1887
  $unknown?: never;
1656
1888
  }
1889
+ /**
1890
+ * @public
1891
+ */
1657
1892
  interface $UnknownMember {
1658
1893
  fileBatchJobDefinition?: never;
1659
1894
  scriptBatchJobDefinition?: never;
@@ -1671,10 +1906,12 @@ export declare namespace BatchJobDefinition {
1671
1906
  */
1672
1907
  export interface ListBatchJobDefinitionsResponse {
1673
1908
  /**
1909
+ * @public
1674
1910
  * <p>The list of batch job definitions.</p>
1675
1911
  */
1676
1912
  batchJobDefinitions: BatchJobDefinition[] | undefined;
1677
1913
  /**
1914
+ * @public
1678
1915
  * <p>If there are more items to return, this contains a token
1679
1916
  * that is passed to a subsequent call to this operation to retrieve the next set of items.</p>
1680
1917
  */
@@ -1685,35 +1922,43 @@ export interface ListBatchJobDefinitionsResponse {
1685
1922
  */
1686
1923
  export interface ListBatchJobExecutionsRequest {
1687
1924
  /**
1925
+ * @public
1688
1926
  * <p>A pagination token to control the number of batch job executions displayed in the
1689
1927
  * list.</p>
1690
1928
  */
1691
1929
  nextToken?: string;
1692
1930
  /**
1931
+ * @public
1693
1932
  * <p>The maximum number of batch job executions to return.</p>
1694
1933
  */
1695
1934
  maxResults?: number;
1696
1935
  /**
1936
+ * @public
1697
1937
  * <p>The unique identifier of the application.</p>
1698
1938
  */
1699
1939
  applicationId: string | undefined;
1700
1940
  /**
1941
+ * @public
1701
1942
  * <p>The unique identifier of each batch job execution.</p>
1702
1943
  */
1703
1944
  executionIds?: string[];
1704
1945
  /**
1946
+ * @public
1705
1947
  * <p>The name of each batch job execution.</p>
1706
1948
  */
1707
1949
  jobName?: string;
1708
1950
  /**
1951
+ * @public
1709
1952
  * <p>The status of the batch job executions.</p>
1710
1953
  */
1711
1954
  status?: BatchJobExecutionStatus | string;
1712
1955
  /**
1956
+ * @public
1713
1957
  * <p>The time after which the batch job executions started.</p>
1714
1958
  */
1715
1959
  startedAfter?: Date;
1716
1960
  /**
1961
+ * @public
1717
1962
  * <p>The time before the batch job executions started.</p>
1718
1963
  */
1719
1964
  startedBefore?: Date;
@@ -1724,38 +1969,47 @@ export interface ListBatchJobExecutionsRequest {
1724
1969
  */
1725
1970
  export interface BatchJobExecutionSummary {
1726
1971
  /**
1972
+ * @public
1727
1973
  * <p>The unique identifier of this execution of the batch job.</p>
1728
1974
  */
1729
1975
  executionId: string | undefined;
1730
1976
  /**
1977
+ * @public
1731
1978
  * <p>The unique identifier of the application that hosts this batch job.</p>
1732
1979
  */
1733
1980
  applicationId: string | undefined;
1734
1981
  /**
1982
+ * @public
1735
1983
  * <p>The unique identifier of a particular batch job.</p>
1736
1984
  */
1737
1985
  jobId?: string;
1738
1986
  /**
1987
+ * @public
1739
1988
  * <p>The name of a particular batch job.</p>
1740
1989
  */
1741
1990
  jobName?: string;
1742
1991
  /**
1992
+ * @public
1743
1993
  * <p>The type of a particular batch job execution.</p>
1744
1994
  */
1745
1995
  jobType?: BatchJobType | string;
1746
1996
  /**
1997
+ * @public
1747
1998
  * <p>The status of a particular batch job execution.</p>
1748
1999
  */
1749
2000
  status: BatchJobExecutionStatus | string | undefined;
1750
2001
  /**
2002
+ * @public
1751
2003
  * <p>The timestamp when a particular batch job execution started.</p>
1752
2004
  */
1753
2005
  startTime: Date | undefined;
1754
2006
  /**
2007
+ * @public
1755
2008
  * <p>The timestamp when this batch job execution ended.</p>
1756
2009
  */
1757
2010
  endTime?: Date;
1758
2011
  /**
2012
+ * @public
1759
2013
  * <p>The batch job return code from either the Blu Age or Micro Focus runtime engines. For more
1760
2014
  * information, see <a href="https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes">Batch return
1761
2015
  * codes</a> in the <i>IBM WebSphere Application Server</i>
@@ -1763,6 +2017,7 @@ export interface BatchJobExecutionSummary {
1763
2017
  */
1764
2018
  returnCode?: string;
1765
2019
  /**
2020
+ * @public
1766
2021
  * <p>The unique identifier of this batch job.</p>
1767
2022
  */
1768
2023
  batchJobIdentifier?: BatchJobIdentifier;
@@ -1772,10 +2027,12 @@ export interface BatchJobExecutionSummary {
1772
2027
  */
1773
2028
  export interface ListBatchJobExecutionsResponse {
1774
2029
  /**
2030
+ * @public
1775
2031
  * <p>Returns a list of batch job executions for an application.</p>
1776
2032
  */
1777
2033
  batchJobExecutions: BatchJobExecutionSummary[] | undefined;
1778
2034
  /**
2035
+ * @public
1779
2036
  * <p>A pagination token that's returned when the response doesn't contain all batch job
1780
2037
  * executions.</p>
1781
2038
  */
@@ -1786,16 +2043,19 @@ export interface ListBatchJobExecutionsResponse {
1786
2043
  */
1787
2044
  export interface ListDataSetImportHistoryRequest {
1788
2045
  /**
2046
+ * @public
1789
2047
  * <p>A pagination token returned from a previous call to
1790
2048
  * this operation. This specifies the next item to return. To return to the beginning of the
1791
2049
  * list, exclude this parameter.</p>
1792
2050
  */
1793
2051
  nextToken?: string;
1794
2052
  /**
2053
+ * @public
1795
2054
  * <p>The maximum number of objects to return.</p>
1796
2055
  */
1797
2056
  maxResults?: number;
1798
2057
  /**
2058
+ * @public
1799
2059
  * <p>The unique identifier of the application.</p>
1800
2060
  */
1801
2061
  applicationId: string | undefined;
@@ -1806,14 +2066,17 @@ export interface ListDataSetImportHistoryRequest {
1806
2066
  */
1807
2067
  export interface DataSetImportTask {
1808
2068
  /**
2069
+ * @public
1809
2070
  * <p>The identifier of the data set import task.</p>
1810
2071
  */
1811
2072
  taskId: string | undefined;
1812
2073
  /**
2074
+ * @public
1813
2075
  * <p>The status of the data set import task.</p>
1814
2076
  */
1815
2077
  status: DataSetTaskLifecycle | string | undefined;
1816
2078
  /**
2079
+ * @public
1817
2080
  * <p>A summary of the data set import task.</p>
1818
2081
  */
1819
2082
  summary: DataSetImportSummary | undefined;
@@ -1823,10 +2086,12 @@ export interface DataSetImportTask {
1823
2086
  */
1824
2087
  export interface ListDataSetImportHistoryResponse {
1825
2088
  /**
2089
+ * @public
1826
2090
  * <p>The data set import tasks.</p>
1827
2091
  */
1828
2092
  dataSetImportTasks: DataSetImportTask[] | undefined;
1829
2093
  /**
2094
+ * @public
1830
2095
  * <p>If there are more items to return, this contains a token
1831
2096
  * that is passed to a subsequent call to this operation to retrieve the next set of items.</p>
1832
2097
  */
@@ -1837,21 +2102,25 @@ export interface ListDataSetImportHistoryResponse {
1837
2102
  */
1838
2103
  export interface ListDataSetsRequest {
1839
2104
  /**
2105
+ * @public
1840
2106
  * <p>The unique identifier of the application for which you want to list the associated data
1841
2107
  * sets.</p>
1842
2108
  */
1843
2109
  applicationId: string | undefined;
1844
2110
  /**
2111
+ * @public
1845
2112
  * <p>A pagination token returned from a previous call to
1846
2113
  * this operation. This specifies the next item to return. To return to the beginning of the
1847
2114
  * list, exclude this parameter.</p>
1848
2115
  */
1849
2116
  nextToken?: string;
1850
2117
  /**
2118
+ * @public
1851
2119
  * <p>The maximum number of objects to return.</p>
1852
2120
  */
1853
2121
  maxResults?: number;
1854
2122
  /**
2123
+ * @public
1855
2124
  * <p>The prefix of the data set name, which you can use to filter the list of data
1856
2125
  * sets.</p>
1857
2126
  */
@@ -1863,26 +2132,32 @@ export interface ListDataSetsRequest {
1863
2132
  */
1864
2133
  export interface DataSetSummary {
1865
2134
  /**
2135
+ * @public
1866
2136
  * <p>The name of the data set.</p>
1867
2137
  */
1868
2138
  dataSetName: string | undefined;
1869
2139
  /**
2140
+ * @public
1870
2141
  * <p>The type of data set. The only supported value is VSAM.</p>
1871
2142
  */
1872
2143
  dataSetOrg?: string;
1873
2144
  /**
2145
+ * @public
1874
2146
  * <p>The format of the data set. </p>
1875
2147
  */
1876
2148
  format?: string;
1877
2149
  /**
2150
+ * @public
1878
2151
  * <p>The timestamp when the data set was created.</p>
1879
2152
  */
1880
2153
  creationTime?: Date;
1881
2154
  /**
2155
+ * @public
1882
2156
  * <p>The last time the data set was updated.</p>
1883
2157
  */
1884
2158
  lastUpdatedTime?: Date;
1885
2159
  /**
2160
+ * @public
1886
2161
  * <p>The last time the data set was referenced.</p>
1887
2162
  */
1888
2163
  lastReferencedTime?: Date;
@@ -1892,12 +2167,14 @@ export interface DataSetSummary {
1892
2167
  */
1893
2168
  export interface ListDataSetsResponse {
1894
2169
  /**
2170
+ * @public
1895
2171
  * <p>The list of data sets, containing information including the creation time, the data set
1896
2172
  * name, the data set organization, the data set format, and the last time the data set was
1897
2173
  * referenced or updated.</p>
1898
2174
  */
1899
2175
  dataSets: DataSetSummary[] | undefined;
1900
2176
  /**
2177
+ * @public
1901
2178
  * <p>If there are more items to return, this contains a token
1902
2179
  * that is passed to a subsequent call to this operation to retrieve the next set of items.</p>
1903
2180
  */
@@ -1908,16 +2185,19 @@ export interface ListDataSetsResponse {
1908
2185
  */
1909
2186
  export interface ListDeploymentsRequest {
1910
2187
  /**
2188
+ * @public
1911
2189
  * <p>A pagination token returned from a previous call to
1912
2190
  * this operation. This specifies the next item to return. To return to the beginning of the
1913
2191
  * list, exclude this parameter.</p>
1914
2192
  */
1915
2193
  nextToken?: string;
1916
2194
  /**
2195
+ * @public
1917
2196
  * <p>The maximum number of objects to return.</p>
1918
2197
  */
1919
2198
  maxResults?: number;
1920
2199
  /**
2200
+ * @public
1921
2201
  * <p>The application identifier.</p>
1922
2202
  */
1923
2203
  applicationId: string | undefined;
@@ -1928,30 +2208,37 @@ export interface ListDeploymentsRequest {
1928
2208
  */
1929
2209
  export interface DeploymentSummary {
1930
2210
  /**
2211
+ * @public
1931
2212
  * <p>The unique identifier of the deployment.</p>
1932
2213
  */
1933
2214
  deploymentId: string | undefined;
1934
2215
  /**
2216
+ * @public
1935
2217
  * <p>The unique identifier of the application.</p>
1936
2218
  */
1937
2219
  applicationId: string | undefined;
1938
2220
  /**
2221
+ * @public
1939
2222
  * <p>The unique identifier of the runtime environment.</p>
1940
2223
  */
1941
2224
  environmentId: string | undefined;
1942
2225
  /**
2226
+ * @public
1943
2227
  * <p>The version of the application.</p>
1944
2228
  */
1945
2229
  applicationVersion: number | undefined;
1946
2230
  /**
2231
+ * @public
1947
2232
  * <p>The current status of the deployment.</p>
1948
2233
  */
1949
2234
  status: DeploymentLifecycle | string | undefined;
1950
2235
  /**
2236
+ * @public
1951
2237
  * <p>The timestamp when the deployment was created.</p>
1952
2238
  */
1953
2239
  creationTime: Date | undefined;
1954
2240
  /**
2241
+ * @public
1955
2242
  * <p>The reason for the reported status.</p>
1956
2243
  */
1957
2244
  statusReason?: string;
@@ -1961,10 +2248,12 @@ export interface DeploymentSummary {
1961
2248
  */
1962
2249
  export interface ListDeploymentsResponse {
1963
2250
  /**
2251
+ * @public
1964
2252
  * <p>The list of deployments that is returned.</p>
1965
2253
  */
1966
2254
  deployments: DeploymentSummary[] | undefined;
1967
2255
  /**
2256
+ * @public
1968
2257
  * <p>If there are more items to return, this contains a token
1969
2258
  * that is passed to a subsequent call to this operation to retrieve the next set of items.</p>
1970
2259
  */
@@ -1975,6 +2264,7 @@ export interface ListDeploymentsResponse {
1975
2264
  */
1976
2265
  export interface StartApplicationRequest {
1977
2266
  /**
2267
+ * @public
1978
2268
  * <p>The unique identifier of the application you want to start.</p>
1979
2269
  */
1980
2270
  applicationId: string | undefined;
@@ -1989,14 +2279,17 @@ export interface StartApplicationResponse {
1989
2279
  */
1990
2280
  export interface StartBatchJobRequest {
1991
2281
  /**
2282
+ * @public
1992
2283
  * <p>The unique identifier of the application associated with this batch job.</p>
1993
2284
  */
1994
2285
  applicationId: string | undefined;
1995
2286
  /**
2287
+ * @public
1996
2288
  * <p>The unique identifier of the batch job.</p>
1997
2289
  */
1998
2290
  batchJobIdentifier: BatchJobIdentifier | undefined;
1999
2291
  /**
2292
+ * @public
2000
2293
  * <p>The collection of batch job parameters. For details about limits for keys and values,
2001
2294
  * see <a href="https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl">Coding variables in JCL</a>.</p>
2002
2295
  */
@@ -2007,6 +2300,7 @@ export interface StartBatchJobRequest {
2007
2300
  */
2008
2301
  export interface StartBatchJobResponse {
2009
2302
  /**
2303
+ * @public
2010
2304
  * <p>The unique identifier of this execution of the batch job.</p>
2011
2305
  */
2012
2306
  executionId: string | undefined;
@@ -2016,10 +2310,12 @@ export interface StartBatchJobResponse {
2016
2310
  */
2017
2311
  export interface StopApplicationRequest {
2018
2312
  /**
2313
+ * @public
2019
2314
  * <p>The unique identifier of the application you want to stop.</p>
2020
2315
  */
2021
2316
  applicationId: string | undefined;
2022
2317
  /**
2318
+ * @public
2023
2319
  * <p>Stopping an application process can take a long time. Setting this parameter to true
2024
2320
  * lets you force stop the application so you don't need to wait until the process finishes to
2025
2321
  * apply another action on the application. The default value is false.</p>
@@ -2036,18 +2332,22 @@ export interface StopApplicationResponse {
2036
2332
  */
2037
2333
  export interface UpdateApplicationRequest {
2038
2334
  /**
2335
+ * @public
2039
2336
  * <p>The unique identifier of the application you want to update.</p>
2040
2337
  */
2041
2338
  applicationId: string | undefined;
2042
2339
  /**
2340
+ * @public
2043
2341
  * <p>The description of the application to update.</p>
2044
2342
  */
2045
2343
  description?: string;
2046
2344
  /**
2345
+ * @public
2047
2346
  * <p>The current version of the application to update.</p>
2048
2347
  */
2049
2348
  currentApplicationVersion: number | undefined;
2050
2349
  /**
2350
+ * @public
2051
2351
  * <p>The application definition for this application. You can specify either inline JSON or
2052
2352
  * an S3 bucket location.</p>
2053
2353
  */
@@ -2058,6 +2358,7 @@ export interface UpdateApplicationRequest {
2058
2358
  */
2059
2359
  export interface UpdateApplicationResponse {
2060
2360
  /**
2361
+ * @public
2061
2362
  * <p>The new version of the application.</p>
2062
2363
  */
2063
2364
  applicationVersion: number | undefined;
@@ -2068,6 +2369,7 @@ export interface UpdateApplicationResponse {
2068
2369
  */
2069
2370
  export interface HighAvailabilityConfig {
2070
2371
  /**
2372
+ * @public
2071
2373
  * <p>The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.</p>
2072
2374
  */
2073
2375
  desiredCapacity: number | undefined;
@@ -2078,10 +2380,12 @@ export interface HighAvailabilityConfig {
2078
2380
  */
2079
2381
  export interface EfsStorageConfiguration {
2080
2382
  /**
2383
+ * @public
2081
2384
  * <p>The file system identifier.</p>
2082
2385
  */
2083
2386
  fileSystemId: string | undefined;
2084
2387
  /**
2388
+ * @public
2085
2389
  * <p>The mount point for the file system.</p>
2086
2390
  */
2087
2391
  mountPoint: string | undefined;
@@ -2092,10 +2396,12 @@ export interface EfsStorageConfiguration {
2092
2396
  */
2093
2397
  export interface FsxStorageConfiguration {
2094
2398
  /**
2399
+ * @public
2095
2400
  * <p>The file system identifier.</p>
2096
2401
  */
2097
2402
  fileSystemId: string | undefined;
2098
2403
  /**
2404
+ * @public
2099
2405
  * <p>The mount point for the file system.</p>
2100
2406
  */
2101
2407
  mountPoint: string | undefined;
@@ -2110,6 +2416,7 @@ export type StorageConfiguration = StorageConfiguration.EfsMember | StorageConfi
2110
2416
  */
2111
2417
  export declare namespace StorageConfiguration {
2112
2418
  /**
2419
+ * @public
2113
2420
  * <p>Defines the storage configuration for an Amazon EFS file system.</p>
2114
2421
  */
2115
2422
  interface EfsMember {
@@ -2118,6 +2425,7 @@ export declare namespace StorageConfiguration {
2118
2425
  $unknown?: never;
2119
2426
  }
2120
2427
  /**
2428
+ * @public
2121
2429
  * <p>Defines the storage configuration for an Amazon FSx file system.</p>
2122
2430
  */
2123
2431
  interface FsxMember {
@@ -2125,6 +2433,9 @@ export declare namespace StorageConfiguration {
2125
2433
  fsx: FsxStorageConfiguration;
2126
2434
  $unknown?: never;
2127
2435
  }
2436
+ /**
2437
+ * @public
2438
+ */
2128
2439
  interface $UnknownMember {
2129
2440
  efs?: never;
2130
2441
  fsx?: never;
@@ -2142,55 +2453,68 @@ export declare namespace StorageConfiguration {
2142
2453
  */
2143
2454
  export interface CreateEnvironmentRequest {
2144
2455
  /**
2456
+ * @public
2145
2457
  * <p>The name of the runtime environment. Must be unique within the account.</p>
2146
2458
  */
2147
2459
  name: string | undefined;
2148
2460
  /**
2461
+ * @public
2149
2462
  * <p>The type of instance for the runtime environment.</p>
2150
2463
  */
2151
2464
  instanceType: string | undefined;
2152
2465
  /**
2466
+ * @public
2153
2467
  * <p>The description of the runtime environment.</p>
2154
2468
  */
2155
2469
  description?: string;
2156
2470
  /**
2471
+ * @public
2157
2472
  * <p>The engine type for the runtime environment.</p>
2158
2473
  */
2159
2474
  engineType: EngineType | string | undefined;
2160
2475
  /**
2476
+ * @public
2161
2477
  * <p>The version of the engine type for the runtime environment.</p>
2162
2478
  */
2163
2479
  engineVersion?: string;
2164
2480
  /**
2481
+ * @public
2165
2482
  * <p>The list of subnets associated with the VPC for this runtime environment.</p>
2166
2483
  */
2167
2484
  subnetIds?: string[];
2168
2485
  /**
2486
+ * @public
2169
2487
  * <p>The list of security groups for the VPC associated with this runtime environment.</p>
2170
2488
  */
2171
2489
  securityGroupIds?: string[];
2172
2490
  /**
2491
+ * @public
2173
2492
  * <p>Optional. The storage configurations for this runtime environment.</p>
2174
2493
  */
2175
2494
  storageConfigurations?: StorageConfiguration[];
2176
2495
  /**
2496
+ * @public
2177
2497
  * <p>Specifies whether the runtime environment is publicly accessible.</p>
2178
2498
  */
2179
2499
  publiclyAccessible?: boolean;
2180
2500
  /**
2501
+ * @public
2181
2502
  * <p>The details of a high availability configuration for this runtime environment.</p>
2182
2503
  */
2183
2504
  highAvailabilityConfig?: HighAvailabilityConfig;
2184
2505
  /**
2506
+ * @public
2185
2507
  * <p>The tags for the runtime environment.</p>
2186
2508
  */
2187
2509
  tags?: Record<string, string>;
2188
2510
  /**
2511
+ * @public
2189
2512
  * <p>Configures the maintenance window you want for the runtime environment. If you do not
2190
2513
  * provide a value, a random system-generated value will be assigned.</p>
2191
2514
  */
2192
2515
  preferredMaintenanceWindow?: string;
2193
2516
  /**
2517
+ * @public
2194
2518
  * <p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request
2195
2519
  * to create an environment. The service generates the clientToken when the API call is
2196
2520
  * triggered. The token expires after one hour, so if you retry the API within this timeframe
@@ -2199,6 +2523,7 @@ export interface CreateEnvironmentRequest {
2199
2523
  */
2200
2524
  clientToken?: string;
2201
2525
  /**
2526
+ * @public
2202
2527
  * <p>The identifier of a customer managed key.</p>
2203
2528
  */
2204
2529
  kmsKeyId?: string;
@@ -2208,6 +2533,7 @@ export interface CreateEnvironmentRequest {
2208
2533
  */
2209
2534
  export interface CreateEnvironmentResponse {
2210
2535
  /**
2536
+ * @public
2211
2537
  * <p>The unique identifier of the runtime environment.</p>
2212
2538
  */
2213
2539
  environmentId: string | undefined;
@@ -2217,6 +2543,7 @@ export interface CreateEnvironmentResponse {
2217
2543
  */
2218
2544
  export interface DeleteEnvironmentRequest {
2219
2545
  /**
2546
+ * @public
2220
2547
  * <p>The unique identifier of the runtime environment you want to delete.</p>
2221
2548
  */
2222
2549
  environmentId: string | undefined;
@@ -2231,6 +2558,7 @@ export interface DeleteEnvironmentResponse {
2231
2558
  */
2232
2559
  export interface GetEnvironmentRequest {
2233
2560
  /**
2561
+ * @public
2234
2562
  * <p>The unique identifier of the runtime environment.</p>
2235
2563
  */
2236
2564
  environmentId: string | undefined;
@@ -2241,10 +2569,12 @@ export interface GetEnvironmentRequest {
2241
2569
  */
2242
2570
  export interface MaintenanceSchedule {
2243
2571
  /**
2572
+ * @public
2244
2573
  * <p>The time the scheduled maintenance is to start.</p>
2245
2574
  */
2246
2575
  startTime?: Date;
2247
2576
  /**
2577
+ * @public
2248
2578
  * <p>The time the scheduled maintenance is to end.</p>
2249
2579
  */
2250
2580
  endTime?: Date;
@@ -2255,10 +2585,12 @@ export interface MaintenanceSchedule {
2255
2585
  */
2256
2586
  export interface PendingMaintenance {
2257
2587
  /**
2588
+ * @public
2258
2589
  * <p>The maintenance schedule for the runtime engine version.</p>
2259
2590
  */
2260
2591
  schedule?: MaintenanceSchedule;
2261
2592
  /**
2593
+ * @public
2262
2594
  * <p>The specific runtime engine that the maintenance schedule applies to.</p>
2263
2595
  */
2264
2596
  engineVersion?: string;
@@ -2283,97 +2615,119 @@ export type EnvironmentLifecycle = (typeof EnvironmentLifecycle)[keyof typeof En
2283
2615
  */
2284
2616
  export interface GetEnvironmentResponse {
2285
2617
  /**
2618
+ * @public
2286
2619
  * <p>The name of the runtime environment. Must be unique within the account.</p>
2287
2620
  */
2288
2621
  name: string | undefined;
2289
2622
  /**
2623
+ * @public
2290
2624
  * <p>The description of the runtime environment.</p>
2291
2625
  */
2292
2626
  description?: string;
2293
2627
  /**
2628
+ * @public
2294
2629
  * <p>The Amazon Resource Name (ARN) of the runtime environment.</p>
2295
2630
  */
2296
2631
  environmentArn: string | undefined;
2297
2632
  /**
2633
+ * @public
2298
2634
  * <p>The unique identifier of the runtime environment.</p>
2299
2635
  */
2300
2636
  environmentId: string | undefined;
2301
2637
  /**
2638
+ * @public
2302
2639
  * <p>The type of instance underlying the runtime environment.</p>
2303
2640
  */
2304
2641
  instanceType: string | undefined;
2305
2642
  /**
2643
+ * @public
2306
2644
  * <p>The status of the runtime environment.</p>
2307
2645
  */
2308
2646
  status: EnvironmentLifecycle | string | undefined;
2309
2647
  /**
2648
+ * @public
2310
2649
  * <p>The target platform for the runtime environment.</p>
2311
2650
  */
2312
2651
  engineType: EngineType | string | undefined;
2313
2652
  /**
2653
+ * @public
2314
2654
  * <p>The version of the runtime engine.</p>
2315
2655
  */
2316
2656
  engineVersion: string | undefined;
2317
2657
  /**
2658
+ * @public
2318
2659
  * <p>The unique identifier for the VPC used with this runtime environment.</p>
2319
2660
  */
2320
2661
  vpcId: string | undefined;
2321
2662
  /**
2663
+ * @public
2322
2664
  * <p>The unique identifiers of the subnets assigned to this runtime environment.</p>
2323
2665
  */
2324
2666
  subnetIds: string[] | undefined;
2325
2667
  /**
2668
+ * @public
2326
2669
  * <p>The unique identifiers of the security groups assigned to this runtime
2327
2670
  * environment.</p>
2328
2671
  */
2329
2672
  securityGroupIds: string[] | undefined;
2330
2673
  /**
2674
+ * @public
2331
2675
  * <p>The timestamp when the runtime environment was created.</p>
2332
2676
  */
2333
2677
  creationTime: Date | undefined;
2334
2678
  /**
2679
+ * @public
2335
2680
  * <p>The storage configurations defined for the runtime environment.</p>
2336
2681
  */
2337
2682
  storageConfigurations?: StorageConfiguration[];
2338
2683
  /**
2684
+ * @public
2339
2685
  * <p>The tags defined for this runtime environment.</p>
2340
2686
  */
2341
2687
  tags?: Record<string, string>;
2342
2688
  /**
2689
+ * @public
2343
2690
  * <p>The desired capacity of the high availability configuration for the runtime
2344
2691
  * environment.</p>
2345
2692
  */
2346
2693
  highAvailabilityConfig?: HighAvailabilityConfig;
2347
2694
  /**
2695
+ * @public
2348
2696
  * <p>Whether applications running in this runtime environment are publicly accessible.
2349
2697
  * </p>
2350
2698
  */
2351
2699
  publiclyAccessible?: boolean;
2352
2700
  /**
2701
+ * @public
2353
2702
  * <p>The number of instances included in the runtime environment. A standalone runtime
2354
2703
  * environment has a maxiumum of one instance. Currently, a high availability runtime
2355
2704
  * environment has a maximum of two instances. </p>
2356
2705
  */
2357
2706
  actualCapacity?: number;
2358
2707
  /**
2708
+ * @public
2359
2709
  * <p>The Amazon Resource Name (ARN) for the load balancer used with the runtime
2360
2710
  * environment.</p>
2361
2711
  */
2362
2712
  loadBalancerArn?: string;
2363
2713
  /**
2714
+ * @public
2364
2715
  * <p>The reason for the reported status.</p>
2365
2716
  */
2366
2717
  statusReason?: string;
2367
2718
  /**
2719
+ * @public
2368
2720
  * <p>Configures the maintenance window you want for the runtime environment. If you do not
2369
2721
  * provide a value, a random system-generated value will be assigned.</p>
2370
2722
  */
2371
2723
  preferredMaintenanceWindow?: string;
2372
2724
  /**
2725
+ * @public
2373
2726
  * <p>Indicates the pending maintenance scheduled on this environment.</p>
2374
2727
  */
2375
2728
  pendingMaintenance?: PendingMaintenance;
2376
2729
  /**
2730
+ * @public
2377
2731
  * <p>The identifier of a customer managed key.</p>
2378
2732
  */
2379
2733
  kmsKeyId?: string;
@@ -2383,19 +2737,23 @@ export interface GetEnvironmentResponse {
2383
2737
  */
2384
2738
  export interface ListEnvironmentsRequest {
2385
2739
  /**
2740
+ * @public
2386
2741
  * <p>A pagination token to control the number of runtime environments displayed in the
2387
2742
  * list.</p>
2388
2743
  */
2389
2744
  nextToken?: string;
2390
2745
  /**
2746
+ * @public
2391
2747
  * <p>The maximum number of runtime environments to return.</p>
2392
2748
  */
2393
2749
  maxResults?: number;
2394
2750
  /**
2751
+ * @public
2395
2752
  * <p>The names of the runtime environments. Must be unique within the account.</p>
2396
2753
  */
2397
2754
  names?: string[];
2398
2755
  /**
2756
+ * @public
2399
2757
  * <p>The engine type for the runtime environment.</p>
2400
2758
  */
2401
2759
  engineType?: EngineType | string;
@@ -2407,34 +2765,42 @@ export interface ListEnvironmentsRequest {
2407
2765
  */
2408
2766
  export interface EnvironmentSummary {
2409
2767
  /**
2768
+ * @public
2410
2769
  * <p>The name of the runtime environment.</p>
2411
2770
  */
2412
2771
  name: string | undefined;
2413
2772
  /**
2773
+ * @public
2414
2774
  * <p>The Amazon Resource Name (ARN) of a particular runtime environment.</p>
2415
2775
  */
2416
2776
  environmentArn: string | undefined;
2417
2777
  /**
2778
+ * @public
2418
2779
  * <p>The unique identifier of a particular runtime environment.</p>
2419
2780
  */
2420
2781
  environmentId: string | undefined;
2421
2782
  /**
2783
+ * @public
2422
2784
  * <p>The instance type of the runtime environment.</p>
2423
2785
  */
2424
2786
  instanceType: string | undefined;
2425
2787
  /**
2788
+ * @public
2426
2789
  * <p>The status of the runtime environment</p>
2427
2790
  */
2428
2791
  status: EnvironmentLifecycle | string | undefined;
2429
2792
  /**
2793
+ * @public
2430
2794
  * <p>The target platform for the runtime environment.</p>
2431
2795
  */
2432
2796
  engineType: EngineType | string | undefined;
2433
2797
  /**
2798
+ * @public
2434
2799
  * <p>The version of the runtime engine.</p>
2435
2800
  */
2436
2801
  engineVersion: string | undefined;
2437
2802
  /**
2803
+ * @public
2438
2804
  * <p>The timestamp when the runtime environment was created.</p>
2439
2805
  */
2440
2806
  creationTime: Date | undefined;
@@ -2444,11 +2810,13 @@ export interface EnvironmentSummary {
2444
2810
  */
2445
2811
  export interface ListEnvironmentsResponse {
2446
2812
  /**
2813
+ * @public
2447
2814
  * <p>Returns a list of summary details for all the runtime environments in your account.
2448
2815
  * </p>
2449
2816
  */
2450
2817
  environments: EnvironmentSummary[] | undefined;
2451
2818
  /**
2819
+ * @public
2452
2820
  * <p>A pagination token that's returned when the response doesn't contain all the runtime
2453
2821
  * environments.</p>
2454
2822
  */
@@ -2459,27 +2827,33 @@ export interface ListEnvironmentsResponse {
2459
2827
  */
2460
2828
  export interface UpdateEnvironmentRequest {
2461
2829
  /**
2830
+ * @public
2462
2831
  * <p>The unique identifier of the runtime environment that you want to update.</p>
2463
2832
  */
2464
2833
  environmentId: string | undefined;
2465
2834
  /**
2835
+ * @public
2466
2836
  * <p>The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.</p>
2467
2837
  */
2468
2838
  desiredCapacity?: number;
2469
2839
  /**
2840
+ * @public
2470
2841
  * <p>The instance type for the runtime environment to update.</p>
2471
2842
  */
2472
2843
  instanceType?: string;
2473
2844
  /**
2845
+ * @public
2474
2846
  * <p>The version of the runtime engine for the runtime environment.</p>
2475
2847
  */
2476
2848
  engineVersion?: string;
2477
2849
  /**
2850
+ * @public
2478
2851
  * <p>Configures the maintenance window you want for the runtime environment. If you do not
2479
2852
  * provide a value, a random system-generated value will be assigned.</p>
2480
2853
  */
2481
2854
  preferredMaintenanceWindow?: string;
2482
2855
  /**
2856
+ * @public
2483
2857
  * <p>Indicates whether to update the runtime environment during the maintenance window. The
2484
2858
  * default is false. Currently, Amazon Web Services Mainframe Modernization accepts the <code>engineVersion</code> parameter
2485
2859
  * only if <code>applyDuringMaintenanceWindow</code> is true. If any parameter other than
@@ -2493,6 +2867,7 @@ export interface UpdateEnvironmentRequest {
2493
2867
  */
2494
2868
  export interface UpdateEnvironmentResponse {
2495
2869
  /**
2870
+ * @public
2496
2871
  * <p>The unique identifier of the runtime environment that was updated.</p>
2497
2872
  */
2498
2873
  environmentId: string | undefined;
@@ -2502,6 +2877,7 @@ export interface UpdateEnvironmentResponse {
2502
2877
  */
2503
2878
  export interface GetSignedBluinsightsUrlResponse {
2504
2879
  /**
2880
+ * @public
2505
2881
  * <p>Single sign-on AWS Blu Insights URL.</p>
2506
2882
  */
2507
2883
  signedBiUrl: string | undefined;
@@ -2511,16 +2887,19 @@ export interface GetSignedBluinsightsUrlResponse {
2511
2887
  */
2512
2888
  export interface ListEngineVersionsRequest {
2513
2889
  /**
2890
+ * @public
2514
2891
  * <p>The type of target platform.</p>
2515
2892
  */
2516
2893
  engineType?: EngineType | string;
2517
2894
  /**
2895
+ * @public
2518
2896
  * <p>A pagination token returned from a previous call to
2519
2897
  * this operation. This specifies the next item to return. To return to the beginning of the
2520
2898
  * list, exclude this parameter.</p>
2521
2899
  */
2522
2900
  nextToken?: string;
2523
2901
  /**
2902
+ * @public
2524
2903
  * <p>The maximum number of objects to return.</p>
2525
2904
  */
2526
2905
  maxResults?: number;
@@ -2531,10 +2910,12 @@ export interface ListEngineVersionsRequest {
2531
2910
  */
2532
2911
  export interface EngineVersionsSummary {
2533
2912
  /**
2913
+ * @public
2534
2914
  * <p>The type of target platform for the application.</p>
2535
2915
  */
2536
2916
  engineType: string | undefined;
2537
2917
  /**
2918
+ * @public
2538
2919
  * <p>The version of the engine type used by the application.</p>
2539
2920
  */
2540
2921
  engineVersion: string | undefined;
@@ -2544,10 +2925,12 @@ export interface EngineVersionsSummary {
2544
2925
  */
2545
2926
  export interface ListEngineVersionsResponse {
2546
2927
  /**
2928
+ * @public
2547
2929
  * <p>Returns the engine versions.</p>
2548
2930
  */
2549
2931
  engineVersions: EngineVersionsSummary[] | undefined;
2550
2932
  /**
2933
+ * @public
2551
2934
  * <p>If there are more items to return, this contains a token
2552
2935
  * that is passed to a subsequent call to this operation to retrieve the next set of items.</p>
2553
2936
  */
@@ -2558,6 +2941,7 @@ export interface ListEngineVersionsResponse {
2558
2941
  */
2559
2942
  export interface ListTagsForResourceRequest {
2560
2943
  /**
2944
+ * @public
2561
2945
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2562
2946
  */
2563
2947
  resourceArn: string | undefined;
@@ -2567,6 +2951,7 @@ export interface ListTagsForResourceRequest {
2567
2951
  */
2568
2952
  export interface ListTagsForResourceResponse {
2569
2953
  /**
2954
+ * @public
2570
2955
  * <p>The tags for the resource.</p>
2571
2956
  */
2572
2957
  tags: Record<string, string> | undefined;
@@ -2576,10 +2961,12 @@ export interface ListTagsForResourceResponse {
2576
2961
  */
2577
2962
  export interface TagResourceRequest {
2578
2963
  /**
2964
+ * @public
2579
2965
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2580
2966
  */
2581
2967
  resourceArn: string | undefined;
2582
2968
  /**
2969
+ * @public
2583
2970
  * <p>The tags to add to the resource.</p>
2584
2971
  */
2585
2972
  tags: Record<string, string> | undefined;
@@ -2594,10 +2981,12 @@ export interface TagResourceResponse {
2594
2981
  */
2595
2982
  export interface UntagResourceRequest {
2596
2983
  /**
2984
+ * @public
2597
2985
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2598
2986
  */
2599
2987
  resourceArn: string | undefined;
2600
2988
  /**
2989
+ * @public
2601
2990
  * <p>The keys of the tags to remove.</p>
2602
2991
  */
2603
2992
  tagKeys: string[] | undefined;