@aws-sdk/client-migrationhuborchestrator 3.379.1 → 3.385.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.
@@ -18,6 +18,7 @@ export declare class AccessDeniedException extends __BaseException {
18
18
  */
19
19
  export interface ListTagsForResourceRequest {
20
20
  /**
21
+ * @public
21
22
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
22
23
  */
23
24
  resourceArn: string | undefined;
@@ -27,6 +28,7 @@ export interface ListTagsForResourceRequest {
27
28
  */
28
29
  export interface ListTagsForResourceResponse {
29
30
  /**
31
+ * @public
30
32
  * <p>The tags added to a resource.</p>
31
33
  */
32
34
  tags?: Record<string, string>;
@@ -67,6 +69,7 @@ export type StepInput = StepInput.IntegerValueMember | StepInput.ListOfStringsVa
67
69
  */
68
70
  export declare namespace StepInput {
69
71
  /**
72
+ * @public
70
73
  * <p>The value of the integer.</p>
71
74
  */
72
75
  interface IntegerValueMember {
@@ -77,6 +80,7 @@ export declare namespace StepInput {
77
80
  $unknown?: never;
78
81
  }
79
82
  /**
83
+ * @public
80
84
  * <p>String value.</p>
81
85
  */
82
86
  interface StringValueMember {
@@ -87,6 +91,7 @@ export declare namespace StepInput {
87
91
  $unknown?: never;
88
92
  }
89
93
  /**
94
+ * @public
90
95
  * <p>List of string values.</p>
91
96
  */
92
97
  interface ListOfStringsValueMember {
@@ -97,6 +102,7 @@ export declare namespace StepInput {
97
102
  $unknown?: never;
98
103
  }
99
104
  /**
105
+ * @public
100
106
  * <p>Map of string values.</p>
101
107
  */
102
108
  interface MapOfStringValueMember {
@@ -106,6 +112,9 @@ export declare namespace StepInput {
106
112
  mapOfStringValue: Record<string, string>;
107
113
  $unknown?: never;
108
114
  }
115
+ /**
116
+ * @public
117
+ */
109
118
  interface $UnknownMember {
110
119
  integerValue?: never;
111
120
  stringValue?: never;
@@ -127,30 +136,37 @@ export declare namespace StepInput {
127
136
  */
128
137
  export interface CreateMigrationWorkflowRequest {
129
138
  /**
139
+ * @public
130
140
  * <p>The name of the migration workflow.</p>
131
141
  */
132
142
  name: string | undefined;
133
143
  /**
144
+ * @public
134
145
  * <p>The description of the migration workflow.</p>
135
146
  */
136
147
  description?: string;
137
148
  /**
149
+ * @public
138
150
  * <p>The ID of the template.</p>
139
151
  */
140
152
  templateId: string | undefined;
141
153
  /**
154
+ * @public
142
155
  * <p>The configuration ID of the application configured in Application Discovery Service.</p>
143
156
  */
144
157
  applicationConfigurationId: string | undefined;
145
158
  /**
159
+ * @public
146
160
  * <p>The input parameters required to create a migration workflow.</p>
147
161
  */
148
162
  inputParameters: Record<string, StepInput> | undefined;
149
163
  /**
164
+ * @public
150
165
  * <p>The servers on which a step will be run.</p>
151
166
  */
152
167
  stepTargets?: string[];
153
168
  /**
169
+ * @public
154
170
  * <p>The tags to add on a migration workflow.</p>
155
171
  */
156
172
  tags?: Record<string, string>;
@@ -184,46 +200,57 @@ export type MigrationWorkflowStatusEnum = (typeof MigrationWorkflowStatusEnum)[k
184
200
  */
185
201
  export interface CreateMigrationWorkflowResponse {
186
202
  /**
203
+ * @public
187
204
  * <p>The ID of the migration workflow.</p>
188
205
  */
189
206
  id?: string;
190
207
  /**
208
+ * @public
191
209
  * <p>The Amazon Resource Name (ARN) of the migration workflow.</p>
192
210
  */
193
211
  arn?: string;
194
212
  /**
213
+ * @public
195
214
  * <p>The name of the migration workflow.</p>
196
215
  */
197
216
  name?: string;
198
217
  /**
218
+ * @public
199
219
  * <p>The description of the migration workflow.</p>
200
220
  */
201
221
  description?: string;
202
222
  /**
223
+ * @public
203
224
  * <p>The ID of the template.</p>
204
225
  */
205
226
  templateId?: string;
206
227
  /**
228
+ * @public
207
229
  * <p>The configuration ID of the application configured in Application Discovery Service.</p>
208
230
  */
209
231
  adsApplicationConfigurationId?: string;
210
232
  /**
233
+ * @public
211
234
  * <p>The inputs for creating a migration workflow.</p>
212
235
  */
213
236
  workflowInputs?: Record<string, StepInput>;
214
237
  /**
238
+ * @public
215
239
  * <p>The servers on which a step will be run.</p>
216
240
  */
217
241
  stepTargets?: string[];
218
242
  /**
243
+ * @public
219
244
  * <p>The status of the migration workflow.</p>
220
245
  */
221
246
  status?: MigrationWorkflowStatusEnum | string;
222
247
  /**
248
+ * @public
223
249
  * <p>The time at which the migration workflow was created.</p>
224
250
  */
225
251
  creationTime?: Date;
226
252
  /**
253
+ * @public
227
254
  * <p>The tags to add on a migration workflow.</p>
228
255
  */
229
256
  tags?: Record<string, string>;
@@ -257,6 +284,7 @@ export declare class ThrottlingException extends __BaseException {
257
284
  */
258
285
  export interface DeleteMigrationWorkflowRequest {
259
286
  /**
287
+ * @public
260
288
  * <p>The ID of the migration workflow you want to delete.</p>
261
289
  */
262
290
  id: string | undefined;
@@ -266,14 +294,17 @@ export interface DeleteMigrationWorkflowRequest {
266
294
  */
267
295
  export interface DeleteMigrationWorkflowResponse {
268
296
  /**
297
+ * @public
269
298
  * <p>The ID of the migration workflow.</p>
270
299
  */
271
300
  id?: string;
272
301
  /**
302
+ * @public
273
303
  * <p>The Amazon Resource Name (ARN) of the migration workflow.</p>
274
304
  */
275
305
  arn?: string;
276
306
  /**
307
+ * @public
277
308
  * <p>The status of the migration workflow.</p>
278
309
  */
279
310
  status?: MigrationWorkflowStatusEnum | string;
@@ -283,6 +314,7 @@ export interface DeleteMigrationWorkflowResponse {
283
314
  */
284
315
  export interface GetMigrationWorkflowRequest {
285
316
  /**
317
+ * @public
286
318
  * <p>The ID of the migration workflow.</p>
287
319
  */
288
320
  id: string | undefined;
@@ -293,10 +325,12 @@ export interface GetMigrationWorkflowRequest {
293
325
  */
294
326
  export interface Tool {
295
327
  /**
328
+ * @public
296
329
  * <p>The name of an AWS service. </p>
297
330
  */
298
331
  name?: string;
299
332
  /**
333
+ * @public
300
334
  * <p>The URL of an AWS service.</p>
301
335
  */
302
336
  url?: string;
@@ -306,82 +340,102 @@ export interface Tool {
306
340
  */
307
341
  export interface GetMigrationWorkflowResponse {
308
342
  /**
343
+ * @public
309
344
  * <p>The ID of the migration workflow.</p>
310
345
  */
311
346
  id?: string;
312
347
  /**
348
+ * @public
313
349
  * <p>The Amazon Resource Name (ARN) of the migration workflow.</p>
314
350
  */
315
351
  arn?: string;
316
352
  /**
353
+ * @public
317
354
  * <p>The name of the migration workflow.</p>
318
355
  */
319
356
  name?: string;
320
357
  /**
358
+ * @public
321
359
  * <p>The description of the migration workflow.</p>
322
360
  */
323
361
  description?: string;
324
362
  /**
363
+ * @public
325
364
  * <p>The ID of the template.</p>
326
365
  */
327
366
  templateId?: string;
328
367
  /**
368
+ * @public
329
369
  * <p>The configuration ID of the application configured in Application Discovery Service.</p>
330
370
  */
331
371
  adsApplicationConfigurationId?: string;
332
372
  /**
373
+ * @public
333
374
  * <p>The name of the application configured in Application Discovery Service.</p>
334
375
  */
335
376
  adsApplicationName?: string;
336
377
  /**
378
+ * @public
337
379
  * <p>The status of the migration workflow.</p>
338
380
  */
339
381
  status?: MigrationWorkflowStatusEnum | string;
340
382
  /**
383
+ * @public
341
384
  * <p>The status message of the migration workflow.</p>
342
385
  */
343
386
  statusMessage?: string;
344
387
  /**
388
+ * @public
345
389
  * <p>The time at which the migration workflow was created.</p>
346
390
  */
347
391
  creationTime?: Date;
348
392
  /**
393
+ * @public
349
394
  * <p>The time at which the migration workflow was last started.</p>
350
395
  */
351
396
  lastStartTime?: Date;
352
397
  /**
398
+ * @public
353
399
  * <p>The time at which the migration workflow was last stopped.</p>
354
400
  */
355
401
  lastStopTime?: Date;
356
402
  /**
403
+ * @public
357
404
  * <p>The time at which the migration workflow was last modified.</p>
358
405
  */
359
406
  lastModifiedTime?: Date;
360
407
  /**
408
+ * @public
361
409
  * <p>The time at which the migration workflow ended.</p>
362
410
  */
363
411
  endTime?: Date;
364
412
  /**
413
+ * @public
365
414
  * <p>List of AWS services utilized in a migration workflow.</p>
366
415
  */
367
416
  tools?: Tool[];
368
417
  /**
418
+ * @public
369
419
  * <p>The total number of steps in the migration workflow.</p>
370
420
  */
371
421
  totalSteps?: number;
372
422
  /**
423
+ * @public
373
424
  * <p>Get a list of completed steps in the migration workflow.</p>
374
425
  */
375
426
  completedSteps?: number;
376
427
  /**
428
+ * @public
377
429
  * <p>The inputs required for creating the migration workflow.</p>
378
430
  */
379
431
  workflowInputs?: Record<string, StepInput>;
380
432
  /**
433
+ * @public
381
434
  * <p>The tags added to the migration workflow.</p>
382
435
  */
383
436
  tags?: Record<string, string>;
384
437
  /**
438
+ * @public
385
439
  * <p>The Amazon S3 bucket where the migration logs are stored.</p>
386
440
  */
387
441
  workflowBucket?: string;
@@ -391,26 +445,32 @@ export interface GetMigrationWorkflowResponse {
391
445
  */
392
446
  export interface ListMigrationWorkflowsRequest {
393
447
  /**
448
+ * @public
394
449
  * <p>The maximum number of results that can be returned.</p>
395
450
  */
396
451
  maxResults?: number;
397
452
  /**
453
+ * @public
398
454
  * <p>The pagination token.</p>
399
455
  */
400
456
  nextToken?: string;
401
457
  /**
458
+ * @public
402
459
  * <p>The ID of the template.</p>
403
460
  */
404
461
  templateId?: string;
405
462
  /**
463
+ * @public
406
464
  * <p>The name of the application configured in Application Discovery Service.</p>
407
465
  */
408
466
  adsApplicationConfigurationName?: string;
409
467
  /**
468
+ * @public
410
469
  * <p>The status of the migration workflow.</p>
411
470
  */
412
471
  status?: MigrationWorkflowStatusEnum | string;
413
472
  /**
473
+ * @public
414
474
  * <p>The name of the migration workflow.</p>
415
475
  */
416
476
  name?: string;
@@ -421,42 +481,52 @@ export interface ListMigrationWorkflowsRequest {
421
481
  */
422
482
  export interface MigrationWorkflowSummary {
423
483
  /**
484
+ * @public
424
485
  * <p>The ID of the migration workflow.</p>
425
486
  */
426
487
  id?: string;
427
488
  /**
489
+ * @public
428
490
  * <p>The name of the migration workflow.</p>
429
491
  */
430
492
  name?: string;
431
493
  /**
494
+ * @public
432
495
  * <p>The ID of the template.</p>
433
496
  */
434
497
  templateId?: string;
435
498
  /**
499
+ * @public
436
500
  * <p>The name of the application configured in Application Discovery Service.</p>
437
501
  */
438
502
  adsApplicationConfigurationName?: string;
439
503
  /**
504
+ * @public
440
505
  * <p>The status of the migration workflow.</p>
441
506
  */
442
507
  status?: MigrationWorkflowStatusEnum | string;
443
508
  /**
509
+ * @public
444
510
  * <p>The time at which the migration workflow was created.</p>
445
511
  */
446
512
  creationTime?: Date;
447
513
  /**
514
+ * @public
448
515
  * <p>The time at which the migration workflow ended.</p>
449
516
  */
450
517
  endTime?: Date;
451
518
  /**
519
+ * @public
452
520
  * <p>The status message of the migration workflow.</p>
453
521
  */
454
522
  statusMessage?: string;
455
523
  /**
524
+ * @public
456
525
  * <p>The steps completed in the migration workflow.</p>
457
526
  */
458
527
  completedSteps?: number;
459
528
  /**
529
+ * @public
460
530
  * <p>All the steps in a migration workflow.</p>
461
531
  */
462
532
  totalSteps?: number;
@@ -466,10 +536,12 @@ export interface MigrationWorkflowSummary {
466
536
  */
467
537
  export interface ListMigrationWorkflowsResponse {
468
538
  /**
539
+ * @public
469
540
  * <p>The pagination token.</p>
470
541
  */
471
542
  nextToken?: string;
472
543
  /**
544
+ * @public
473
545
  * <p>The summary of the migration workflow.</p>
474
546
  */
475
547
  migrationWorkflowSummary: MigrationWorkflowSummary[] | undefined;
@@ -479,6 +551,7 @@ export interface ListMigrationWorkflowsResponse {
479
551
  */
480
552
  export interface StartMigrationWorkflowRequest {
481
553
  /**
554
+ * @public
482
555
  * <p>The ID of the migration workflow.</p>
483
556
  */
484
557
  id: string | undefined;
@@ -488,22 +561,27 @@ export interface StartMigrationWorkflowRequest {
488
561
  */
489
562
  export interface StartMigrationWorkflowResponse {
490
563
  /**
564
+ * @public
491
565
  * <p>The ID of the migration workflow.</p>
492
566
  */
493
567
  id?: string;
494
568
  /**
569
+ * @public
495
570
  * <p>The Amazon Resource Name (ARN) of the migration workflow.</p>
496
571
  */
497
572
  arn?: string;
498
573
  /**
574
+ * @public
499
575
  * <p>The status of the migration workflow.</p>
500
576
  */
501
577
  status?: MigrationWorkflowStatusEnum | string;
502
578
  /**
579
+ * @public
503
580
  * <p>The status message of the migration workflow.</p>
504
581
  */
505
582
  statusMessage?: string;
506
583
  /**
584
+ * @public
507
585
  * <p>The time at which the migration workflow was last started.</p>
508
586
  */
509
587
  lastStartTime?: Date;
@@ -513,6 +591,7 @@ export interface StartMigrationWorkflowResponse {
513
591
  */
514
592
  export interface StopMigrationWorkflowRequest {
515
593
  /**
594
+ * @public
516
595
  * <p>The ID of the migration workflow.</p>
517
596
  */
518
597
  id: string | undefined;
@@ -522,22 +601,27 @@ export interface StopMigrationWorkflowRequest {
522
601
  */
523
602
  export interface StopMigrationWorkflowResponse {
524
603
  /**
604
+ * @public
525
605
  * <p>The ID of the migration workflow.</p>
526
606
  */
527
607
  id?: string;
528
608
  /**
609
+ * @public
529
610
  * <p>The Amazon Resource Name (ARN) of the migration workflow.</p>
530
611
  */
531
612
  arn?: string;
532
613
  /**
614
+ * @public
533
615
  * <p>The status of the migration workflow.</p>
534
616
  */
535
617
  status?: MigrationWorkflowStatusEnum | string;
536
618
  /**
619
+ * @public
537
620
  * <p>The status message of the migration workflow.</p>
538
621
  */
539
622
  statusMessage?: string;
540
623
  /**
624
+ * @public
541
625
  * <p>The time at which the migration workflow was stopped.</p>
542
626
  */
543
627
  lastStopTime?: Date;
@@ -547,22 +631,27 @@ export interface StopMigrationWorkflowResponse {
547
631
  */
548
632
  export interface UpdateMigrationWorkflowRequest {
549
633
  /**
634
+ * @public
550
635
  * <p>The ID of the migration workflow.</p>
551
636
  */
552
637
  id: string | undefined;
553
638
  /**
639
+ * @public
554
640
  * <p>The name of the migration workflow.</p>
555
641
  */
556
642
  name?: string;
557
643
  /**
644
+ * @public
558
645
  * <p>The description of the migration workflow.</p>
559
646
  */
560
647
  description?: string;
561
648
  /**
649
+ * @public
562
650
  * <p>The input parameters required to update a migration workflow.</p>
563
651
  */
564
652
  inputParameters?: Record<string, StepInput>;
565
653
  /**
654
+ * @public
566
655
  * <p>The servers on which a step will be run.</p>
567
656
  */
568
657
  stepTargets?: string[];
@@ -572,50 +661,62 @@ export interface UpdateMigrationWorkflowRequest {
572
661
  */
573
662
  export interface UpdateMigrationWorkflowResponse {
574
663
  /**
664
+ * @public
575
665
  * <p>The ID of the migration workflow.</p>
576
666
  */
577
667
  id?: string;
578
668
  /**
669
+ * @public
579
670
  * <p>The Amazon Resource Name (ARN) of the migration workflow.</p>
580
671
  */
581
672
  arn?: string;
582
673
  /**
674
+ * @public
583
675
  * <p>The name of the migration workflow.</p>
584
676
  */
585
677
  name?: string;
586
678
  /**
679
+ * @public
587
680
  * <p>The description of the migration workflow.</p>
588
681
  */
589
682
  description?: string;
590
683
  /**
684
+ * @public
591
685
  * <p>The ID of the template.</p>
592
686
  */
593
687
  templateId?: string;
594
688
  /**
689
+ * @public
595
690
  * <p>The ID of the application configured in Application Discovery Service.</p>
596
691
  */
597
692
  adsApplicationConfigurationId?: string;
598
693
  /**
694
+ * @public
599
695
  * <p>The inputs required to update a migration workflow.</p>
600
696
  */
601
697
  workflowInputs?: Record<string, StepInput>;
602
698
  /**
699
+ * @public
603
700
  * <p>The servers on which a step will be run.</p>
604
701
  */
605
702
  stepTargets?: string[];
606
703
  /**
704
+ * @public
607
705
  * <p>The status of the migration workflow.</p>
608
706
  */
609
707
  status?: MigrationWorkflowStatusEnum | string;
610
708
  /**
709
+ * @public
611
710
  * <p>The time at which the migration workflow was created.</p>
612
711
  */
613
712
  creationTime?: Date;
614
713
  /**
714
+ * @public
615
715
  * <p>The time at which the migration workflow was last modified.</p>
616
716
  */
617
717
  lastModifiedTime?: Date;
618
718
  /**
719
+ * @public
619
720
  * <p>The tags added to the migration workflow.</p>
620
721
  */
621
722
  tags?: Record<string, string>;
@@ -625,6 +726,7 @@ export interface UpdateMigrationWorkflowResponse {
625
726
  */
626
727
  export interface GetMigrationWorkflowTemplateRequest {
627
728
  /**
729
+ * @public
628
730
  * <p>The ID of the template.</p>
629
731
  */
630
732
  id: string | undefined;
@@ -649,14 +751,17 @@ export type DataType = (typeof DataType)[keyof typeof DataType];
649
751
  */
650
752
  export interface TemplateInput {
651
753
  /**
754
+ * @public
652
755
  * <p>The name of the template.</p>
653
756
  */
654
757
  inputName?: string;
655
758
  /**
759
+ * @public
656
760
  * <p>The data type of the template input.</p>
657
761
  */
658
762
  dataType?: DataType | string;
659
763
  /**
764
+ * @public
660
765
  * <p>Determine if an input is required from the template.</p>
661
766
  */
662
767
  required?: boolean;
@@ -677,30 +782,37 @@ export type TemplateStatus = (typeof TemplateStatus)[keyof typeof TemplateStatus
677
782
  */
678
783
  export interface GetMigrationWorkflowTemplateResponse {
679
784
  /**
785
+ * @public
680
786
  * <p>The ID of the template.</p>
681
787
  */
682
788
  id?: string;
683
789
  /**
790
+ * @public
684
791
  * <p>The name of the template.</p>
685
792
  */
686
793
  name?: string;
687
794
  /**
795
+ * @public
688
796
  * <p>The time at which the template was last created.</p>
689
797
  */
690
798
  description?: string;
691
799
  /**
800
+ * @public
692
801
  * <p>The inputs provided for the creation of the migration workflow.</p>
693
802
  */
694
803
  inputs?: TemplateInput[];
695
804
  /**
805
+ * @public
696
806
  * <p>List of AWS services utilized in a migration workflow.</p>
697
807
  */
698
808
  tools?: Tool[];
699
809
  /**
810
+ * @public
700
811
  * <p>The status of the template.</p>
701
812
  */
702
813
  status?: TemplateStatus | string;
703
814
  /**
815
+ * @public
704
816
  * <p>The time at which the template was last created.</p>
705
817
  */
706
818
  creationTime?: Date;
@@ -710,14 +822,17 @@ export interface GetMigrationWorkflowTemplateResponse {
710
822
  */
711
823
  export interface ListMigrationWorkflowTemplatesRequest {
712
824
  /**
825
+ * @public
713
826
  * <p>The maximum number of results that can be returned.</p>
714
827
  */
715
828
  maxResults?: number;
716
829
  /**
830
+ * @public
717
831
  * <p>The pagination token.</p>
718
832
  */
719
833
  nextToken?: string;
720
834
  /**
835
+ * @public
721
836
  * <p>The name of the template.</p>
722
837
  */
723
838
  name?: string;
@@ -728,18 +843,22 @@ export interface ListMigrationWorkflowTemplatesRequest {
728
843
  */
729
844
  export interface TemplateSummary {
730
845
  /**
846
+ * @public
731
847
  * <p>The ID of the template.</p>
732
848
  */
733
849
  id?: string;
734
850
  /**
851
+ * @public
735
852
  * <p>The name of the template.</p>
736
853
  */
737
854
  name?: string;
738
855
  /**
856
+ * @public
739
857
  * <p>The Amazon Resource Name (ARN) of the template.</p>
740
858
  */
741
859
  arn?: string;
742
860
  /**
861
+ * @public
743
862
  * <p>The description of the template.</p>
744
863
  */
745
864
  description?: string;
@@ -749,10 +868,12 @@ export interface TemplateSummary {
749
868
  */
750
869
  export interface ListMigrationWorkflowTemplatesResponse {
751
870
  /**
871
+ * @public
752
872
  * <p>The pagination token.</p>
753
873
  */
754
874
  nextToken?: string;
755
875
  /**
876
+ * @public
756
877
  * <p>The summary of the template.</p>
757
878
  */
758
879
  templateSummary: TemplateSummary[] | undefined;
@@ -762,10 +883,12 @@ export interface ListMigrationWorkflowTemplatesResponse {
762
883
  */
763
884
  export interface ListPluginsRequest {
764
885
  /**
886
+ * @public
765
887
  * <p>The maximum number of plugins that can be returned.</p>
766
888
  */
767
889
  maxResults?: number;
768
890
  /**
891
+ * @public
769
892
  * <p>The pagination token.</p>
770
893
  */
771
894
  nextToken?: string;
@@ -788,26 +911,32 @@ export type PluginHealth = (typeof PluginHealth)[keyof typeof PluginHealth];
788
911
  */
789
912
  export interface PluginSummary {
790
913
  /**
914
+ * @public
791
915
  * <p>The ID of the plugin.</p>
792
916
  */
793
917
  pluginId?: string;
794
918
  /**
919
+ * @public
795
920
  * <p>The name of the host.</p>
796
921
  */
797
922
  hostname?: string;
798
923
  /**
924
+ * @public
799
925
  * <p>The status of the plugin.</p>
800
926
  */
801
927
  status?: PluginHealth | string;
802
928
  /**
929
+ * @public
803
930
  * <p>The IP address at which the plugin is located.</p>
804
931
  */
805
932
  ipAddress?: string;
806
933
  /**
934
+ * @public
807
935
  * <p>The version of the plugin.</p>
808
936
  */
809
937
  version?: string;
810
938
  /**
939
+ * @public
811
940
  * <p>The time at which the plugin was registered.</p>
812
941
  */
813
942
  registeredTime?: string;
@@ -817,10 +946,12 @@ export interface PluginSummary {
817
946
  */
818
947
  export interface ListPluginsResponse {
819
948
  /**
949
+ * @public
820
950
  * <p>The pagination token.</p>
821
951
  */
822
952
  nextToken?: string;
823
953
  /**
954
+ * @public
824
955
  * <p>Migration Hub Orchestrator plugins.</p>
825
956
  */
826
957
  plugins?: PluginSummary[];
@@ -830,10 +961,12 @@ export interface ListPluginsResponse {
830
961
  */
831
962
  export interface TagResourceRequest {
832
963
  /**
964
+ * @public
833
965
  * <p>The Amazon Resource Name (ARN) of the resource to which you want to add tags.</p>
834
966
  */
835
967
  resourceArn: string | undefined;
836
968
  /**
969
+ * @public
837
970
  * <p>A collection of labels, in the form of key:value pairs, that apply to this
838
971
  * resource.</p>
839
972
  */
@@ -849,14 +982,17 @@ export interface TagResourceResponse {
849
982
  */
850
983
  export interface GetTemplateStepRequest {
851
984
  /**
985
+ * @public
852
986
  * <p>The ID of the step.</p>
853
987
  */
854
988
  id: string | undefined;
855
989
  /**
990
+ * @public
856
991
  * <p>The ID of the template.</p>
857
992
  */
858
993
  templateId: string | undefined;
859
994
  /**
995
+ * @public
860
996
  * <p>The ID of the step group.</p>
861
997
  */
862
998
  stepGroupId: string | undefined;
@@ -867,14 +1003,17 @@ export interface GetTemplateStepRequest {
867
1003
  */
868
1004
  export interface StepOutput {
869
1005
  /**
1006
+ * @public
870
1007
  * <p>The name of the step.</p>
871
1008
  */
872
1009
  name?: string;
873
1010
  /**
1011
+ * @public
874
1012
  * <p>The data type of the step output.</p>
875
1013
  */
876
1014
  dataType?: DataType | string;
877
1015
  /**
1016
+ * @public
878
1017
  * <p>Determine if an output is required from a step.</p>
879
1018
  */
880
1019
  required?: boolean;
@@ -897,10 +1036,12 @@ export type StepActionType = (typeof StepActionType)[keyof typeof StepActionType
897
1036
  */
898
1037
  export interface PlatformCommand {
899
1038
  /**
1039
+ * @public
900
1040
  * <p>Command for Linux.</p>
901
1041
  */
902
1042
  linux?: string;
903
1043
  /**
1044
+ * @public
904
1045
  * <p>Command for Windows.</p>
905
1046
  */
906
1047
  windows?: string;
@@ -923,10 +1064,12 @@ export type RunEnvironment = (typeof RunEnvironment)[keyof typeof RunEnvironment
923
1064
  */
924
1065
  export interface PlatformScriptKey {
925
1066
  /**
1067
+ * @public
926
1068
  * <p>The script location for Linux.</p>
927
1069
  */
928
1070
  linux?: string;
929
1071
  /**
1072
+ * @public
930
1073
  * <p>The script location for Windows.</p>
931
1074
  */
932
1075
  windows?: string;
@@ -950,22 +1093,27 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
950
1093
  */
951
1094
  export interface StepAutomationConfiguration {
952
1095
  /**
1096
+ * @public
953
1097
  * <p>The Amazon S3 bucket where the script is located.</p>
954
1098
  */
955
1099
  scriptLocationS3Bucket?: string;
956
1100
  /**
1101
+ * @public
957
1102
  * <p>The Amazon S3 key for the script location.</p>
958
1103
  */
959
1104
  scriptLocationS3Key?: PlatformScriptKey;
960
1105
  /**
1106
+ * @public
961
1107
  * <p>The command to run the script.</p>
962
1108
  */
963
1109
  command?: PlatformCommand;
964
1110
  /**
1111
+ * @public
965
1112
  * <p>The source or target environment.</p>
966
1113
  */
967
1114
  runEnvironment?: RunEnvironment | string;
968
1115
  /**
1116
+ * @public
969
1117
  * <p>The servers on which to run the script.</p>
970
1118
  */
971
1119
  targetType?: TargetType | string;
@@ -975,47 +1123,58 @@ export interface StepAutomationConfiguration {
975
1123
  */
976
1124
  export interface GetTemplateStepResponse {
977
1125
  /**
1126
+ * @public
978
1127
  * <p>The ID of the step.</p>
979
1128
  */
980
1129
  id?: string;
981
1130
  /**
1131
+ * @public
982
1132
  * <p>The ID of the step group.</p>
983
1133
  */
984
1134
  stepGroupId?: string;
985
1135
  /**
1136
+ * @public
986
1137
  * <p>The ID of the template.</p>
987
1138
  */
988
1139
  templateId?: string;
989
1140
  /**
1141
+ * @public
990
1142
  * <p>The name of the step.</p>
991
1143
  */
992
1144
  name?: string;
993
1145
  /**
1146
+ * @public
994
1147
  * <p>The description of the step.</p>
995
1148
  */
996
1149
  description?: string;
997
1150
  /**
1151
+ * @public
998
1152
  * <p>The action type of the step. You must run and update the status of a manual step for
999
1153
  * the workflow to continue after the completion of the step.</p>
1000
1154
  */
1001
1155
  stepActionType?: StepActionType | string;
1002
1156
  /**
1157
+ * @public
1003
1158
  * <p>The time at which the step was created.</p>
1004
1159
  */
1005
1160
  creationTime?: string;
1006
1161
  /**
1162
+ * @public
1007
1163
  * <p>The previous step.</p>
1008
1164
  */
1009
1165
  previous?: string[];
1010
1166
  /**
1167
+ * @public
1011
1168
  * <p>The next step.</p>
1012
1169
  */
1013
1170
  next?: string[];
1014
1171
  /**
1172
+ * @public
1015
1173
  * <p>The outputs of the step.</p>
1016
1174
  */
1017
1175
  outputs?: StepOutput[];
1018
1176
  /**
1177
+ * @public
1019
1178
  * <p>The custom script to run tests on source or target environments.</p>
1020
1179
  */
1021
1180
  stepAutomationConfiguration?: StepAutomationConfiguration;
@@ -1025,18 +1184,22 @@ export interface GetTemplateStepResponse {
1025
1184
  */
1026
1185
  export interface ListTemplateStepsRequest {
1027
1186
  /**
1187
+ * @public
1028
1188
  * <p>The maximum number of results that can be returned.</p>
1029
1189
  */
1030
1190
  maxResults?: number;
1031
1191
  /**
1192
+ * @public
1032
1193
  * <p>The pagination token.</p>
1033
1194
  */
1034
1195
  nextToken?: string;
1035
1196
  /**
1197
+ * @public
1036
1198
  * <p>The ID of the template.</p>
1037
1199
  */
1038
1200
  templateId: string | undefined;
1039
1201
  /**
1202
+ * @public
1040
1203
  * <p>The ID of the step group.</p>
1041
1204
  */
1042
1205
  stepGroupId: string | undefined;
@@ -1059,39 +1222,48 @@ export type Owner = (typeof Owner)[keyof typeof Owner];
1059
1222
  */
1060
1223
  export interface TemplateStepSummary {
1061
1224
  /**
1225
+ * @public
1062
1226
  * <p>The ID of the step.</p>
1063
1227
  */
1064
1228
  id?: string;
1065
1229
  /**
1230
+ * @public
1066
1231
  * <p>The ID of the step group.</p>
1067
1232
  */
1068
1233
  stepGroupId?: string;
1069
1234
  /**
1235
+ * @public
1070
1236
  * <p>The ID of the template.</p>
1071
1237
  */
1072
1238
  templateId?: string;
1073
1239
  /**
1240
+ * @public
1074
1241
  * <p>The name of the step.</p>
1075
1242
  */
1076
1243
  name?: string;
1077
1244
  /**
1245
+ * @public
1078
1246
  * <p>The action type of the step. You must run and update the status of a manual step for
1079
1247
  * the workflow to continue after the completion of the step.</p>
1080
1248
  */
1081
1249
  stepActionType?: StepActionType | string;
1082
1250
  /**
1251
+ * @public
1083
1252
  * <p>The servers on which to run the script.</p>
1084
1253
  */
1085
1254
  targetType?: TargetType | string;
1086
1255
  /**
1256
+ * @public
1087
1257
  * <p>The owner of the step.</p>
1088
1258
  */
1089
1259
  owner?: Owner | string;
1090
1260
  /**
1261
+ * @public
1091
1262
  * <p>The previous step.</p>
1092
1263
  */
1093
1264
  previous?: string[];
1094
1265
  /**
1266
+ * @public
1095
1267
  * <p>The next step.</p>
1096
1268
  */
1097
1269
  next?: string[];
@@ -1101,10 +1273,12 @@ export interface TemplateStepSummary {
1101
1273
  */
1102
1274
  export interface ListTemplateStepsResponse {
1103
1275
  /**
1276
+ * @public
1104
1277
  * <p>The pagination token.</p>
1105
1278
  */
1106
1279
  nextToken?: string;
1107
1280
  /**
1281
+ * @public
1108
1282
  * <p>The list of summaries of steps in a template.</p>
1109
1283
  */
1110
1284
  templateStepSummaryList?: TemplateStepSummary[];
@@ -1114,10 +1288,12 @@ export interface ListTemplateStepsResponse {
1114
1288
  */
1115
1289
  export interface GetTemplateStepGroupRequest {
1116
1290
  /**
1291
+ * @public
1117
1292
  * <p>The ID of the template.</p>
1118
1293
  */
1119
1294
  templateId: string | undefined;
1120
1295
  /**
1296
+ * @public
1121
1297
  * <p>The ID of the step group.</p>
1122
1298
  */
1123
1299
  id: string | undefined;
@@ -1145,42 +1321,52 @@ export type StepGroupStatus = (typeof StepGroupStatus)[keyof typeof StepGroupSta
1145
1321
  */
1146
1322
  export interface GetTemplateStepGroupResponse {
1147
1323
  /**
1324
+ * @public
1148
1325
  * <p>The ID of the template.</p>
1149
1326
  */
1150
1327
  templateId?: string;
1151
1328
  /**
1329
+ * @public
1152
1330
  * <p>The ID of the step group.</p>
1153
1331
  */
1154
1332
  id?: string;
1155
1333
  /**
1334
+ * @public
1156
1335
  * <p>The name of the step group.</p>
1157
1336
  */
1158
1337
  name?: string;
1159
1338
  /**
1339
+ * @public
1160
1340
  * <p>The description of the step group.</p>
1161
1341
  */
1162
1342
  description?: string;
1163
1343
  /**
1344
+ * @public
1164
1345
  * <p>The status of the step group.</p>
1165
1346
  */
1166
1347
  status?: StepGroupStatus | string;
1167
1348
  /**
1349
+ * @public
1168
1350
  * <p>The time at which the step group was created.</p>
1169
1351
  */
1170
1352
  creationTime?: Date;
1171
1353
  /**
1354
+ * @public
1172
1355
  * <p>The time at which the step group was last modified.</p>
1173
1356
  */
1174
1357
  lastModifiedTime?: Date;
1175
1358
  /**
1359
+ * @public
1176
1360
  * <p>List of AWS services utilized in a migration workflow.</p>
1177
1361
  */
1178
1362
  tools?: Tool[];
1179
1363
  /**
1364
+ * @public
1180
1365
  * <p>The previous step group.</p>
1181
1366
  */
1182
1367
  previous?: string[];
1183
1368
  /**
1369
+ * @public
1184
1370
  * <p>The next step group.</p>
1185
1371
  */
1186
1372
  next?: string[];
@@ -1190,14 +1376,17 @@ export interface GetTemplateStepGroupResponse {
1190
1376
  */
1191
1377
  export interface ListTemplateStepGroupsRequest {
1192
1378
  /**
1379
+ * @public
1193
1380
  * <p>The maximum number of results that can be returned.</p>
1194
1381
  */
1195
1382
  maxResults?: number;
1196
1383
  /**
1384
+ * @public
1197
1385
  * <p>The pagination token.</p>
1198
1386
  */
1199
1387
  nextToken?: string;
1200
1388
  /**
1389
+ * @public
1201
1390
  * <p>The ID of the template.</p>
1202
1391
  */
1203
1392
  templateId: string | undefined;
@@ -1208,18 +1397,22 @@ export interface ListTemplateStepGroupsRequest {
1208
1397
  */
1209
1398
  export interface TemplateStepGroupSummary {
1210
1399
  /**
1400
+ * @public
1211
1401
  * <p>The ID of the step group.</p>
1212
1402
  */
1213
1403
  id?: string;
1214
1404
  /**
1405
+ * @public
1215
1406
  * <p>The name of the step group.</p>
1216
1407
  */
1217
1408
  name?: string;
1218
1409
  /**
1410
+ * @public
1219
1411
  * <p>The previous step group.</p>
1220
1412
  */
1221
1413
  previous?: string[];
1222
1414
  /**
1415
+ * @public
1223
1416
  * <p>The next step group.</p>
1224
1417
  */
1225
1418
  next?: string[];
@@ -1229,10 +1422,12 @@ export interface TemplateStepGroupSummary {
1229
1422
  */
1230
1423
  export interface ListTemplateStepGroupsResponse {
1231
1424
  /**
1425
+ * @public
1232
1426
  * <p>The pagination token.</p>
1233
1427
  */
1234
1428
  nextToken?: string;
1235
1429
  /**
1430
+ * @public
1236
1431
  * <p>The summary of the step group in the template.</p>
1237
1432
  */
1238
1433
  templateStepGroupSummary: TemplateStepGroupSummary[] | undefined;
@@ -1242,11 +1437,13 @@ export interface ListTemplateStepGroupsResponse {
1242
1437
  */
1243
1438
  export interface UntagResourceRequest {
1244
1439
  /**
1440
+ * @public
1245
1441
  * <p>The Amazon Resource Name (ARN) of the resource from which you want to remove
1246
1442
  * tags.</p>
1247
1443
  */
1248
1444
  resourceArn: string | undefined;
1249
1445
  /**
1446
+ * @public
1250
1447
  * <p>One or more tag keys. Specify only the tag keys, not the tag values.</p>
1251
1448
  */
1252
1449
  tagKeys: string[] | undefined;
@@ -1266,6 +1463,7 @@ export type WorkflowStepOutputUnion = WorkflowStepOutputUnion.IntegerValueMember
1266
1463
  */
1267
1464
  export declare namespace WorkflowStepOutputUnion {
1268
1465
  /**
1466
+ * @public
1269
1467
  * <p>The integer value. </p>
1270
1468
  */
1271
1469
  interface IntegerValueMember {
@@ -1275,6 +1473,7 @@ export declare namespace WorkflowStepOutputUnion {
1275
1473
  $unknown?: never;
1276
1474
  }
1277
1475
  /**
1476
+ * @public
1278
1477
  * <p>The string value.</p>
1279
1478
  */
1280
1479
  interface StringValueMember {
@@ -1284,6 +1483,7 @@ export declare namespace WorkflowStepOutputUnion {
1284
1483
  $unknown?: never;
1285
1484
  }
1286
1485
  /**
1486
+ * @public
1287
1487
  * <p>The list of string value.</p>
1288
1488
  */
1289
1489
  interface ListOfStringValueMember {
@@ -1292,6 +1492,9 @@ export declare namespace WorkflowStepOutputUnion {
1292
1492
  listOfStringValue: string[];
1293
1493
  $unknown?: never;
1294
1494
  }
1495
+ /**
1496
+ * @public
1497
+ */
1295
1498
  interface $UnknownMember {
1296
1499
  integerValue?: never;
1297
1500
  stringValue?: never;
@@ -1312,18 +1515,22 @@ export declare namespace WorkflowStepOutputUnion {
1312
1515
  */
1313
1516
  export interface WorkflowStepOutput {
1314
1517
  /**
1518
+ * @public
1315
1519
  * <p>The name of the step.</p>
1316
1520
  */
1317
1521
  name?: string;
1318
1522
  /**
1523
+ * @public
1319
1524
  * <p>The data type of the output.</p>
1320
1525
  */
1321
1526
  dataType?: DataType | string;
1322
1527
  /**
1528
+ * @public
1323
1529
  * <p>Determine if an output is required from a step.</p>
1324
1530
  */
1325
1531
  required?: boolean;
1326
1532
  /**
1533
+ * @public
1327
1534
  * <p>The value of the output.</p>
1328
1535
  */
1329
1536
  value?: WorkflowStepOutputUnion;
@@ -1334,22 +1541,27 @@ export interface WorkflowStepOutput {
1334
1541
  */
1335
1542
  export interface WorkflowStepAutomationConfiguration {
1336
1543
  /**
1544
+ * @public
1337
1545
  * <p>The Amazon S3 bucket where the script is located.</p>
1338
1546
  */
1339
1547
  scriptLocationS3Bucket?: string;
1340
1548
  /**
1549
+ * @public
1341
1550
  * <p>The Amazon S3 key for the script location.</p>
1342
1551
  */
1343
1552
  scriptLocationS3Key?: PlatformScriptKey;
1344
1553
  /**
1554
+ * @public
1345
1555
  * <p>The command required to run the script.</p>
1346
1556
  */
1347
1557
  command?: PlatformCommand;
1348
1558
  /**
1559
+ * @public
1349
1560
  * <p>The source or target environment.</p>
1350
1561
  */
1351
1562
  runEnvironment?: RunEnvironment | string;
1352
1563
  /**
1564
+ * @public
1353
1565
  * <p>The servers on which to run the script.</p>
1354
1566
  */
1355
1567
  targetType?: TargetType | string;
@@ -1359,43 +1571,53 @@ export interface WorkflowStepAutomationConfiguration {
1359
1571
  */
1360
1572
  export interface CreateWorkflowStepRequest {
1361
1573
  /**
1574
+ * @public
1362
1575
  * <p>The name of the step.</p>
1363
1576
  */
1364
1577
  name: string | undefined;
1365
1578
  /**
1579
+ * @public
1366
1580
  * <p>The ID of the step group.</p>
1367
1581
  */
1368
1582
  stepGroupId: string | undefined;
1369
1583
  /**
1584
+ * @public
1370
1585
  * <p>The ID of the migration workflow.</p>
1371
1586
  */
1372
1587
  workflowId: string | undefined;
1373
1588
  /**
1589
+ * @public
1374
1590
  * <p>The action type of the step. You must run and update the status of a manual step for
1375
1591
  * the workflow to continue after the completion of the step.</p>
1376
1592
  */
1377
1593
  stepActionType: StepActionType | string | undefined;
1378
1594
  /**
1595
+ * @public
1379
1596
  * <p>The description of the step.</p>
1380
1597
  */
1381
1598
  description?: string;
1382
1599
  /**
1600
+ * @public
1383
1601
  * <p>The custom script to run tests on source or target environments.</p>
1384
1602
  */
1385
1603
  workflowStepAutomationConfiguration?: WorkflowStepAutomationConfiguration;
1386
1604
  /**
1605
+ * @public
1387
1606
  * <p>The servers on which a step will be run.</p>
1388
1607
  */
1389
1608
  stepTarget?: string[];
1390
1609
  /**
1610
+ * @public
1391
1611
  * <p>The key value pairs added for the expected output.</p>
1392
1612
  */
1393
1613
  outputs?: WorkflowStepOutput[];
1394
1614
  /**
1615
+ * @public
1395
1616
  * <p>The previous step.</p>
1396
1617
  */
1397
1618
  previous?: string[];
1398
1619
  /**
1620
+ * @public
1399
1621
  * <p>The next step.</p>
1400
1622
  */
1401
1623
  next?: string[];
@@ -1405,18 +1627,22 @@ export interface CreateWorkflowStepRequest {
1405
1627
  */
1406
1628
  export interface CreateWorkflowStepResponse {
1407
1629
  /**
1630
+ * @public
1408
1631
  * <p>The ID of the step.</p>
1409
1632
  */
1410
1633
  id?: string;
1411
1634
  /**
1635
+ * @public
1412
1636
  * <p>The ID of the step group.</p>
1413
1637
  */
1414
1638
  stepGroupId?: string;
1415
1639
  /**
1640
+ * @public
1416
1641
  * <p>The ID of the migration workflow.</p>
1417
1642
  */
1418
1643
  workflowId?: string;
1419
1644
  /**
1645
+ * @public
1420
1646
  * <p>The name of the step.</p>
1421
1647
  */
1422
1648
  name?: string;
@@ -1426,14 +1652,17 @@ export interface CreateWorkflowStepResponse {
1426
1652
  */
1427
1653
  export interface DeleteWorkflowStepRequest {
1428
1654
  /**
1655
+ * @public
1429
1656
  * <p>The ID of the step you want to delete.</p>
1430
1657
  */
1431
1658
  id: string | undefined;
1432
1659
  /**
1660
+ * @public
1433
1661
  * <p>The ID of the step group that contains the step you want to delete.</p>
1434
1662
  */
1435
1663
  stepGroupId: string | undefined;
1436
1664
  /**
1665
+ * @public
1437
1666
  * <p>The ID of the migration workflow.</p>
1438
1667
  */
1439
1668
  workflowId: string | undefined;
@@ -1448,14 +1677,17 @@ export interface DeleteWorkflowStepResponse {
1448
1677
  */
1449
1678
  export interface GetWorkflowStepRequest {
1450
1679
  /**
1680
+ * @public
1451
1681
  * <p>The ID of the migration workflow.</p>
1452
1682
  */
1453
1683
  workflowId: string | undefined;
1454
1684
  /**
1685
+ * @public
1455
1686
  * <p>desThe ID of the step group.</p>
1456
1687
  */
1457
1688
  stepGroupId: string | undefined;
1458
1689
  /**
1690
+ * @public
1459
1691
  * <p>The ID of the step.</p>
1460
1692
  */
1461
1693
  id: string | undefined;
@@ -1482,87 +1714,108 @@ export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus];
1482
1714
  */
1483
1715
  export interface GetWorkflowStepResponse {
1484
1716
  /**
1717
+ * @public
1485
1718
  * <p>The name of the step.</p>
1486
1719
  */
1487
1720
  name?: string;
1488
1721
  /**
1722
+ * @public
1489
1723
  * <p>The ID of the step group.</p>
1490
1724
  */
1491
1725
  stepGroupId?: string;
1492
1726
  /**
1727
+ * @public
1493
1728
  * <p>The ID of the migration workflow.</p>
1494
1729
  */
1495
1730
  workflowId?: string;
1496
1731
  /**
1732
+ * @public
1497
1733
  * <p>The ID of the step.</p>
1498
1734
  */
1499
1735
  stepId?: string;
1500
1736
  /**
1737
+ * @public
1501
1738
  * <p>The description of the step.</p>
1502
1739
  */
1503
1740
  description?: string;
1504
1741
  /**
1742
+ * @public
1505
1743
  * <p>The action type of the step. You must run and update the status of a manual step for
1506
1744
  * the workflow to continue after the completion of the step.</p>
1507
1745
  */
1508
1746
  stepActionType?: StepActionType | string;
1509
1747
  /**
1748
+ * @public
1510
1749
  * <p>The owner of the step.</p>
1511
1750
  */
1512
1751
  owner?: Owner | string;
1513
1752
  /**
1753
+ * @public
1514
1754
  * <p>The custom script to run tests on source or target environments.</p>
1515
1755
  */
1516
1756
  workflowStepAutomationConfiguration?: WorkflowStepAutomationConfiguration;
1517
1757
  /**
1758
+ * @public
1518
1759
  * <p>The servers on which a step will be run.</p>
1519
1760
  */
1520
1761
  stepTarget?: string[];
1521
1762
  /**
1763
+ * @public
1522
1764
  * <p>The outputs of the step.</p>
1523
1765
  */
1524
1766
  outputs?: WorkflowStepOutput[];
1525
1767
  /**
1768
+ * @public
1526
1769
  * <p>The previous step.</p>
1527
1770
  */
1528
1771
  previous?: string[];
1529
1772
  /**
1773
+ * @public
1530
1774
  * <p>The next step.</p>
1531
1775
  */
1532
1776
  next?: string[];
1533
1777
  /**
1778
+ * @public
1534
1779
  * <p>The status of the step.</p>
1535
1780
  */
1536
1781
  status?: StepStatus | string;
1537
1782
  /**
1783
+ * @public
1538
1784
  * <p>The status message of the migration workflow.</p>
1539
1785
  */
1540
1786
  statusMessage?: string;
1541
1787
  /**
1788
+ * @public
1542
1789
  * <p>The output location of the script.</p>
1543
1790
  */
1544
1791
  scriptOutputLocation?: string;
1545
1792
  /**
1793
+ * @public
1546
1794
  * <p>The time at which the step was created.</p>
1547
1795
  */
1548
1796
  creationTime?: Date;
1549
1797
  /**
1798
+ * @public
1550
1799
  * <p>The time at which the workflow was last started.</p>
1551
1800
  */
1552
1801
  lastStartTime?: Date;
1553
1802
  /**
1803
+ * @public
1554
1804
  * <p>The time at which the step ended.</p>
1555
1805
  */
1556
1806
  endTime?: Date;
1557
1807
  /**
1808
+ * @public
1558
1809
  * <p>The number of servers that have been migrated.</p>
1559
1810
  */
1560
1811
  noOfSrvCompleted?: number;
1561
1812
  /**
1813
+ * @public
1562
1814
  * <p>The number of servers that have failed to migrate.</p>
1563
1815
  */
1564
1816
  noOfSrvFailed?: number;
1565
1817
  /**
1818
+ * @public
1566
1819
  * <p>The total number of servers that have been migrated.</p>
1567
1820
  */
1568
1821
  totalNoOfSrv?: number;
@@ -1572,18 +1825,22 @@ export interface GetWorkflowStepResponse {
1572
1825
  */
1573
1826
  export interface ListWorkflowStepsRequest {
1574
1827
  /**
1828
+ * @public
1575
1829
  * <p>The pagination token.</p>
1576
1830
  */
1577
1831
  nextToken?: string;
1578
1832
  /**
1833
+ * @public
1579
1834
  * <p>The maximum number of results that can be returned.</p>
1580
1835
  */
1581
1836
  maxResults?: number;
1582
1837
  /**
1838
+ * @public
1583
1839
  * <p>The ID of the migration workflow.</p>
1584
1840
  */
1585
1841
  workflowId: string | undefined;
1586
1842
  /**
1843
+ * @public
1587
1844
  * <p>The ID of the step group.</p>
1588
1845
  */
1589
1846
  stepGroupId: string | undefined;
@@ -1594,55 +1851,68 @@ export interface ListWorkflowStepsRequest {
1594
1851
  */
1595
1852
  export interface WorkflowStepSummary {
1596
1853
  /**
1854
+ * @public
1597
1855
  * <p>The ID of the step.</p>
1598
1856
  */
1599
1857
  stepId?: string;
1600
1858
  /**
1859
+ * @public
1601
1860
  * <p>The name of the step.</p>
1602
1861
  */
1603
1862
  name?: string;
1604
1863
  /**
1864
+ * @public
1605
1865
  * <p>The action type of the step. You must run and update the status of a manual step for
1606
1866
  * the workflow to continue after the completion of the step.</p>
1607
1867
  */
1608
1868
  stepActionType?: StepActionType | string;
1609
1869
  /**
1870
+ * @public
1610
1871
  * <p>The owner of the step.</p>
1611
1872
  */
1612
1873
  owner?: Owner | string;
1613
1874
  /**
1875
+ * @public
1614
1876
  * <p>The previous step.</p>
1615
1877
  */
1616
1878
  previous?: string[];
1617
1879
  /**
1880
+ * @public
1618
1881
  * <p>The next step.</p>
1619
1882
  */
1620
1883
  next?: string[];
1621
1884
  /**
1885
+ * @public
1622
1886
  * <p>The status of the step.</p>
1623
1887
  */
1624
1888
  status?: StepStatus | string;
1625
1889
  /**
1890
+ * @public
1626
1891
  * <p>The status message of the migration workflow.</p>
1627
1892
  */
1628
1893
  statusMessage?: string;
1629
1894
  /**
1895
+ * @public
1630
1896
  * <p>The number of servers that have been migrated.</p>
1631
1897
  */
1632
1898
  noOfSrvCompleted?: number;
1633
1899
  /**
1900
+ * @public
1634
1901
  * <p>The number of servers that have failed to migrate.</p>
1635
1902
  */
1636
1903
  noOfSrvFailed?: number;
1637
1904
  /**
1905
+ * @public
1638
1906
  * <p>The total number of servers that have been migrated.</p>
1639
1907
  */
1640
1908
  totalNoOfSrv?: number;
1641
1909
  /**
1910
+ * @public
1642
1911
  * <p>The description of the step.</p>
1643
1912
  */
1644
1913
  description?: string;
1645
1914
  /**
1915
+ * @public
1646
1916
  * <p>The location of the script.</p>
1647
1917
  */
1648
1918
  scriptLocation?: string;
@@ -1652,10 +1922,12 @@ export interface WorkflowStepSummary {
1652
1922
  */
1653
1923
  export interface ListWorkflowStepsResponse {
1654
1924
  /**
1925
+ * @public
1655
1926
  * <p>The pagination token.</p>
1656
1927
  */
1657
1928
  nextToken?: string;
1658
1929
  /**
1930
+ * @public
1659
1931
  * <p>The summary of steps in a migration workflow.</p>
1660
1932
  */
1661
1933
  workflowStepsSummary: WorkflowStepSummary[] | undefined;
@@ -1665,14 +1937,17 @@ export interface ListWorkflowStepsResponse {
1665
1937
  */
1666
1938
  export interface RetryWorkflowStepRequest {
1667
1939
  /**
1940
+ * @public
1668
1941
  * <p>The ID of the migration workflow.</p>
1669
1942
  */
1670
1943
  workflowId: string | undefined;
1671
1944
  /**
1945
+ * @public
1672
1946
  * <p>The ID of the step group.</p>
1673
1947
  */
1674
1948
  stepGroupId: string | undefined;
1675
1949
  /**
1950
+ * @public
1676
1951
  * <p>The ID of the step.</p>
1677
1952
  */
1678
1953
  id: string | undefined;
@@ -1682,18 +1957,22 @@ export interface RetryWorkflowStepRequest {
1682
1957
  */
1683
1958
  export interface RetryWorkflowStepResponse {
1684
1959
  /**
1960
+ * @public
1685
1961
  * <p>The ID of the step group.</p>
1686
1962
  */
1687
1963
  stepGroupId?: string;
1688
1964
  /**
1965
+ * @public
1689
1966
  * <p>The ID of the migration workflow.</p>
1690
1967
  */
1691
1968
  workflowId?: string;
1692
1969
  /**
1970
+ * @public
1693
1971
  * <p>The ID of the step.</p>
1694
1972
  */
1695
1973
  id?: string;
1696
1974
  /**
1975
+ * @public
1697
1976
  * <p>The status of the step.</p>
1698
1977
  */
1699
1978
  status?: StepStatus | string;
@@ -1703,51 +1982,63 @@ export interface RetryWorkflowStepResponse {
1703
1982
  */
1704
1983
  export interface UpdateWorkflowStepRequest {
1705
1984
  /**
1985
+ * @public
1706
1986
  * <p>The ID of the step.</p>
1707
1987
  */
1708
1988
  id: string | undefined;
1709
1989
  /**
1990
+ * @public
1710
1991
  * <p>The ID of the step group.</p>
1711
1992
  */
1712
1993
  stepGroupId: string | undefined;
1713
1994
  /**
1995
+ * @public
1714
1996
  * <p>The ID of the migration workflow.</p>
1715
1997
  */
1716
1998
  workflowId: string | undefined;
1717
1999
  /**
2000
+ * @public
1718
2001
  * <p>The name of the step.</p>
1719
2002
  */
1720
2003
  name?: string;
1721
2004
  /**
2005
+ * @public
1722
2006
  * <p>The description of the step.</p>
1723
2007
  */
1724
2008
  description?: string;
1725
2009
  /**
2010
+ * @public
1726
2011
  * <p>The action type of the step. You must run and update the status of a manual step for
1727
2012
  * the workflow to continue after the completion of the step.</p>
1728
2013
  */
1729
2014
  stepActionType?: StepActionType | string;
1730
2015
  /**
2016
+ * @public
1731
2017
  * <p>The custom script to run tests on the source and target environments.</p>
1732
2018
  */
1733
2019
  workflowStepAutomationConfiguration?: WorkflowStepAutomationConfiguration;
1734
2020
  /**
2021
+ * @public
1735
2022
  * <p>The servers on which a step will be run.</p>
1736
2023
  */
1737
2024
  stepTarget?: string[];
1738
2025
  /**
2026
+ * @public
1739
2027
  * <p>The outputs of a step.</p>
1740
2028
  */
1741
2029
  outputs?: WorkflowStepOutput[];
1742
2030
  /**
2031
+ * @public
1743
2032
  * <p>The previous step.</p>
1744
2033
  */
1745
2034
  previous?: string[];
1746
2035
  /**
2036
+ * @public
1747
2037
  * <p>The next step.</p>
1748
2038
  */
1749
2039
  next?: string[];
1750
2040
  /**
2041
+ * @public
1751
2042
  * <p>The status of the step.</p>
1752
2043
  */
1753
2044
  status?: StepStatus | string;
@@ -1757,18 +2048,22 @@ export interface UpdateWorkflowStepRequest {
1757
2048
  */
1758
2049
  export interface UpdateWorkflowStepResponse {
1759
2050
  /**
2051
+ * @public
1760
2052
  * <p>The ID of the step.</p>
1761
2053
  */
1762
2054
  id?: string;
1763
2055
  /**
2056
+ * @public
1764
2057
  * <p>The ID of the step group.</p>
1765
2058
  */
1766
2059
  stepGroupId?: string;
1767
2060
  /**
2061
+ * @public
1768
2062
  * <p>The ID of the migration workflow.</p>
1769
2063
  */
1770
2064
  workflowId?: string;
1771
2065
  /**
2066
+ * @public
1772
2067
  * <p>The name of the step.</p>
1773
2068
  */
1774
2069
  name?: string;
@@ -1778,22 +2073,27 @@ export interface UpdateWorkflowStepResponse {
1778
2073
  */
1779
2074
  export interface CreateWorkflowStepGroupRequest {
1780
2075
  /**
2076
+ * @public
1781
2077
  * <p>The ID of the migration workflow that will contain the step group.</p>
1782
2078
  */
1783
2079
  workflowId: string | undefined;
1784
2080
  /**
2081
+ * @public
1785
2082
  * <p>The name of the step group.</p>
1786
2083
  */
1787
2084
  name: string | undefined;
1788
2085
  /**
2086
+ * @public
1789
2087
  * <p>The description of the step group.</p>
1790
2088
  */
1791
2089
  description?: string;
1792
2090
  /**
2091
+ * @public
1793
2092
  * <p>The next step group.</p>
1794
2093
  */
1795
2094
  next?: string[];
1796
2095
  /**
2096
+ * @public
1797
2097
  * <p>The previous step group.</p>
1798
2098
  */
1799
2099
  previous?: string[];
@@ -1803,34 +2103,42 @@ export interface CreateWorkflowStepGroupRequest {
1803
2103
  */
1804
2104
  export interface CreateWorkflowStepGroupResponse {
1805
2105
  /**
2106
+ * @public
1806
2107
  * <p>The ID of the migration workflow that contains the step group.</p>
1807
2108
  */
1808
2109
  workflowId?: string;
1809
2110
  /**
2111
+ * @public
1810
2112
  * <p>The name of the step group.</p>
1811
2113
  */
1812
2114
  name?: string;
1813
2115
  /**
2116
+ * @public
1814
2117
  * <p>The ID of the step group.</p>
1815
2118
  */
1816
2119
  id?: string;
1817
2120
  /**
2121
+ * @public
1818
2122
  * <p>The description of the step group.</p>
1819
2123
  */
1820
2124
  description?: string;
1821
2125
  /**
2126
+ * @public
1822
2127
  * <p>List of AWS services utilized in a migration workflow.</p>
1823
2128
  */
1824
2129
  tools?: Tool[];
1825
2130
  /**
2131
+ * @public
1826
2132
  * <p>The next step group.</p>
1827
2133
  */
1828
2134
  next?: string[];
1829
2135
  /**
2136
+ * @public
1830
2137
  * <p>The previous step group.</p>
1831
2138
  */
1832
2139
  previous?: string[];
1833
2140
  /**
2141
+ * @public
1834
2142
  * <p>The time at which the step group is created.</p>
1835
2143
  */
1836
2144
  creationTime?: Date;
@@ -1840,10 +2148,12 @@ export interface CreateWorkflowStepGroupResponse {
1840
2148
  */
1841
2149
  export interface DeleteWorkflowStepGroupRequest {
1842
2150
  /**
2151
+ * @public
1843
2152
  * <p>The ID of the migration workflow.</p>
1844
2153
  */
1845
2154
  workflowId: string | undefined;
1846
2155
  /**
2156
+ * @public
1847
2157
  * <p>The ID of the step group you want to delete.</p>
1848
2158
  */
1849
2159
  id: string | undefined;
@@ -1858,10 +2168,12 @@ export interface DeleteWorkflowStepGroupResponse {
1858
2168
  */
1859
2169
  export interface GetWorkflowStepGroupRequest {
1860
2170
  /**
2171
+ * @public
1861
2172
  * <p>The ID of the step group.</p>
1862
2173
  */
1863
2174
  id: string | undefined;
1864
2175
  /**
2176
+ * @public
1865
2177
  * <p>The ID of the migration workflow.</p>
1866
2178
  */
1867
2179
  workflowId: string | undefined;
@@ -1871,50 +2183,62 @@ export interface GetWorkflowStepGroupRequest {
1871
2183
  */
1872
2184
  export interface GetWorkflowStepGroupResponse {
1873
2185
  /**
2186
+ * @public
1874
2187
  * <p>The ID of the step group.</p>
1875
2188
  */
1876
2189
  id?: string;
1877
2190
  /**
2191
+ * @public
1878
2192
  * <p>The ID of the migration workflow.</p>
1879
2193
  */
1880
2194
  workflowId?: string;
1881
2195
  /**
2196
+ * @public
1882
2197
  * <p>The name of the step group.</p>
1883
2198
  */
1884
2199
  name?: string;
1885
2200
  /**
2201
+ * @public
1886
2202
  * <p>The description of the step group.</p>
1887
2203
  */
1888
2204
  description?: string;
1889
2205
  /**
2206
+ * @public
1890
2207
  * <p>The status of the step group.</p>
1891
2208
  */
1892
2209
  status?: StepGroupStatus | string;
1893
2210
  /**
2211
+ * @public
1894
2212
  * <p>The owner of the step group.</p>
1895
2213
  */
1896
2214
  owner?: Owner | string;
1897
2215
  /**
2216
+ * @public
1898
2217
  * <p>The time at which the step group was created.</p>
1899
2218
  */
1900
2219
  creationTime?: Date;
1901
2220
  /**
2221
+ * @public
1902
2222
  * <p>The time at which the step group was last modified.</p>
1903
2223
  */
1904
2224
  lastModifiedTime?: Date;
1905
2225
  /**
2226
+ * @public
1906
2227
  * <p>The time at which the step group ended.</p>
1907
2228
  */
1908
2229
  endTime?: Date;
1909
2230
  /**
2231
+ * @public
1910
2232
  * <p>List of AWS services utilized in a migration workflow.</p>
1911
2233
  */
1912
2234
  tools?: Tool[];
1913
2235
  /**
2236
+ * @public
1914
2237
  * <p>The previous step group.</p>
1915
2238
  */
1916
2239
  previous?: string[];
1917
2240
  /**
2241
+ * @public
1918
2242
  * <p>The next step group.</p>
1919
2243
  */
1920
2244
  next?: string[];
@@ -1924,14 +2248,17 @@ export interface GetWorkflowStepGroupResponse {
1924
2248
  */
1925
2249
  export interface ListWorkflowStepGroupsRequest {
1926
2250
  /**
2251
+ * @public
1927
2252
  * <p>The pagination token.</p>
1928
2253
  */
1929
2254
  nextToken?: string;
1930
2255
  /**
2256
+ * @public
1931
2257
  * <p>The maximum number of results that can be returned.</p>
1932
2258
  */
1933
2259
  maxResults?: number;
1934
2260
  /**
2261
+ * @public
1935
2262
  * <p>The ID of the migration workflow.</p>
1936
2263
  */
1937
2264
  workflowId: string | undefined;
@@ -1942,26 +2269,32 @@ export interface ListWorkflowStepGroupsRequest {
1942
2269
  */
1943
2270
  export interface WorkflowStepGroupSummary {
1944
2271
  /**
2272
+ * @public
1945
2273
  * <p>The ID of the step group.</p>
1946
2274
  */
1947
2275
  id?: string;
1948
2276
  /**
2277
+ * @public
1949
2278
  * <p>The name of the step group.</p>
1950
2279
  */
1951
2280
  name?: string;
1952
2281
  /**
2282
+ * @public
1953
2283
  * <p>The owner of the step group.</p>
1954
2284
  */
1955
2285
  owner?: Owner | string;
1956
2286
  /**
2287
+ * @public
1957
2288
  * <p>The status of the step group.</p>
1958
2289
  */
1959
2290
  status?: StepGroupStatus | string;
1960
2291
  /**
2292
+ * @public
1961
2293
  * <p>The previous step group.</p>
1962
2294
  */
1963
2295
  previous?: string[];
1964
2296
  /**
2297
+ * @public
1965
2298
  * <p>The next step group.</p>
1966
2299
  */
1967
2300
  next?: string[];
@@ -1971,10 +2304,12 @@ export interface WorkflowStepGroupSummary {
1971
2304
  */
1972
2305
  export interface ListWorkflowStepGroupsResponse {
1973
2306
  /**
2307
+ * @public
1974
2308
  * <p>The pagination token.</p>
1975
2309
  */
1976
2310
  nextToken?: string;
1977
2311
  /**
2312
+ * @public
1978
2313
  * <p>The summary of step groups in a migration workflow.</p>
1979
2314
  */
1980
2315
  workflowStepGroupsSummary: WorkflowStepGroupSummary[] | undefined;
@@ -1984,26 +2319,32 @@ export interface ListWorkflowStepGroupsResponse {
1984
2319
  */
1985
2320
  export interface UpdateWorkflowStepGroupRequest {
1986
2321
  /**
2322
+ * @public
1987
2323
  * <p>The ID of the migration workflow.</p>
1988
2324
  */
1989
2325
  workflowId: string | undefined;
1990
2326
  /**
2327
+ * @public
1991
2328
  * <p>The ID of the step group.</p>
1992
2329
  */
1993
2330
  id: string | undefined;
1994
2331
  /**
2332
+ * @public
1995
2333
  * <p>The name of the step group.</p>
1996
2334
  */
1997
2335
  name?: string;
1998
2336
  /**
2337
+ * @public
1999
2338
  * <p>The description of the step group.</p>
2000
2339
  */
2001
2340
  description?: string;
2002
2341
  /**
2342
+ * @public
2003
2343
  * <p>The next step group.</p>
2004
2344
  */
2005
2345
  next?: string[];
2006
2346
  /**
2347
+ * @public
2007
2348
  * <p>The previous step group.</p>
2008
2349
  */
2009
2350
  previous?: string[];
@@ -2013,34 +2354,42 @@ export interface UpdateWorkflowStepGroupRequest {
2013
2354
  */
2014
2355
  export interface UpdateWorkflowStepGroupResponse {
2015
2356
  /**
2357
+ * @public
2016
2358
  * <p>The ID of the migration workflow.</p>
2017
2359
  */
2018
2360
  workflowId?: string;
2019
2361
  /**
2362
+ * @public
2020
2363
  * <p>The name of the step group.</p>
2021
2364
  */
2022
2365
  name?: string;
2023
2366
  /**
2367
+ * @public
2024
2368
  * <p>The ID of the step group.</p>
2025
2369
  */
2026
2370
  id?: string;
2027
2371
  /**
2372
+ * @public
2028
2373
  * <p>The description of the step group.</p>
2029
2374
  */
2030
2375
  description?: string;
2031
2376
  /**
2377
+ * @public
2032
2378
  * <p>List of AWS services utilized in a migration workflow.</p>
2033
2379
  */
2034
2380
  tools?: Tool[];
2035
2381
  /**
2382
+ * @public
2036
2383
  * <p>The next step group.</p>
2037
2384
  */
2038
2385
  next?: string[];
2039
2386
  /**
2387
+ * @public
2040
2388
  * <p>The previous step group.</p>
2041
2389
  */
2042
2390
  previous?: string[];
2043
2391
  /**
2392
+ * @public
2044
2393
  * <p>The time at which the step group was last modified.</p>
2045
2394
  */
2046
2395
  lastModifiedTime?: Date;