@aws-sdk/client-tnb 3.379.1 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -18,6 +18,7 @@ export declare class AccessDeniedException extends __BaseException {
18
18
  */
19
19
  export interface CancelSolNetworkOperationInput {
20
20
  /**
21
+ * @public
21
22
  * <p>The identifier of the network operation.</p>
22
23
  */
23
24
  nsLcmOpOccId: string | undefined;
@@ -75,6 +76,7 @@ export declare class ValidationException extends __BaseException {
75
76
  */
76
77
  export interface CreateSolFunctionPackageInput {
77
78
  /**
79
+ * @public
78
80
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
79
81
  */
80
82
  tags?: Record<string, string>;
@@ -121,26 +123,32 @@ export type UsageState = (typeof UsageState)[keyof typeof UsageState];
121
123
  */
122
124
  export interface CreateSolFunctionPackageOutput {
123
125
  /**
126
+ * @public
124
127
  * <p>ID of the function package.</p>
125
128
  */
126
129
  id: string | undefined;
127
130
  /**
131
+ * @public
128
132
  * <p>Function package ARN.</p>
129
133
  */
130
134
  arn: string | undefined;
131
135
  /**
136
+ * @public
132
137
  * <p>Onboarding state of the function package.</p>
133
138
  */
134
139
  onboardingState: OnboardingState | string | undefined;
135
140
  /**
141
+ * @public
136
142
  * <p>Operational state of the function package.</p>
137
143
  */
138
144
  operationalState: OperationalState | string | undefined;
139
145
  /**
146
+ * @public
140
147
  * <p>Usage state of the function package.</p>
141
148
  */
142
149
  usageState: UsageState | string | undefined;
143
150
  /**
151
+ * @public
144
152
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
145
153
  */
146
154
  tags?: Record<string, string>;
@@ -162,18 +170,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
162
170
  */
163
171
  export interface CreateSolNetworkInstanceInput {
164
172
  /**
173
+ * @public
165
174
  * <p>ID for network service descriptor.</p>
166
175
  */
167
176
  nsdInfoId: string | undefined;
168
177
  /**
178
+ * @public
169
179
  * <p>Network instance name.</p>
170
180
  */
171
181
  nsName: string | undefined;
172
182
  /**
183
+ * @public
173
184
  * <p>Network instance description.</p>
174
185
  */
175
186
  nsDescription?: string;
176
187
  /**
188
+ * @public
177
189
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
178
190
  */
179
191
  tags?: Record<string, string>;
@@ -183,22 +195,27 @@ export interface CreateSolNetworkInstanceInput {
183
195
  */
184
196
  export interface CreateSolNetworkInstanceOutput {
185
197
  /**
198
+ * @public
186
199
  * <p>Network instance ID.</p>
187
200
  */
188
201
  id: string | undefined;
189
202
  /**
203
+ * @public
190
204
  * <p>Network instance ARN.</p>
191
205
  */
192
206
  arn: string | undefined;
193
207
  /**
208
+ * @public
194
209
  * <p>Network service descriptor ID.</p>
195
210
  */
196
211
  nsdInfoId: string | undefined;
197
212
  /**
213
+ * @public
198
214
  * <p>Network instance name.</p>
199
215
  */
200
216
  nsInstanceName: string | undefined;
201
217
  /**
218
+ * @public
202
219
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
203
220
  */
204
221
  tags?: Record<string, string>;
@@ -208,6 +225,7 @@ export interface CreateSolNetworkInstanceOutput {
208
225
  */
209
226
  export interface CreateSolNetworkPackageInput {
210
227
  /**
228
+ * @public
211
229
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
212
230
  */
213
231
  tags?: Record<string, string>;
@@ -254,26 +272,32 @@ export type NsdUsageState = (typeof NsdUsageState)[keyof typeof NsdUsageState];
254
272
  */
255
273
  export interface CreateSolNetworkPackageOutput {
256
274
  /**
275
+ * @public
257
276
  * <p>ID of the network package.</p>
258
277
  */
259
278
  id: string | undefined;
260
279
  /**
280
+ * @public
261
281
  * <p>Network package ARN.</p>
262
282
  */
263
283
  arn: string | undefined;
264
284
  /**
285
+ * @public
265
286
  * <p>Onboarding state of the network service descriptor in the network package.</p>
266
287
  */
267
288
  nsdOnboardingState: NsdOnboardingState | string | undefined;
268
289
  /**
290
+ * @public
269
291
  * <p>Operational state of the network service descriptor in the network package.</p>
270
292
  */
271
293
  nsdOperationalState: NsdOperationalState | string | undefined;
272
294
  /**
295
+ * @public
273
296
  * <p>Usage state of the network service descriptor in the network package.</p>
274
297
  */
275
298
  nsdUsageState: NsdUsageState | string | undefined;
276
299
  /**
300
+ * @public
277
301
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
278
302
  */
279
303
  tags?: Record<string, string>;
@@ -283,6 +307,7 @@ export interface CreateSolNetworkPackageOutput {
283
307
  */
284
308
  export interface DeleteSolFunctionPackageInput {
285
309
  /**
310
+ * @public
286
311
  * <p>ID of the function package.</p>
287
312
  */
288
313
  vnfPkgId: string | undefined;
@@ -292,6 +317,7 @@ export interface DeleteSolFunctionPackageInput {
292
317
  */
293
318
  export interface DeleteSolNetworkInstanceInput {
294
319
  /**
320
+ * @public
295
321
  * <p>Network instance ID.</p>
296
322
  */
297
323
  nsInstanceId: string | undefined;
@@ -301,6 +327,7 @@ export interface DeleteSolNetworkInstanceInput {
301
327
  */
302
328
  export interface DeleteSolNetworkPackageInput {
303
329
  /**
330
+ * @public
304
331
  * <p>ID of the network service descriptor in the network package.</p>
305
332
  */
306
333
  nsdInfoId: string | undefined;
@@ -322,10 +349,12 @@ export type DescriptorContentType = (typeof DescriptorContentType)[keyof typeof
322
349
  */
323
350
  export interface ErrorInfo {
324
351
  /**
352
+ * @public
325
353
  * <p>Error cause.</p>
326
354
  */
327
355
  cause?: string;
328
356
  /**
357
+ * @public
329
358
  * <p>Error details.</p>
330
359
  */
331
360
  details?: string;
@@ -336,10 +365,12 @@ export interface ErrorInfo {
336
365
  */
337
366
  export interface ToscaOverride {
338
367
  /**
368
+ * @public
339
369
  * <p>Name of the TOSCA override.</p>
340
370
  */
341
371
  name?: string;
342
372
  /**
373
+ * @public
343
374
  * <p>Default value for the override.</p>
344
375
  */
345
376
  defaultValue?: string;
@@ -351,6 +382,7 @@ export interface ToscaOverride {
351
382
  */
352
383
  export interface FunctionArtifactMeta {
353
384
  /**
385
+ * @public
354
386
  * <p>Lists of function package overrides.</p>
355
387
  */
356
388
  overrides?: ToscaOverride[];
@@ -360,6 +392,7 @@ export interface FunctionArtifactMeta {
360
392
  */
361
393
  export interface GetSolFunctionInstanceInput {
362
394
  /**
395
+ * @public
363
396
  * <p>ID of the network function.</p>
364
397
  */
365
398
  vnfInstanceId: string | undefined;
@@ -371,14 +404,17 @@ export interface GetSolFunctionInstanceInput {
371
404
  */
372
405
  export interface GetSolVnfcResourceInfoMetadata {
373
406
  /**
407
+ * @public
374
408
  * <p>Information about the node group.</p>
375
409
  */
376
410
  nodeGroup?: string;
377
411
  /**
412
+ * @public
378
413
  * <p>Information about the cluster.</p>
379
414
  */
380
415
  cluster?: string;
381
416
  /**
417
+ * @public
382
418
  * <p>Information about the helm chart.</p>
383
419
  */
384
420
  helmChart?: string;
@@ -390,6 +426,7 @@ export interface GetSolVnfcResourceInfoMetadata {
390
426
  */
391
427
  export interface GetSolVnfcResourceInfo {
392
428
  /**
429
+ * @public
393
430
  * <p>The metadata of the network function compute.</p>
394
431
  */
395
432
  metadata?: GetSolVnfcResourceInfoMetadata;
@@ -413,10 +450,12 @@ export type VnfOperationalState = (typeof VnfOperationalState)[keyof typeof VnfO
413
450
  */
414
451
  export interface GetSolVnfInfo {
415
452
  /**
453
+ * @public
416
454
  * <p>State of the network function instance.</p>
417
455
  */
418
456
  vnfState?: VnfOperationalState | string;
419
457
  /**
458
+ * @public
420
459
  * <p>Compute info used by the network function instance.</p>
421
460
  */
422
461
  vnfcResourceInfo?: GetSolVnfcResourceInfo[];
@@ -440,10 +479,12 @@ export type VnfInstantiationState = (typeof VnfInstantiationState)[keyof typeof
440
479
  */
441
480
  export interface GetSolFunctionInstanceMetadata {
442
481
  /**
482
+ * @public
443
483
  * <p>The date that the resource was created.</p>
444
484
  */
445
485
  createdAt: Date | undefined;
446
486
  /**
487
+ * @public
447
488
  * <p>The date that the resource was last modified.</p>
448
489
  */
449
490
  lastModified: Date | undefined;
@@ -453,52 +494,64 @@ export interface GetSolFunctionInstanceMetadata {
453
494
  */
454
495
  export interface GetSolFunctionInstanceOutput {
455
496
  /**
497
+ * @public
456
498
  * <p>Network function instance ID.</p>
457
499
  */
458
500
  id: string | undefined;
459
501
  /**
502
+ * @public
460
503
  * <p>Network function instance ARN.</p>
461
504
  */
462
505
  arn: string | undefined;
463
506
  /**
507
+ * @public
464
508
  * <p>Network instance ID.</p>
465
509
  */
466
510
  nsInstanceId: string | undefined;
467
511
  /**
512
+ * @public
468
513
  * <p>Function package ID.</p>
469
514
  */
470
515
  vnfPkgId: string | undefined;
471
516
  /**
517
+ * @public
472
518
  * <p>Function package descriptor ID.</p>
473
519
  */
474
520
  vnfdId: string | undefined;
475
521
  /**
522
+ * @public
476
523
  * <p>Network function provider.</p>
477
524
  */
478
525
  vnfProvider?: string;
479
526
  /**
527
+ * @public
480
528
  * <p>Network function product name.</p>
481
529
  */
482
530
  vnfProductName?: string;
483
531
  /**
532
+ * @public
484
533
  * <p>Function package descriptor version.</p>
485
534
  */
486
535
  vnfdVersion?: string;
487
536
  /**
537
+ * @public
488
538
  * <p>Network function instantiation state.</p>
489
539
  */
490
540
  instantiationState: VnfInstantiationState | string | undefined;
491
541
  /**
542
+ * @public
492
543
  * <p>Information about the network function.</p>
493
544
  * <p>A network function instance is a function in a function package .</p>
494
545
  */
495
546
  instantiatedVnfInfo?: GetSolVnfInfo;
496
547
  /**
548
+ * @public
497
549
  * <p>The metadata of a network function instance.</p>
498
550
  * <p>A network function instance is a function in a function package .</p>
499
551
  */
500
552
  metadata: GetSolFunctionInstanceMetadata | undefined;
501
553
  /**
554
+ * @public
502
555
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
503
556
  */
504
557
  tags?: Record<string, string>;
@@ -508,6 +561,7 @@ export interface GetSolFunctionInstanceOutput {
508
561
  */
509
562
  export interface GetSolFunctionPackageInput {
510
563
  /**
564
+ * @public
511
565
  * <p>ID of the function package.</p>
512
566
  */
513
567
  vnfPkgId: string | undefined;
@@ -519,14 +573,17 @@ export interface GetSolFunctionPackageInput {
519
573
  */
520
574
  export interface GetSolFunctionPackageMetadata {
521
575
  /**
576
+ * @public
522
577
  * <p>Metadata related to the function package descriptor of the function package.</p>
523
578
  */
524
579
  vnfd?: FunctionArtifactMeta;
525
580
  /**
581
+ * @public
526
582
  * <p>The date that the resource was created.</p>
527
583
  */
528
584
  createdAt: Date | undefined;
529
585
  /**
586
+ * @public
530
587
  * <p>The date that the resource was last modified.</p>
531
588
  */
532
589
  lastModified: Date | undefined;
@@ -536,47 +593,58 @@ export interface GetSolFunctionPackageMetadata {
536
593
  */
537
594
  export interface GetSolFunctionPackageOutput {
538
595
  /**
596
+ * @public
539
597
  * <p>Function package ID.</p>
540
598
  */
541
599
  id: string | undefined;
542
600
  /**
601
+ * @public
543
602
  * <p>Function package ARN.</p>
544
603
  */
545
604
  arn: string | undefined;
546
605
  /**
606
+ * @public
547
607
  * <p>Function package onboarding state.</p>
548
608
  */
549
609
  onboardingState: OnboardingState | string | undefined;
550
610
  /**
611
+ * @public
551
612
  * <p>Function package operational state.</p>
552
613
  */
553
614
  operationalState: OperationalState | string | undefined;
554
615
  /**
616
+ * @public
555
617
  * <p>Function package usage state.</p>
556
618
  */
557
619
  usageState: UsageState | string | undefined;
558
620
  /**
621
+ * @public
559
622
  * <p>Function package descriptor ID.</p>
560
623
  */
561
624
  vnfdId?: string;
562
625
  /**
626
+ * @public
563
627
  * <p>Network function provider.</p>
564
628
  */
565
629
  vnfProvider?: string;
566
630
  /**
631
+ * @public
567
632
  * <p>Network function product name.</p>
568
633
  */
569
634
  vnfProductName?: string;
570
635
  /**
636
+ * @public
571
637
  * <p>Function package descriptor version.</p>
572
638
  */
573
639
  vnfdVersion?: string;
574
640
  /**
641
+ * @public
575
642
  * <p>Metadata related to the function package.</p>
576
643
  * <p>A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p>
577
644
  */
578
645
  metadata?: GetSolFunctionPackageMetadata;
579
646
  /**
647
+ * @public
580
648
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
581
649
  */
582
650
  tags?: Record<string, string>;
@@ -597,10 +665,12 @@ export type PackageContentType = (typeof PackageContentType)[keyof typeof Packag
597
665
  */
598
666
  export interface GetSolFunctionPackageContentInput {
599
667
  /**
668
+ * @public
600
669
  * <p>ID of the function package.</p>
601
670
  */
602
671
  vnfPkgId: string | undefined;
603
672
  /**
673
+ * @public
604
674
  * <p>The format of the package that you want to download from the function packages.</p>
605
675
  */
606
676
  accept: PackageContentType | string | undefined;
@@ -610,10 +680,12 @@ export interface GetSolFunctionPackageContentInput {
610
680
  */
611
681
  export interface GetSolFunctionPackageContentOutput {
612
682
  /**
683
+ * @public
613
684
  * <p>Indicates the media type of the resource.</p>
614
685
  */
615
686
  contentType?: PackageContentType | string;
616
687
  /**
688
+ * @public
617
689
  * <p>Contents of the function package.</p>
618
690
  */
619
691
  packageContent?: Uint8Array;
@@ -623,10 +695,12 @@ export interface GetSolFunctionPackageContentOutput {
623
695
  */
624
696
  export interface GetSolFunctionPackageDescriptorInput {
625
697
  /**
698
+ * @public
626
699
  * <p>ID of the function package.</p>
627
700
  */
628
701
  vnfPkgId: string | undefined;
629
702
  /**
703
+ * @public
630
704
  * <p>Indicates which content types, expressed as MIME types, the client is able to understand.</p>
631
705
  */
632
706
  accept: DescriptorContentType | string | undefined;
@@ -636,10 +710,12 @@ export interface GetSolFunctionPackageDescriptorInput {
636
710
  */
637
711
  export interface GetSolFunctionPackageDescriptorOutput {
638
712
  /**
713
+ * @public
639
714
  * <p>Indicates the media type of the resource.</p>
640
715
  */
641
716
  contentType?: DescriptorContentType | string;
642
717
  /**
718
+ * @public
643
719
  * <p>Contents of the function package descriptor.</p>
644
720
  */
645
721
  vnfd?: Uint8Array;
@@ -651,6 +727,7 @@ export interface GetSolFunctionPackageDescriptorOutput {
651
727
  */
652
728
  export interface GetSolInstantiatedVnfInfo {
653
729
  /**
730
+ * @public
654
731
  * <p>State of the network function.</p>
655
732
  */
656
733
  vnfState?: VnfOperationalState | string;
@@ -660,6 +737,7 @@ export interface GetSolInstantiatedVnfInfo {
660
737
  */
661
738
  export interface GetSolNetworkInstanceInput {
662
739
  /**
740
+ * @public
663
741
  * <p>ID of the network instance.</p>
664
742
  */
665
743
  nsInstanceId: string | undefined;
@@ -671,6 +749,7 @@ export interface GetSolNetworkInstanceInput {
671
749
  */
672
750
  export interface LcmOperationInfo {
673
751
  /**
752
+ * @public
674
753
  * <p>The identifier of the network operation.</p>
675
754
  */
676
755
  nsLcmOpOccId: string | undefined;
@@ -682,10 +761,12 @@ export interface LcmOperationInfo {
682
761
  */
683
762
  export interface GetSolNetworkInstanceMetadata {
684
763
  /**
764
+ * @public
685
765
  * <p>The date that the resource was created.</p>
686
766
  */
687
767
  createdAt: Date | undefined;
688
768
  /**
769
+ * @public
689
770
  * <p>The date that the resource was last modified.</p>
690
771
  */
691
772
  lastModified: Date | undefined;
@@ -713,44 +794,54 @@ export type NsState = (typeof NsState)[keyof typeof NsState];
713
794
  */
714
795
  export interface GetSolNetworkInstanceOutput {
715
796
  /**
797
+ * @public
716
798
  * <p>Network instance ID.</p>
717
799
  */
718
800
  id: string | undefined;
719
801
  /**
802
+ * @public
720
803
  * <p>Network instance ARN.</p>
721
804
  */
722
805
  arn: string | undefined;
723
806
  /**
807
+ * @public
724
808
  * <p>Network instance name.</p>
725
809
  */
726
810
  nsInstanceName: string | undefined;
727
811
  /**
812
+ * @public
728
813
  * <p>Network instance description.</p>
729
814
  */
730
815
  nsInstanceDescription: string | undefined;
731
816
  /**
817
+ * @public
732
818
  * <p>Network service descriptor ID.</p>
733
819
  */
734
820
  nsdId: string | undefined;
735
821
  /**
822
+ * @public
736
823
  * <p>Network service descriptor info ID.</p>
737
824
  */
738
825
  nsdInfoId: string | undefined;
739
826
  /**
827
+ * @public
740
828
  * <p>Network instance state.</p>
741
829
  */
742
830
  nsState?: NsState | string;
743
831
  /**
832
+ * @public
744
833
  * <p>Lifecycle management operation details on the network instance.</p>
745
834
  * <p>Lifecycle management operations are deploy, update, or delete operations.</p>
746
835
  */
747
836
  lcmOpInfo?: LcmOperationInfo;
748
837
  /**
838
+ * @public
749
839
  * <p>The metadata of a network instance.</p>
750
840
  * <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p>
751
841
  */
752
842
  metadata: GetSolNetworkInstanceMetadata | undefined;
753
843
  /**
844
+ * @public
754
845
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
755
846
  */
756
847
  tags?: Record<string, string>;
@@ -760,6 +851,7 @@ export interface GetSolNetworkInstanceOutput {
760
851
  */
761
852
  export interface GetSolNetworkOperationInput {
762
853
  /**
854
+ * @public
763
855
  * <p>The identifier of the network operation.</p>
764
856
  */
765
857
  nsLcmOpOccId: string | undefined;
@@ -770,10 +862,12 @@ export interface GetSolNetworkOperationInput {
770
862
  */
771
863
  export interface ProblemDetails {
772
864
  /**
865
+ * @public
773
866
  * <p>A human-readable explanation specific to this occurrence of the problem.</p>
774
867
  */
775
868
  detail: string | undefined;
776
869
  /**
870
+ * @public
777
871
  * <p>A human-readable title of the problem type.</p>
778
872
  */
779
873
  title?: string;
@@ -798,10 +892,12 @@ export type LcmOperationType = (typeof LcmOperationType)[keyof typeof LcmOperati
798
892
  */
799
893
  export interface GetSolNetworkOperationMetadata {
800
894
  /**
895
+ * @public
801
896
  * <p>The date that the resource was created.</p>
802
897
  */
803
898
  createdAt: Date | undefined;
804
899
  /**
900
+ * @public
805
901
  * <p>The date that the resource was last modified.</p>
806
902
  */
807
903
  lastModified: Date | undefined;
@@ -845,26 +941,32 @@ export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
845
941
  */
846
942
  export interface GetSolNetworkOperationTaskDetails {
847
943
  /**
944
+ * @public
848
945
  * <p>Task name.</p>
849
946
  */
850
947
  taskName?: string;
851
948
  /**
949
+ * @public
852
950
  * <p>Context for the network operation task.</p>
853
951
  */
854
952
  taskContext?: Record<string, string>;
855
953
  /**
954
+ * @public
856
955
  * <p>Task error details.</p>
857
956
  */
858
957
  taskErrorDetails?: ErrorInfo;
859
958
  /**
959
+ * @public
860
960
  * <p>Task status.</p>
861
961
  */
862
962
  taskStatus?: TaskStatus | string;
863
963
  /**
964
+ * @public
864
965
  * <p>Task start time.</p>
865
966
  */
866
967
  taskStartTime?: Date;
867
968
  /**
969
+ * @public
868
970
  * <p>Task end time.</p>
869
971
  */
870
972
  taskEndTime?: Date;
@@ -874,38 +976,47 @@ export interface GetSolNetworkOperationTaskDetails {
874
976
  */
875
977
  export interface GetSolNetworkOperationOutput {
876
978
  /**
979
+ * @public
877
980
  * <p>ID of this network operation occurrence.</p>
878
981
  */
879
982
  id?: string;
880
983
  /**
984
+ * @public
881
985
  * <p>Network operation ARN.</p>
882
986
  */
883
987
  arn: string | undefined;
884
988
  /**
989
+ * @public
885
990
  * <p>The state of the network operation.</p>
886
991
  */
887
992
  operationState?: NsLcmOperationState | string;
888
993
  /**
994
+ * @public
889
995
  * <p>ID of the network operation instance.</p>
890
996
  */
891
997
  nsInstanceId?: string;
892
998
  /**
999
+ * @public
893
1000
  * <p>Type of the operation represented by this occurrence.</p>
894
1001
  */
895
1002
  lcmOperationType?: LcmOperationType | string;
896
1003
  /**
1004
+ * @public
897
1005
  * <p>Error related to this specific network operation occurrence.</p>
898
1006
  */
899
1007
  error?: ProblemDetails;
900
1008
  /**
1009
+ * @public
901
1010
  * <p>Metadata of this network operation occurrence.</p>
902
1011
  */
903
1012
  metadata?: GetSolNetworkOperationMetadata;
904
1013
  /**
1014
+ * @public
905
1015
  * <p>All tasks associated with this operation occurrence.</p>
906
1016
  */
907
1017
  tasks?: GetSolNetworkOperationTaskDetails[];
908
1018
  /**
1019
+ * @public
909
1020
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
910
1021
  */
911
1022
  tags?: Record<string, string>;
@@ -915,6 +1026,7 @@ export interface GetSolNetworkOperationOutput {
915
1026
  */
916
1027
  export interface GetSolNetworkPackageInput {
917
1028
  /**
1029
+ * @public
918
1030
  * <p>ID of the network service descriptor in the network package.</p>
919
1031
  */
920
1032
  nsdInfoId: string | undefined;
@@ -926,6 +1038,7 @@ export interface GetSolNetworkPackageInput {
926
1038
  */
927
1039
  export interface NetworkArtifactMeta {
928
1040
  /**
1041
+ * @public
929
1042
  * <p>Lists network package overrides.</p>
930
1043
  */
931
1044
  overrides?: ToscaOverride[];
@@ -937,14 +1050,17 @@ export interface NetworkArtifactMeta {
937
1050
  */
938
1051
  export interface GetSolNetworkPackageMetadata {
939
1052
  /**
1053
+ * @public
940
1054
  * <p>Metadata related to the onboarded network service descriptor in the network package.</p>
941
1055
  */
942
1056
  nsd?: NetworkArtifactMeta;
943
1057
  /**
1058
+ * @public
944
1059
  * <p>The date that the resource was created.</p>
945
1060
  */
946
1061
  createdAt: Date | undefined;
947
1062
  /**
1063
+ * @public
948
1064
  * <p>The date that the resource was last modified.</p>
949
1065
  */
950
1066
  lastModified: Date | undefined;
@@ -954,47 +1070,58 @@ export interface GetSolNetworkPackageMetadata {
954
1070
  */
955
1071
  export interface GetSolNetworkPackageOutput {
956
1072
  /**
1073
+ * @public
957
1074
  * <p>Network package ID.</p>
958
1075
  */
959
1076
  id: string | undefined;
960
1077
  /**
1078
+ * @public
961
1079
  * <p>Network package ARN.</p>
962
1080
  */
963
1081
  arn: string | undefined;
964
1082
  /**
1083
+ * @public
965
1084
  * <p>Network service descriptor onboarding state.</p>
966
1085
  */
967
1086
  nsdOnboardingState: NsdOnboardingState | string | undefined;
968
1087
  /**
1088
+ * @public
969
1089
  * <p>Network service descriptor operational state.</p>
970
1090
  */
971
1091
  nsdOperationalState: NsdOperationalState | string | undefined;
972
1092
  /**
1093
+ * @public
973
1094
  * <p>Network service descriptor usage state.</p>
974
1095
  */
975
1096
  nsdUsageState: NsdUsageState | string | undefined;
976
1097
  /**
1098
+ * @public
977
1099
  * <p>Network service descriptor ID.</p>
978
1100
  */
979
1101
  nsdId: string | undefined;
980
1102
  /**
1103
+ * @public
981
1104
  * <p>Network service descriptor name.</p>
982
1105
  */
983
1106
  nsdName: string | undefined;
984
1107
  /**
1108
+ * @public
985
1109
  * <p>Network service descriptor version.</p>
986
1110
  */
987
1111
  nsdVersion: string | undefined;
988
1112
  /**
1113
+ * @public
989
1114
  * <p>Identifies the function package for the function package descriptor referenced by the onboarded network package.</p>
990
1115
  */
991
1116
  vnfPkgIds: string[] | undefined;
992
1117
  /**
1118
+ * @public
993
1119
  * <p>Metadata associated with a network package.</p>
994
1120
  * <p>A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.</p>
995
1121
  */
996
1122
  metadata: GetSolNetworkPackageMetadata | undefined;
997
1123
  /**
1124
+ * @public
998
1125
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
999
1126
  */
1000
1127
  tags?: Record<string, string>;
@@ -1004,10 +1131,12 @@ export interface GetSolNetworkPackageOutput {
1004
1131
  */
1005
1132
  export interface GetSolNetworkPackageContentInput {
1006
1133
  /**
1134
+ * @public
1007
1135
  * <p>ID of the network service descriptor in the network package.</p>
1008
1136
  */
1009
1137
  nsdInfoId: string | undefined;
1010
1138
  /**
1139
+ * @public
1011
1140
  * <p>The format of the package you want to download from the network package.</p>
1012
1141
  */
1013
1142
  accept: PackageContentType | string | undefined;
@@ -1017,10 +1146,12 @@ export interface GetSolNetworkPackageContentInput {
1017
1146
  */
1018
1147
  export interface GetSolNetworkPackageContentOutput {
1019
1148
  /**
1149
+ * @public
1020
1150
  * <p>Indicates the media type of the resource.</p>
1021
1151
  */
1022
1152
  contentType?: PackageContentType | string;
1023
1153
  /**
1154
+ * @public
1024
1155
  * <p>Content of the network service descriptor in the network package.</p>
1025
1156
  */
1026
1157
  nsdContent?: Uint8Array;
@@ -1030,6 +1161,7 @@ export interface GetSolNetworkPackageContentOutput {
1030
1161
  */
1031
1162
  export interface GetSolNetworkPackageDescriptorInput {
1032
1163
  /**
1164
+ * @public
1033
1165
  * <p>ID of the network service descriptor in the network package.</p>
1034
1166
  */
1035
1167
  nsdInfoId: string | undefined;
@@ -1039,10 +1171,12 @@ export interface GetSolNetworkPackageDescriptorInput {
1039
1171
  */
1040
1172
  export interface GetSolNetworkPackageDescriptorOutput {
1041
1173
  /**
1174
+ * @public
1042
1175
  * <p>Indicates the media type of the resource.</p>
1043
1176
  */
1044
1177
  contentType?: DescriptorContentType | string;
1045
1178
  /**
1179
+ * @public
1046
1180
  * <p>Contents of the network service descriptor in the network package.</p>
1047
1181
  */
1048
1182
  nsd?: Uint8Array;
@@ -1052,20 +1186,24 @@ export interface GetSolNetworkPackageDescriptorOutput {
1052
1186
  */
1053
1187
  export interface InstantiateSolNetworkInstanceInput {
1054
1188
  /**
1189
+ * @public
1055
1190
  * <p>ID of the network instance.</p>
1056
1191
  */
1057
1192
  nsInstanceId: string | undefined;
1058
1193
  /**
1194
+ * @public
1059
1195
  * <p>A check for whether you have the required permissions for the action without actually making the request
1060
1196
  * and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>.
1061
1197
  * Otherwise, it is <code>UnauthorizedOperation</code>.</p>
1062
1198
  */
1063
1199
  dryRun?: boolean;
1064
1200
  /**
1201
+ * @public
1065
1202
  * <p>Provides values for the configurable properties.</p>
1066
1203
  */
1067
1204
  additionalParamsForNs?: __DocumentType;
1068
1205
  /**
1206
+ * @public
1069
1207
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1070
1208
  */
1071
1209
  tags?: Record<string, string>;
@@ -1075,10 +1213,12 @@ export interface InstantiateSolNetworkInstanceInput {
1075
1213
  */
1076
1214
  export interface InstantiateSolNetworkInstanceOutput {
1077
1215
  /**
1216
+ * @public
1078
1217
  * <p>The identifier of the network operation.</p>
1079
1218
  */
1080
1219
  nsLcmOpOccId: string | undefined;
1081
1220
  /**
1221
+ * @public
1082
1222
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1083
1223
  */
1084
1224
  tags?: Record<string, string>;
@@ -1090,10 +1230,12 @@ export interface InstantiateSolNetworkInstanceOutput {
1090
1230
  */
1091
1231
  export interface ListSolFunctionInstanceMetadata {
1092
1232
  /**
1233
+ * @public
1093
1234
  * <p>When the network function instance was created.</p>
1094
1235
  */
1095
1236
  createdAt: Date | undefined;
1096
1237
  /**
1238
+ * @public
1097
1239
  * <p>When the network function instance was last modified.</p>
1098
1240
  */
1099
1241
  lastModified: Date | undefined;
@@ -1105,35 +1247,43 @@ export interface ListSolFunctionInstanceMetadata {
1105
1247
  */
1106
1248
  export interface ListSolFunctionInstanceInfo {
1107
1249
  /**
1250
+ * @public
1108
1251
  * <p>Network function instance ID.</p>
1109
1252
  */
1110
1253
  id: string | undefined;
1111
1254
  /**
1255
+ * @public
1112
1256
  * <p>Network function instance ARN.</p>
1113
1257
  */
1114
1258
  arn: string | undefined;
1115
1259
  /**
1260
+ * @public
1116
1261
  * <p>Network instance ID.</p>
1117
1262
  */
1118
1263
  nsInstanceId: string | undefined;
1119
1264
  /**
1265
+ * @public
1120
1266
  * <p>Function package ID.</p>
1121
1267
  */
1122
1268
  vnfPkgId: string | undefined;
1123
1269
  /**
1270
+ * @public
1124
1271
  * <p>Function package name.</p>
1125
1272
  */
1126
1273
  vnfPkgName?: string;
1127
1274
  /**
1275
+ * @public
1128
1276
  * <p>Network function instance instantiation state.</p>
1129
1277
  */
1130
1278
  instantiationState: VnfInstantiationState | string | undefined;
1131
1279
  /**
1280
+ * @public
1132
1281
  * <p>Information about a network function.</p>
1133
1282
  * <p>A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.</p>
1134
1283
  */
1135
1284
  instantiatedVnfInfo?: GetSolInstantiatedVnfInfo;
1136
1285
  /**
1286
+ * @public
1137
1287
  * <p>Network function instance metadata.</p>
1138
1288
  */
1139
1289
  metadata: ListSolFunctionInstanceMetadata | undefined;
@@ -1143,10 +1293,12 @@ export interface ListSolFunctionInstanceInfo {
1143
1293
  */
1144
1294
  export interface ListSolFunctionInstancesInput {
1145
1295
  /**
1296
+ * @public
1146
1297
  * <p>The maximum number of results to include in the response.</p>
1147
1298
  */
1148
1299
  maxResults?: number;
1149
1300
  /**
1301
+ * @public
1150
1302
  * <p>The token for the next page of results.</p>
1151
1303
  */
1152
1304
  nextToken?: string;
@@ -1156,10 +1308,12 @@ export interface ListSolFunctionInstancesInput {
1156
1308
  */
1157
1309
  export interface ListSolFunctionInstancesOutput {
1158
1310
  /**
1311
+ * @public
1159
1312
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1160
1313
  */
1161
1314
  nextToken?: string;
1162
1315
  /**
1316
+ * @public
1163
1317
  * <p>Network function instances.</p>
1164
1318
  */
1165
1319
  functionInstances?: ListSolFunctionInstanceInfo[];
@@ -1171,10 +1325,12 @@ export interface ListSolFunctionInstancesOutput {
1171
1325
  */
1172
1326
  export interface ListSolFunctionPackageMetadata {
1173
1327
  /**
1328
+ * @public
1174
1329
  * <p>The date that the resource was created.</p>
1175
1330
  */
1176
1331
  createdAt: Date | undefined;
1177
1332
  /**
1333
+ * @public
1178
1334
  * <p>The date that the resource was last modified.</p>
1179
1335
  */
1180
1336
  lastModified: Date | undefined;
@@ -1186,42 +1342,52 @@ export interface ListSolFunctionPackageMetadata {
1186
1342
  */
1187
1343
  export interface ListSolFunctionPackageInfo {
1188
1344
  /**
1345
+ * @public
1189
1346
  * <p>ID of the function package.</p>
1190
1347
  */
1191
1348
  id: string | undefined;
1192
1349
  /**
1350
+ * @public
1193
1351
  * <p>Function package ARN.</p>
1194
1352
  */
1195
1353
  arn: string | undefined;
1196
1354
  /**
1355
+ * @public
1197
1356
  * <p>Onboarding state of the function package.</p>
1198
1357
  */
1199
1358
  onboardingState: OnboardingState | string | undefined;
1200
1359
  /**
1360
+ * @public
1201
1361
  * <p>Operational state of the function package.</p>
1202
1362
  */
1203
1363
  operationalState: OperationalState | string | undefined;
1204
1364
  /**
1365
+ * @public
1205
1366
  * <p>Usage state of the function package.</p>
1206
1367
  */
1207
1368
  usageState: UsageState | string | undefined;
1208
1369
  /**
1370
+ * @public
1209
1371
  * <p>Identifies the function package and the function package descriptor.</p>
1210
1372
  */
1211
1373
  vnfdId?: string;
1212
1374
  /**
1375
+ * @public
1213
1376
  * <p>Provider of the function package and the function package descriptor.</p>
1214
1377
  */
1215
1378
  vnfProvider?: string;
1216
1379
  /**
1380
+ * @public
1217
1381
  * <p>The product name for the network function.</p>
1218
1382
  */
1219
1383
  vnfProductName?: string;
1220
1384
  /**
1385
+ * @public
1221
1386
  * <p>Identifies the version of the function package descriptor.</p>
1222
1387
  */
1223
1388
  vnfdVersion?: string;
1224
1389
  /**
1390
+ * @public
1225
1391
  * <p>The metadata of the function package.</p>
1226
1392
  */
1227
1393
  metadata?: ListSolFunctionPackageMetadata;
@@ -1231,10 +1397,12 @@ export interface ListSolFunctionPackageInfo {
1231
1397
  */
1232
1398
  export interface ListSolFunctionPackagesInput {
1233
1399
  /**
1400
+ * @public
1234
1401
  * <p>The maximum number of results to include in the response.</p>
1235
1402
  */
1236
1403
  maxResults?: number;
1237
1404
  /**
1405
+ * @public
1238
1406
  * <p>The token for the next page of results.</p>
1239
1407
  */
1240
1408
  nextToken?: string;
@@ -1244,10 +1412,12 @@ export interface ListSolFunctionPackagesInput {
1244
1412
  */
1245
1413
  export interface ListSolFunctionPackagesOutput {
1246
1414
  /**
1415
+ * @public
1247
1416
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1248
1417
  */
1249
1418
  nextToken?: string;
1250
1419
  /**
1420
+ * @public
1251
1421
  * <p>Function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.</p>
1252
1422
  */
1253
1423
  functionPackages: ListSolFunctionPackageInfo[] | undefined;
@@ -1259,10 +1429,12 @@ export interface ListSolFunctionPackagesOutput {
1259
1429
  */
1260
1430
  export interface ListSolNetworkInstanceMetadata {
1261
1431
  /**
1432
+ * @public
1262
1433
  * <p>The date that the resource was created.</p>
1263
1434
  */
1264
1435
  createdAt: Date | undefined;
1265
1436
  /**
1437
+ * @public
1266
1438
  * <p>The date that the resource was last modified.</p>
1267
1439
  */
1268
1440
  lastModified: Date | undefined;
@@ -1274,34 +1446,42 @@ export interface ListSolNetworkInstanceMetadata {
1274
1446
  */
1275
1447
  export interface ListSolNetworkInstanceInfo {
1276
1448
  /**
1449
+ * @public
1277
1450
  * <p>ID of the network instance.</p>
1278
1451
  */
1279
1452
  id: string | undefined;
1280
1453
  /**
1454
+ * @public
1281
1455
  * <p>Network instance ARN.</p>
1282
1456
  */
1283
1457
  arn: string | undefined;
1284
1458
  /**
1459
+ * @public
1285
1460
  * <p>Human-readable name of the network instance.</p>
1286
1461
  */
1287
1462
  nsInstanceName: string | undefined;
1288
1463
  /**
1464
+ * @public
1289
1465
  * <p>Human-readable description of the network instance.</p>
1290
1466
  */
1291
1467
  nsInstanceDescription: string | undefined;
1292
1468
  /**
1469
+ * @public
1293
1470
  * <p>ID of the network service descriptor in the network package.</p>
1294
1471
  */
1295
1472
  nsdId: string | undefined;
1296
1473
  /**
1474
+ * @public
1297
1475
  * <p>ID of the network service descriptor in the network package.</p>
1298
1476
  */
1299
1477
  nsdInfoId: string | undefined;
1300
1478
  /**
1479
+ * @public
1301
1480
  * <p>The state of the network instance.</p>
1302
1481
  */
1303
1482
  nsState: NsState | string | undefined;
1304
1483
  /**
1484
+ * @public
1305
1485
  * <p>The metadata of the network instance.</p>
1306
1486
  */
1307
1487
  metadata: ListSolNetworkInstanceMetadata | undefined;
@@ -1311,10 +1491,12 @@ export interface ListSolNetworkInstanceInfo {
1311
1491
  */
1312
1492
  export interface ListSolNetworkInstancesInput {
1313
1493
  /**
1494
+ * @public
1314
1495
  * <p>The maximum number of results to include in the response.</p>
1315
1496
  */
1316
1497
  maxResults?: number;
1317
1498
  /**
1499
+ * @public
1318
1500
  * <p>The token for the next page of results.</p>
1319
1501
  */
1320
1502
  nextToken?: string;
@@ -1324,10 +1506,12 @@ export interface ListSolNetworkInstancesInput {
1324
1506
  */
1325
1507
  export interface ListSolNetworkInstancesOutput {
1326
1508
  /**
1509
+ * @public
1327
1510
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1328
1511
  */
1329
1512
  nextToken?: string;
1330
1513
  /**
1514
+ * @public
1331
1515
  * <p>Lists network instances.</p>
1332
1516
  */
1333
1517
  networkInstances?: ListSolNetworkInstanceInfo[];
@@ -1337,10 +1521,12 @@ export interface ListSolNetworkInstancesOutput {
1337
1521
  */
1338
1522
  export interface ListSolNetworkOperationsInput {
1339
1523
  /**
1524
+ * @public
1340
1525
  * <p>The maximum number of results to include in the response.</p>
1341
1526
  */
1342
1527
  maxResults?: number;
1343
1528
  /**
1529
+ * @public
1344
1530
  * <p>The token for the next page of results.</p>
1345
1531
  */
1346
1532
  nextToken?: string;
@@ -1352,10 +1538,12 @@ export interface ListSolNetworkOperationsInput {
1352
1538
  */
1353
1539
  export interface ListSolNetworkOperationsMetadata {
1354
1540
  /**
1541
+ * @public
1355
1542
  * <p>The date that the resource was created.</p>
1356
1543
  */
1357
1544
  createdAt: Date | undefined;
1358
1545
  /**
1546
+ * @public
1359
1547
  * <p>The date that the resource was last modified.</p>
1360
1548
  */
1361
1549
  lastModified: Date | undefined;
@@ -1366,30 +1554,37 @@ export interface ListSolNetworkOperationsMetadata {
1366
1554
  */
1367
1555
  export interface ListSolNetworkOperationsInfo {
1368
1556
  /**
1557
+ * @public
1369
1558
  * <p>ID of this network operation.</p>
1370
1559
  */
1371
1560
  id: string | undefined;
1372
1561
  /**
1562
+ * @public
1373
1563
  * <p>Network operation ARN.</p>
1374
1564
  */
1375
1565
  arn: string | undefined;
1376
1566
  /**
1567
+ * @public
1377
1568
  * <p>The state of the network operation.</p>
1378
1569
  */
1379
1570
  operationState: NsLcmOperationState | string | undefined;
1380
1571
  /**
1572
+ * @public
1381
1573
  * <p>ID of the network instance related to this operation.</p>
1382
1574
  */
1383
1575
  nsInstanceId: string | undefined;
1384
1576
  /**
1577
+ * @public
1385
1578
  * <p>Type of lifecycle management network operation.</p>
1386
1579
  */
1387
1580
  lcmOperationType: LcmOperationType | string | undefined;
1388
1581
  /**
1582
+ * @public
1389
1583
  * <p>Error related to this specific network operation.</p>
1390
1584
  */
1391
1585
  error?: ProblemDetails;
1392
1586
  /**
1587
+ * @public
1393
1588
  * <p>Metadata related to this network operation.</p>
1394
1589
  */
1395
1590
  metadata?: ListSolNetworkOperationsMetadata;
@@ -1399,10 +1594,12 @@ export interface ListSolNetworkOperationsInfo {
1399
1594
  */
1400
1595
  export interface ListSolNetworkOperationsOutput {
1401
1596
  /**
1597
+ * @public
1402
1598
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1403
1599
  */
1404
1600
  nextToken?: string;
1405
1601
  /**
1602
+ * @public
1406
1603
  * <p>Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.</p>
1407
1604
  */
1408
1605
  networkOperations?: ListSolNetworkOperationsInfo[];
@@ -1414,10 +1611,12 @@ export interface ListSolNetworkOperationsOutput {
1414
1611
  */
1415
1612
  export interface ListSolNetworkPackageMetadata {
1416
1613
  /**
1614
+ * @public
1417
1615
  * <p>The date that the resource was created.</p>
1418
1616
  */
1419
1617
  createdAt: Date | undefined;
1420
1618
  /**
1619
+ * @public
1421
1620
  * <p>The date that the resource was last modified.</p>
1422
1621
  */
1423
1622
  lastModified: Date | undefined;
@@ -1429,50 +1628,62 @@ export interface ListSolNetworkPackageMetadata {
1429
1628
  */
1430
1629
  export interface ListSolNetworkPackageInfo {
1431
1630
  /**
1631
+ * @public
1432
1632
  * <p>ID of the individual network package.</p>
1433
1633
  */
1434
1634
  id: string | undefined;
1435
1635
  /**
1636
+ * @public
1436
1637
  * <p>Network package ARN.</p>
1437
1638
  */
1438
1639
  arn: string | undefined;
1439
1640
  /**
1641
+ * @public
1440
1642
  * <p>Onboarding state of the network service descriptor in the network package.</p>
1441
1643
  */
1442
1644
  nsdOnboardingState: NsdOnboardingState | string | undefined;
1443
1645
  /**
1646
+ * @public
1444
1647
  * <p>Operational state of the network service descriptor in the network package.</p>
1445
1648
  */
1446
1649
  nsdOperationalState: NsdOperationalState | string | undefined;
1447
1650
  /**
1651
+ * @public
1448
1652
  * <p>Usage state of the network service descriptor in the network package.</p>
1449
1653
  */
1450
1654
  nsdUsageState: NsdUsageState | string | undefined;
1451
1655
  /**
1656
+ * @public
1452
1657
  * <p>ID of the network service descriptor on which the network package is based.</p>
1453
1658
  */
1454
1659
  nsdId?: string;
1455
1660
  /**
1661
+ * @public
1456
1662
  * <p>Name of the onboarded network service descriptor in the network package.</p>
1457
1663
  */
1458
1664
  nsdName?: string;
1459
1665
  /**
1666
+ * @public
1460
1667
  * <p>Version of the onboarded network service descriptor in the network package.</p>
1461
1668
  */
1462
1669
  nsdVersion?: string;
1463
1670
  /**
1671
+ * @public
1464
1672
  * <p>Designer of the onboarded network service descriptor in the network package.</p>
1465
1673
  */
1466
1674
  nsdDesigner?: string;
1467
1675
  /**
1676
+ * @public
1468
1677
  * <p>Identifies a network service descriptor in a version independent manner.</p>
1469
1678
  */
1470
1679
  nsdInvariantId?: string;
1471
1680
  /**
1681
+ * @public
1472
1682
  * <p>Identifies the function package for the function package descriptor referenced by the onboarded network package.</p>
1473
1683
  */
1474
1684
  vnfPkgIds?: string[];
1475
1685
  /**
1686
+ * @public
1476
1687
  * <p>The metadata of the network package.</p>
1477
1688
  */
1478
1689
  metadata: ListSolNetworkPackageMetadata | undefined;
@@ -1482,10 +1693,12 @@ export interface ListSolNetworkPackageInfo {
1482
1693
  */
1483
1694
  export interface ListSolNetworkPackagesInput {
1484
1695
  /**
1696
+ * @public
1485
1697
  * <p>The maximum number of results to include in the response.</p>
1486
1698
  */
1487
1699
  maxResults?: number;
1488
1700
  /**
1701
+ * @public
1489
1702
  * <p>The token for the next page of results.</p>
1490
1703
  */
1491
1704
  nextToken?: string;
@@ -1495,10 +1708,12 @@ export interface ListSolNetworkPackagesInput {
1495
1708
  */
1496
1709
  export interface ListSolNetworkPackagesOutput {
1497
1710
  /**
1711
+ * @public
1498
1712
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
1499
1713
  */
1500
1714
  nextToken?: string;
1501
1715
  /**
1716
+ * @public
1502
1717
  * <p>Network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.</p>
1503
1718
  */
1504
1719
  networkPackages: ListSolNetworkPackageInfo[] | undefined;
@@ -1508,6 +1723,7 @@ export interface ListSolNetworkPackagesOutput {
1508
1723
  */
1509
1724
  export interface ListTagsForResourceInput {
1510
1725
  /**
1726
+ * @public
1511
1727
  * <p>Resource ARN.</p>
1512
1728
  */
1513
1729
  resourceArn: string | undefined;
@@ -1517,6 +1733,7 @@ export interface ListTagsForResourceInput {
1517
1733
  */
1518
1734
  export interface ListTagsForResourceOutput {
1519
1735
  /**
1736
+ * @public
1520
1737
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1521
1738
  */
1522
1739
  tags: Record<string, string> | undefined;
@@ -1526,14 +1743,17 @@ export interface ListTagsForResourceOutput {
1526
1743
  */
1527
1744
  export interface PutSolFunctionPackageContentInput {
1528
1745
  /**
1746
+ * @public
1529
1747
  * <p>Function package ID.</p>
1530
1748
  */
1531
1749
  vnfPkgId: string | undefined;
1532
1750
  /**
1751
+ * @public
1533
1752
  * <p>Function package content type.</p>
1534
1753
  */
1535
1754
  contentType?: PackageContentType | string;
1536
1755
  /**
1756
+ * @public
1537
1757
  * <p>Function package file.</p>
1538
1758
  */
1539
1759
  file: Uint8Array | undefined;
@@ -1545,6 +1765,7 @@ export interface PutSolFunctionPackageContentInput {
1545
1765
  */
1546
1766
  export interface PutSolFunctionPackageContentMetadata {
1547
1767
  /**
1768
+ * @public
1548
1769
  * <p>Metadata for function package artifacts.</p>
1549
1770
  * <p>Artifacts are the contents of the package descriptor file and the state of the package.</p>
1550
1771
  */
@@ -1555,26 +1776,32 @@ export interface PutSolFunctionPackageContentMetadata {
1555
1776
  */
1556
1777
  export interface PutSolFunctionPackageContentOutput {
1557
1778
  /**
1779
+ * @public
1558
1780
  * <p>Function package ID.</p>
1559
1781
  */
1560
1782
  id: string | undefined;
1561
1783
  /**
1784
+ * @public
1562
1785
  * <p>Function package descriptor ID.</p>
1563
1786
  */
1564
1787
  vnfdId: string | undefined;
1565
1788
  /**
1789
+ * @public
1566
1790
  * <p>Function product name.</p>
1567
1791
  */
1568
1792
  vnfProductName: string | undefined;
1569
1793
  /**
1794
+ * @public
1570
1795
  * <p>Function provider.</p>
1571
1796
  */
1572
1797
  vnfProvider: string | undefined;
1573
1798
  /**
1799
+ * @public
1574
1800
  * <p>Function package descriptor version.</p>
1575
1801
  */
1576
1802
  vnfdVersion: string | undefined;
1577
1803
  /**
1804
+ * @public
1578
1805
  * <p>Function package metadata.</p>
1579
1806
  */
1580
1807
  metadata: PutSolFunctionPackageContentMetadata | undefined;
@@ -1584,14 +1811,17 @@ export interface PutSolFunctionPackageContentOutput {
1584
1811
  */
1585
1812
  export interface PutSolNetworkPackageContentInput {
1586
1813
  /**
1814
+ * @public
1587
1815
  * <p>Network service descriptor info ID.</p>
1588
1816
  */
1589
1817
  nsdInfoId: string | undefined;
1590
1818
  /**
1819
+ * @public
1591
1820
  * <p>Network package content type.</p>
1592
1821
  */
1593
1822
  contentType?: PackageContentType | string;
1594
1823
  /**
1824
+ * @public
1595
1825
  * <p>Network package file.</p>
1596
1826
  */
1597
1827
  file: Uint8Array | undefined;
@@ -1603,6 +1833,7 @@ export interface PutSolNetworkPackageContentInput {
1603
1833
  */
1604
1834
  export interface PutSolNetworkPackageContentMetadata {
1605
1835
  /**
1836
+ * @public
1606
1837
  * <p>Metadata for network package artifacts.</p>
1607
1838
  * <p>Artifacts are the contents of the package descriptor file and the state of the package.</p>
1608
1839
  */
@@ -1613,30 +1844,37 @@ export interface PutSolNetworkPackageContentMetadata {
1613
1844
  */
1614
1845
  export interface PutSolNetworkPackageContentOutput {
1615
1846
  /**
1847
+ * @public
1616
1848
  * <p>Network package ID.</p>
1617
1849
  */
1618
1850
  id: string | undefined;
1619
1851
  /**
1852
+ * @public
1620
1853
  * <p>Network package ARN.</p>
1621
1854
  */
1622
1855
  arn: string | undefined;
1623
1856
  /**
1857
+ * @public
1624
1858
  * <p>Network service descriptor ID.</p>
1625
1859
  */
1626
1860
  nsdId: string | undefined;
1627
1861
  /**
1862
+ * @public
1628
1863
  * <p>Network service descriptor name.</p>
1629
1864
  */
1630
1865
  nsdName: string | undefined;
1631
1866
  /**
1867
+ * @public
1632
1868
  * <p>Network service descriptor version.</p>
1633
1869
  */
1634
1870
  nsdVersion: string | undefined;
1635
1871
  /**
1872
+ * @public
1636
1873
  * <p>Function package IDs.</p>
1637
1874
  */
1638
1875
  vnfPkgIds: string[] | undefined;
1639
1876
  /**
1877
+ * @public
1640
1878
  * <p>Network package metadata.</p>
1641
1879
  */
1642
1880
  metadata: PutSolNetworkPackageContentMetadata | undefined;
@@ -1646,10 +1884,12 @@ export interface PutSolNetworkPackageContentOutput {
1646
1884
  */
1647
1885
  export interface TagResourceInput {
1648
1886
  /**
1887
+ * @public
1649
1888
  * <p>Resource ARN.</p>
1650
1889
  */
1651
1890
  resourceArn: string | undefined;
1652
1891
  /**
1892
+ * @public
1653
1893
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1654
1894
  */
1655
1895
  tags: Record<string, string> | undefined;
@@ -1664,10 +1904,12 @@ export interface TagResourceOutput {
1664
1904
  */
1665
1905
  export interface TerminateSolNetworkInstanceInput {
1666
1906
  /**
1907
+ * @public
1667
1908
  * <p>ID of the network instance.</p>
1668
1909
  */
1669
1910
  nsInstanceId: string | undefined;
1670
1911
  /**
1912
+ * @public
1671
1913
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1672
1914
  */
1673
1915
  tags?: Record<string, string>;
@@ -1677,10 +1919,12 @@ export interface TerminateSolNetworkInstanceInput {
1677
1919
  */
1678
1920
  export interface TerminateSolNetworkInstanceOutput {
1679
1921
  /**
1922
+ * @public
1680
1923
  * <p>The identifier of the network operation.</p>
1681
1924
  */
1682
1925
  nsLcmOpOccId?: string;
1683
1926
  /**
1927
+ * @public
1684
1928
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1685
1929
  */
1686
1930
  tags?: Record<string, string>;
@@ -1690,10 +1934,12 @@ export interface TerminateSolNetworkInstanceOutput {
1690
1934
  */
1691
1935
  export interface UntagResourceInput {
1692
1936
  /**
1937
+ * @public
1693
1938
  * <p>Resource ARN.</p>
1694
1939
  */
1695
1940
  resourceArn: string | undefined;
1696
1941
  /**
1942
+ * @public
1697
1943
  * <p>Tag keys.</p>
1698
1944
  */
1699
1945
  tagKeys: string[] | undefined;
@@ -1708,10 +1954,12 @@ export interface UntagResourceOutput {
1708
1954
  */
1709
1955
  export interface UpdateSolFunctionPackageInput {
1710
1956
  /**
1957
+ * @public
1711
1958
  * <p>ID of the function package.</p>
1712
1959
  */
1713
1960
  vnfPkgId: string | undefined;
1714
1961
  /**
1962
+ * @public
1715
1963
  * <p>Operational state of the function package.</p>
1716
1964
  */
1717
1965
  operationalState: OperationalState | string | undefined;
@@ -1721,6 +1969,7 @@ export interface UpdateSolFunctionPackageInput {
1721
1969
  */
1722
1970
  export interface UpdateSolFunctionPackageOutput {
1723
1971
  /**
1972
+ * @public
1724
1973
  * <p>Operational state of the function package.</p>
1725
1974
  */
1726
1975
  operationalState: OperationalState | string | undefined;
@@ -1732,11 +1981,13 @@ export interface UpdateSolFunctionPackageOutput {
1732
1981
  */
1733
1982
  export interface UpdateSolNetworkModify {
1734
1983
  /**
1984
+ * @public
1735
1985
  * <p>ID of the network function instance.</p>
1736
1986
  * <p>A network function instance is a function in a function package .</p>
1737
1987
  */
1738
1988
  vnfInstanceId: string | undefined;
1739
1989
  /**
1990
+ * @public
1740
1991
  * <p>Provides values for the configurable properties declared in the function package descriptor.</p>
1741
1992
  */
1742
1993
  vnfConfigurableProperties: __DocumentType | undefined;
@@ -1757,18 +2008,22 @@ export type UpdateSolNetworkType = (typeof UpdateSolNetworkType)[keyof typeof Up
1757
2008
  */
1758
2009
  export interface UpdateSolNetworkInstanceInput {
1759
2010
  /**
2011
+ * @public
1760
2012
  * <p>ID of the network instance.</p>
1761
2013
  */
1762
2014
  nsInstanceId: string | undefined;
1763
2015
  /**
2016
+ * @public
1764
2017
  * <p>The type of update.</p>
1765
2018
  */
1766
2019
  updateType: UpdateSolNetworkType | string | undefined;
1767
2020
  /**
2021
+ * @public
1768
2022
  * <p>Identifies the network function information parameters and/or the configurable properties of the network function to be modified.</p>
1769
2023
  */
1770
2024
  modifyVnfInfoData?: UpdateSolNetworkModify;
1771
2025
  /**
2026
+ * @public
1772
2027
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1773
2028
  */
1774
2029
  tags?: Record<string, string>;
@@ -1778,10 +2033,12 @@ export interface UpdateSolNetworkInstanceInput {
1778
2033
  */
1779
2034
  export interface UpdateSolNetworkInstanceOutput {
1780
2035
  /**
2036
+ * @public
1781
2037
  * <p>The identifier of the network operation.</p>
1782
2038
  */
1783
2039
  nsLcmOpOccId?: string;
1784
2040
  /**
2041
+ * @public
1785
2042
  * <p>A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are transferred to the network operation that is created. Use tags to search and filter your resources or track your Amazon Web Services costs.</p>
1786
2043
  */
1787
2044
  tags?: Record<string, string>;
@@ -1791,10 +2048,12 @@ export interface UpdateSolNetworkInstanceOutput {
1791
2048
  */
1792
2049
  export interface UpdateSolNetworkPackageInput {
1793
2050
  /**
2051
+ * @public
1794
2052
  * <p>ID of the network service descriptor in the network package.</p>
1795
2053
  */
1796
2054
  nsdInfoId: string | undefined;
1797
2055
  /**
2056
+ * @public
1798
2057
  * <p>Operational state of the network service descriptor in the network package.</p>
1799
2058
  */
1800
2059
  nsdOperationalState: NsdOperationalState | string | undefined;
@@ -1804,6 +2063,7 @@ export interface UpdateSolNetworkPackageInput {
1804
2063
  */
1805
2064
  export interface UpdateSolNetworkPackageOutput {
1806
2065
  /**
2066
+ * @public
1807
2067
  * <p>Operational state of the network service descriptor in the network package.</p>
1808
2068
  */
1809
2069
  nsdOperationalState: NsdOperationalState | string | undefined;
@@ -1813,14 +2073,17 @@ export interface UpdateSolNetworkPackageOutput {
1813
2073
  */
1814
2074
  export interface ValidateSolFunctionPackageContentInput {
1815
2075
  /**
2076
+ * @public
1816
2077
  * <p>Function package ID.</p>
1817
2078
  */
1818
2079
  vnfPkgId: string | undefined;
1819
2080
  /**
2081
+ * @public
1820
2082
  * <p>Function package content type.</p>
1821
2083
  */
1822
2084
  contentType?: PackageContentType | string;
1823
2085
  /**
2086
+ * @public
1824
2087
  * <p>Function package file.</p>
1825
2088
  */
1826
2089
  file: Uint8Array | undefined;
@@ -1832,6 +2095,7 @@ export interface ValidateSolFunctionPackageContentInput {
1832
2095
  */
1833
2096
  export interface ValidateSolFunctionPackageContentMetadata {
1834
2097
  /**
2098
+ * @public
1835
2099
  * <p>Metadata for function package artifacts.</p>
1836
2100
  * <p>Artifacts are the contents of the package descriptor file and the state of the package.</p>
1837
2101
  */
@@ -1842,26 +2106,32 @@ export interface ValidateSolFunctionPackageContentMetadata {
1842
2106
  */
1843
2107
  export interface ValidateSolFunctionPackageContentOutput {
1844
2108
  /**
2109
+ * @public
1845
2110
  * <p>Function package ID.</p>
1846
2111
  */
1847
2112
  id: string | undefined;
1848
2113
  /**
2114
+ * @public
1849
2115
  * <p>Function package descriptor ID.</p>
1850
2116
  */
1851
2117
  vnfdId: string | undefined;
1852
2118
  /**
2119
+ * @public
1853
2120
  * <p>Network function product name.</p>
1854
2121
  */
1855
2122
  vnfProductName: string | undefined;
1856
2123
  /**
2124
+ * @public
1857
2125
  * <p>Network function provider.</p>
1858
2126
  */
1859
2127
  vnfProvider: string | undefined;
1860
2128
  /**
2129
+ * @public
1861
2130
  * <p>Function package descriptor version.</p>
1862
2131
  */
1863
2132
  vnfdVersion: string | undefined;
1864
2133
  /**
2134
+ * @public
1865
2135
  * <p>Function package metadata.</p>
1866
2136
  */
1867
2137
  metadata: ValidateSolFunctionPackageContentMetadata | undefined;
@@ -1871,14 +2141,17 @@ export interface ValidateSolFunctionPackageContentOutput {
1871
2141
  */
1872
2142
  export interface ValidateSolNetworkPackageContentInput {
1873
2143
  /**
2144
+ * @public
1874
2145
  * <p>Network service descriptor file.</p>
1875
2146
  */
1876
2147
  nsdInfoId: string | undefined;
1877
2148
  /**
2149
+ * @public
1878
2150
  * <p>Network package content type.</p>
1879
2151
  */
1880
2152
  contentType?: PackageContentType | string;
1881
2153
  /**
2154
+ * @public
1882
2155
  * <p>Network package file.</p>
1883
2156
  */
1884
2157
  file: Uint8Array | undefined;
@@ -1890,6 +2163,7 @@ export interface ValidateSolNetworkPackageContentInput {
1890
2163
  */
1891
2164
  export interface ValidateSolNetworkPackageContentMetadata {
1892
2165
  /**
2166
+ * @public
1893
2167
  * <p>Metadata for network package artifacts.</p>
1894
2168
  * <p>Artifacts are the contents of the package descriptor file and the state of the package.</p>
1895
2169
  */
@@ -1900,30 +2174,37 @@ export interface ValidateSolNetworkPackageContentMetadata {
1900
2174
  */
1901
2175
  export interface ValidateSolNetworkPackageContentOutput {
1902
2176
  /**
2177
+ * @public
1903
2178
  * <p>Network package ID.</p>
1904
2179
  */
1905
2180
  id: string | undefined;
1906
2181
  /**
2182
+ * @public
1907
2183
  * <p>Network package ARN.</p>
1908
2184
  */
1909
2185
  arn: string | undefined;
1910
2186
  /**
2187
+ * @public
1911
2188
  * <p>Network service descriptor ID.</p>
1912
2189
  */
1913
2190
  nsdId: string | undefined;
1914
2191
  /**
2192
+ * @public
1915
2193
  * <p>Network service descriptor name.</p>
1916
2194
  */
1917
2195
  nsdName: string | undefined;
1918
2196
  /**
2197
+ * @public
1919
2198
  * <p>Network service descriptor version.</p>
1920
2199
  */
1921
2200
  nsdVersion: string | undefined;
1922
2201
  /**
2202
+ * @public
1923
2203
  * <p>Function package IDs.</p>
1924
2204
  */
1925
2205
  vnfPkgIds: string[] | undefined;
1926
2206
  /**
2207
+ * @public
1927
2208
  * <p>Network package metadata.</p>
1928
2209
  */
1929
2210
  metadata: ValidateSolNetworkPackageContentMetadata | undefined;