@aws-sdk/client-service-catalog 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 type PortfolioShareType = (typeof PortfolioShareType)[keyof typeof Portfo
18
18
  */
19
19
  export interface AcceptPortfolioShareInput {
20
20
  /**
21
+ * @public
21
22
  * <p>The language code.</p>
22
23
  * <ul>
23
24
  * <li>
@@ -32,10 +33,12 @@ export interface AcceptPortfolioShareInput {
32
33
  */
33
34
  AcceptLanguage?: string;
34
35
  /**
36
+ * @public
35
37
  * <p>The portfolio identifier.</p>
36
38
  */
37
39
  PortfolioId: string | undefined;
38
40
  /**
41
+ * @public
39
42
  * <p>The type of shared portfolios to accept. The default is to accept imported portfolios.</p>
40
43
  * <ul>
41
44
  * <li>
@@ -121,6 +124,7 @@ export type AccessLevelFilterKey = (typeof AccessLevelFilterKey)[keyof typeof Ac
121
124
  */
122
125
  export interface AccessLevelFilter {
123
126
  /**
127
+ * @public
124
128
  * <p>The access level.</p>
125
129
  * <ul>
126
130
  * <li>
@@ -139,6 +143,7 @@ export interface AccessLevelFilter {
139
143
  */
140
144
  Key?: AccessLevelFilterKey | string;
141
145
  /**
146
+ * @public
142
147
  * <p>The user to which the access level applies. The only supported value is <code>Self</code>.</p>
143
148
  */
144
149
  Value?: string;
@@ -163,10 +168,12 @@ export type AccessStatus = (typeof AccessStatus)[keyof typeof AccessStatus];
163
168
  */
164
169
  export interface Tag {
165
170
  /**
171
+ * @public
166
172
  * <p>The tag key.</p>
167
173
  */
168
174
  Key: string | undefined;
169
175
  /**
176
+ * @public
170
177
  * <p>The value for this key.</p>
171
178
  */
172
179
  Value: string | undefined;
@@ -176,10 +183,12 @@ export interface Tag {
176
183
  */
177
184
  export interface AssociateBudgetWithResourceInput {
178
185
  /**
186
+ * @public
179
187
  * <p>The name of the budget you want to associate.</p>
180
188
  */
181
189
  BudgetName: string | undefined;
182
190
  /**
191
+ * @public
183
192
  * <p> The resource identifier. Either a portfolio-id or a product-id.</p>
184
193
  */
185
194
  ResourceId: string | undefined;
@@ -219,6 +228,7 @@ export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
219
228
  */
220
229
  export interface AssociatePrincipalWithPortfolioInput {
221
230
  /**
231
+ * @public
222
232
  * <p>The language code.</p>
223
233
  * <ul>
224
234
  * <li>
@@ -233,10 +243,12 @@ export interface AssociatePrincipalWithPortfolioInput {
233
243
  */
234
244
  AcceptLanguage?: string;
235
245
  /**
246
+ * @public
236
247
  * <p>The portfolio identifier.</p>
237
248
  */
238
249
  PortfolioId: string | undefined;
239
250
  /**
251
+ * @public
240
252
  * <p>The ARN of the principal (user, role, or group). If the <code>PrincipalType</code> is <code>IAM</code>, the supported value is a
241
253
  * fully defined
242
254
  * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM Amazon Resource Name (ARN)</a>.
@@ -294,6 +306,7 @@ export interface AssociatePrincipalWithPortfolioInput {
294
306
  */
295
307
  PrincipalARN: string | undefined;
296
308
  /**
309
+ * @public
297
310
  * <p>The principal type. The supported value is <code>IAM</code> if you use a fully defined Amazon Resource Name
298
311
  * (ARN), or <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>,
299
312
  * with or without wildcard characters. </p>
@@ -310,6 +323,7 @@ export interface AssociatePrincipalWithPortfolioOutput {
310
323
  */
311
324
  export interface AssociateProductWithPortfolioInput {
312
325
  /**
326
+ * @public
313
327
  * <p>The language code.</p>
314
328
  * <ul>
315
329
  * <li>
@@ -324,14 +338,17 @@ export interface AssociateProductWithPortfolioInput {
324
338
  */
325
339
  AcceptLanguage?: string;
326
340
  /**
341
+ * @public
327
342
  * <p>The product identifier.</p>
328
343
  */
329
344
  ProductId: string | undefined;
330
345
  /**
346
+ * @public
331
347
  * <p>The portfolio identifier.</p>
332
348
  */
333
349
  PortfolioId: string | undefined;
334
350
  /**
351
+ * @public
335
352
  * <p>The identifier of the source portfolio.</p>
336
353
  */
337
354
  SourcePortfolioId?: string;
@@ -346,18 +363,22 @@ export interface AssociateProductWithPortfolioOutput {
346
363
  */
347
364
  export interface AssociateServiceActionWithProvisioningArtifactInput {
348
365
  /**
366
+ * @public
349
367
  * <p>The product identifier. For example, <code>prod-abcdzk7xy33qa</code>.</p>
350
368
  */
351
369
  ProductId: string | undefined;
352
370
  /**
371
+ * @public
353
372
  * <p>The identifier of the provisioning artifact. For example, <code>pa-4abcdjnxjj6ne</code>.</p>
354
373
  */
355
374
  ProvisioningArtifactId: string | undefined;
356
375
  /**
376
+ * @public
357
377
  * <p>The self-service action identifier. For example, <code>act-fs7abcd89wxyz</code>.</p>
358
378
  */
359
379
  ServiceActionId: string | undefined;
360
380
  /**
381
+ * @public
361
382
  * <p>The language code.</p>
362
383
  * <ul>
363
384
  * <li>
@@ -382,10 +403,12 @@ export interface AssociateServiceActionWithProvisioningArtifactOutput {
382
403
  */
383
404
  export interface AssociateTagOptionWithResourceInput {
384
405
  /**
406
+ * @public
385
407
  * <p>The resource identifier.</p>
386
408
  */
387
409
  ResourceId: string | undefined;
388
410
  /**
411
+ * @public
389
412
  * <p>The TagOption identifier.</p>
390
413
  */
391
414
  TagOptionId: string | undefined;
@@ -430,14 +453,17 @@ export declare class TagOptionNotMigratedException extends __BaseException {
430
453
  */
431
454
  export interface ServiceActionAssociation {
432
455
  /**
456
+ * @public
433
457
  * <p>The self-service action identifier. For example, <code>act-fs7abcd89wxyz</code>.</p>
434
458
  */
435
459
  ServiceActionId: string | undefined;
436
460
  /**
461
+ * @public
437
462
  * <p>The product identifier. For example, <code>prod-abcdzk7xy33qa</code>.</p>
438
463
  */
439
464
  ProductId: string | undefined;
440
465
  /**
466
+ * @public
441
467
  * <p>The identifier of the provisioning artifact. For example, <code>pa-4abcdjnxjj6ne</code>.</p>
442
468
  */
443
469
  ProvisioningArtifactId: string | undefined;
@@ -447,10 +473,12 @@ export interface ServiceActionAssociation {
447
473
  */
448
474
  export interface BatchAssociateServiceActionWithProvisioningArtifactInput {
449
475
  /**
476
+ * @public
450
477
  * <p>One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.</p>
451
478
  */
452
479
  ServiceActionAssociations: ServiceActionAssociation[] | undefined;
453
480
  /**
481
+ * @public
454
482
  * <p>The language code.</p>
455
483
  * <ul>
456
484
  * <li>
@@ -487,22 +515,27 @@ export type ServiceActionAssociationErrorCode = (typeof ServiceActionAssociation
487
515
  */
488
516
  export interface FailedServiceActionAssociation {
489
517
  /**
518
+ * @public
490
519
  * <p>The self-service action identifier. For example, <code>act-fs7abcd89wxyz</code>.</p>
491
520
  */
492
521
  ServiceActionId?: string;
493
522
  /**
523
+ * @public
494
524
  * <p>The product identifier. For example, <code>prod-abcdzk7xy33qa</code>.</p>
495
525
  */
496
526
  ProductId?: string;
497
527
  /**
528
+ * @public
498
529
  * <p>The identifier of the provisioning artifact. For example, <code>pa-4abcdjnxjj6ne</code>.</p>
499
530
  */
500
531
  ProvisioningArtifactId?: string;
501
532
  /**
533
+ * @public
502
534
  * <p>The error code. Valid values are listed below.</p>
503
535
  */
504
536
  ErrorCode?: ServiceActionAssociationErrorCode | string;
505
537
  /**
538
+ * @public
506
539
  * <p>A text description of the error.</p>
507
540
  */
508
541
  ErrorMessage?: string;
@@ -512,6 +545,7 @@ export interface FailedServiceActionAssociation {
512
545
  */
513
546
  export interface BatchAssociateServiceActionWithProvisioningArtifactOutput {
514
547
  /**
548
+ * @public
515
549
  * <p>An object that contains a list of errors, along with information to help you identify the self-service action.</p>
516
550
  */
517
551
  FailedServiceActionAssociations?: FailedServiceActionAssociation[];
@@ -521,10 +555,12 @@ export interface BatchAssociateServiceActionWithProvisioningArtifactOutput {
521
555
  */
522
556
  export interface BatchDisassociateServiceActionFromProvisioningArtifactInput {
523
557
  /**
558
+ * @public
524
559
  * <p>One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.</p>
525
560
  */
526
561
  ServiceActionAssociations: ServiceActionAssociation[] | undefined;
527
562
  /**
563
+ * @public
528
564
  * <p>The language code.</p>
529
565
  * <ul>
530
566
  * <li>
@@ -544,6 +580,7 @@ export interface BatchDisassociateServiceActionFromProvisioningArtifactInput {
544
580
  */
545
581
  export interface BatchDisassociateServiceActionFromProvisioningArtifactOutput {
546
582
  /**
583
+ * @public
547
584
  * <p>An object that contains a list of errors, along with information to help you identify the self-service action.</p>
548
585
  */
549
586
  FailedServiceActionAssociations?: FailedServiceActionAssociation[];
@@ -575,6 +612,7 @@ export type ProvisioningArtifactPropertyName = (typeof ProvisioningArtifactPrope
575
612
  */
576
613
  export interface CopyProductInput {
577
614
  /**
615
+ * @public
578
616
  * <p>The language code.</p>
579
617
  * <ul>
580
618
  * <li>
@@ -589,28 +627,34 @@ export interface CopyProductInput {
589
627
  */
590
628
  AcceptLanguage?: string;
591
629
  /**
630
+ * @public
592
631
  * <p>The Amazon Resource Name (ARN) of the source product.</p>
593
632
  */
594
633
  SourceProductArn: string | undefined;
595
634
  /**
635
+ * @public
596
636
  * <p>The identifier of the target product. By default, a new product is created.</p>
597
637
  */
598
638
  TargetProductId?: string;
599
639
  /**
640
+ * @public
600
641
  * <p>A name for the target product. The default is the name of the source product.</p>
601
642
  */
602
643
  TargetProductName?: string;
603
644
  /**
645
+ * @public
604
646
  * <p>The identifiers of the provisioning artifacts (also known as versions) of the product to copy.
605
647
  * By default, all provisioning artifacts are copied.</p>
606
648
  */
607
649
  SourceProvisioningArtifactIdentifiers?: Record<string, string>[];
608
650
  /**
651
+ * @public
609
652
  * <p>The copy options. If the value is <code>CopyTags</code>, the tags from the source
610
653
  * product are copied to the target product.</p>
611
654
  */
612
655
  CopyOptions?: (CopyOption | string)[];
613
656
  /**
657
+ * @public
614
658
  * <p> A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
615
659
  * the same response is returned for each repeated request. </p>
616
660
  */
@@ -621,6 +665,7 @@ export interface CopyProductInput {
621
665
  */
622
666
  export interface CopyProductOutput {
623
667
  /**
668
+ * @public
624
669
  * <p>The token to use to track the progress of the operation.</p>
625
670
  */
626
671
  CopyProductToken?: string;
@@ -630,6 +675,7 @@ export interface CopyProductOutput {
630
675
  */
631
676
  export interface CreateConstraintInput {
632
677
  /**
678
+ * @public
633
679
  * <p>The language code.</p>
634
680
  * <ul>
635
681
  * <li>
@@ -644,14 +690,17 @@ export interface CreateConstraintInput {
644
690
  */
645
691
  AcceptLanguage?: string;
646
692
  /**
693
+ * @public
647
694
  * <p>The portfolio identifier.</p>
648
695
  */
649
696
  PortfolioId: string | undefined;
650
697
  /**
698
+ * @public
651
699
  * <p>The product identifier.</p>
652
700
  */
653
701
  ProductId: string | undefined;
654
702
  /**
703
+ * @public
655
704
  * <p>The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:</p>
656
705
  * <dl>
657
706
  * <dt>LAUNCH</dt>
@@ -707,6 +756,7 @@ export interface CreateConstraintInput {
707
756
  */
708
757
  Parameters: string | undefined;
709
758
  /**
759
+ * @public
710
760
  * <p>The type of constraint.</p>
711
761
  * <ul>
712
762
  * <li>
@@ -738,10 +788,12 @@ export interface CreateConstraintInput {
738
788
  */
739
789
  Type: string | undefined;
740
790
  /**
791
+ * @public
741
792
  * <p>The description of the constraint.</p>
742
793
  */
743
794
  Description?: string;
744
795
  /**
796
+ * @public
745
797
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
746
798
  * the same response is returned for each repeated request.</p>
747
799
  */
@@ -753,10 +805,12 @@ export interface CreateConstraintInput {
753
805
  */
754
806
  export interface ConstraintDetail {
755
807
  /**
808
+ * @public
756
809
  * <p>The identifier of the constraint.</p>
757
810
  */
758
811
  ConstraintId?: string;
759
812
  /**
813
+ * @public
760
814
  * <p>The type of constraint.</p>
761
815
  * <ul>
762
816
  * <li>
@@ -781,18 +835,22 @@ export interface ConstraintDetail {
781
835
  */
782
836
  Type?: string;
783
837
  /**
838
+ * @public
784
839
  * <p>The description of the constraint.</p>
785
840
  */
786
841
  Description?: string;
787
842
  /**
843
+ * @public
788
844
  * <p>The owner of the constraint.</p>
789
845
  */
790
846
  Owner?: string;
791
847
  /**
848
+ * @public
792
849
  * <p>The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.</p>
793
850
  */
794
851
  ProductId?: string;
795
852
  /**
853
+ * @public
796
854
  * <p>The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.</p>
797
855
  */
798
856
  PortfolioId?: string;
@@ -815,14 +873,17 @@ export type Status = (typeof Status)[keyof typeof Status];
815
873
  */
816
874
  export interface CreateConstraintOutput {
817
875
  /**
876
+ * @public
818
877
  * <p>Information about the constraint.</p>
819
878
  */
820
879
  ConstraintDetail?: ConstraintDetail;
821
880
  /**
881
+ * @public
822
882
  * <p>The constraint parameters.</p>
823
883
  */
824
884
  ConstraintParameters?: string;
825
885
  /**
886
+ * @public
826
887
  * <p>The status of the current request.</p>
827
888
  */
828
889
  Status?: Status | string;
@@ -832,6 +893,7 @@ export interface CreateConstraintOutput {
832
893
  */
833
894
  export interface CreatePortfolioInput {
834
895
  /**
896
+ * @public
835
897
  * <p>The language code.</p>
836
898
  * <ul>
837
899
  * <li>
@@ -846,22 +908,27 @@ export interface CreatePortfolioInput {
846
908
  */
847
909
  AcceptLanguage?: string;
848
910
  /**
911
+ * @public
849
912
  * <p>The name to use for display purposes.</p>
850
913
  */
851
914
  DisplayName: string | undefined;
852
915
  /**
916
+ * @public
853
917
  * <p>The description of the portfolio.</p>
854
918
  */
855
919
  Description?: string;
856
920
  /**
921
+ * @public
857
922
  * <p>The name of the portfolio provider.</p>
858
923
  */
859
924
  ProviderName: string | undefined;
860
925
  /**
926
+ * @public
861
927
  * <p>One or more tags.</p>
862
928
  */
863
929
  Tags?: Tag[];
864
930
  /**
931
+ * @public
865
932
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
866
933
  * the same response is returned for each repeated request.</p>
867
934
  */
@@ -873,26 +940,32 @@ export interface CreatePortfolioInput {
873
940
  */
874
941
  export interface PortfolioDetail {
875
942
  /**
943
+ * @public
876
944
  * <p>The portfolio identifier.</p>
877
945
  */
878
946
  Id?: string;
879
947
  /**
948
+ * @public
880
949
  * <p>The ARN assigned to the portfolio.</p>
881
950
  */
882
951
  ARN?: string;
883
952
  /**
953
+ * @public
884
954
  * <p>The name to use for display purposes.</p>
885
955
  */
886
956
  DisplayName?: string;
887
957
  /**
958
+ * @public
888
959
  * <p>The description of the portfolio.</p>
889
960
  */
890
961
  Description?: string;
891
962
  /**
963
+ * @public
892
964
  * <p>The UTC time stamp of the creation time.</p>
893
965
  */
894
966
  CreatedTime?: Date;
895
967
  /**
968
+ * @public
896
969
  * <p>The name of the portfolio provider.</p>
897
970
  */
898
971
  ProviderName?: string;
@@ -902,10 +975,12 @@ export interface PortfolioDetail {
902
975
  */
903
976
  export interface CreatePortfolioOutput {
904
977
  /**
978
+ * @public
905
979
  * <p>Information about the portfolio.</p>
906
980
  */
907
981
  PortfolioDetail?: PortfolioDetail;
908
982
  /**
983
+ * @public
909
984
  * <p>Information about the tags associated with the portfolio.</p>
910
985
  */
911
986
  Tags?: Tag[];
@@ -929,10 +1004,12 @@ export type OrganizationNodeType = (typeof OrganizationNodeType)[keyof typeof Or
929
1004
  */
930
1005
  export interface OrganizationNode {
931
1006
  /**
1007
+ * @public
932
1008
  * <p>The organization node type.</p>
933
1009
  */
934
1010
  Type?: OrganizationNodeType | string;
935
1011
  /**
1012
+ * @public
936
1013
  * <p>The identifier of the organization node.</p>
937
1014
  */
938
1015
  Value?: string;
@@ -942,6 +1019,7 @@ export interface OrganizationNode {
942
1019
  */
943
1020
  export interface CreatePortfolioShareInput {
944
1021
  /**
1022
+ * @public
945
1023
  * <p>The language code.</p>
946
1024
  * <ul>
947
1025
  * <li>
@@ -956,24 +1034,29 @@ export interface CreatePortfolioShareInput {
956
1034
  */
957
1035
  AcceptLanguage?: string;
958
1036
  /**
1037
+ * @public
959
1038
  * <p>The portfolio identifier.</p>
960
1039
  */
961
1040
  PortfolioId: string | undefined;
962
1041
  /**
1042
+ * @public
963
1043
  * <p>The Amazon Web Services account ID. For example, <code>123456789012</code>.</p>
964
1044
  */
965
1045
  AccountId?: string;
966
1046
  /**
1047
+ * @public
967
1048
  * <p>The organization node to whom you are going to share. When you pass <code>OrganizationNode</code>, it creates <code>PortfolioShare</code> for all of the Amazon Web Services accounts that are associated to the <code>OrganizationNode</code>.
968
1049
  * The output returns a <code>PortfolioShareToken</code>, which enables the administrator to monitor the status of the <code>PortfolioShare</code> creation process.</p>
969
1050
  */
970
1051
  OrganizationNode?: OrganizationNode;
971
1052
  /**
1053
+ * @public
972
1054
  * <p>Enables or disables <code>TagOptions </code> sharing when creating the portfolio share. If this flag is not
973
1055
  * provided, TagOptions sharing is disabled.</p>
974
1056
  */
975
1057
  ShareTagOptions?: boolean;
976
1058
  /**
1059
+ * @public
977
1060
  * <p>Enables or disables <code>Principal</code> sharing when creating the portfolio share. If this flag is not provided,
978
1061
  * principal sharing is disabled. </p>
979
1062
  * <p>When you enable Principal Name Sharing for a portfolio share, the share recipient
@@ -990,6 +1073,7 @@ export interface CreatePortfolioShareInput {
990
1073
  */
991
1074
  export interface CreatePortfolioShareOutput {
992
1075
  /**
1076
+ * @public
993
1077
  * <p>The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.</p>
994
1078
  */
995
1079
  PortfolioShareToken?: string;
@@ -1040,14 +1124,17 @@ export type ProvisioningArtifactType = (typeof ProvisioningArtifactType)[keyof t
1040
1124
  */
1041
1125
  export interface ProvisioningArtifactProperties {
1042
1126
  /**
1127
+ * @public
1043
1128
  * <p>The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.</p>
1044
1129
  */
1045
1130
  Name?: string;
1046
1131
  /**
1132
+ * @public
1047
1133
  * <p>The description of the provisioning artifact, including how it differs from the previous provisioning artifact.</p>
1048
1134
  */
1049
1135
  Description?: string;
1050
1136
  /**
1137
+ * @public
1051
1138
  * <p>Specify the template source with one of the following options, but not both.
1052
1139
  * Keys accepted: [ <code>LoadTemplateFromURL</code>, <code>ImportFromPhysicalId</code> ]</p>
1053
1140
  * <p>The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
@@ -1063,6 +1150,7 @@ export interface ProvisioningArtifactProperties {
1063
1150
  */
1064
1151
  Info?: Record<string, string>;
1065
1152
  /**
1153
+ * @public
1066
1154
  * <p>The type of provisioning artifact.</p>
1067
1155
  * <ul>
1068
1156
  * <li>
@@ -1085,6 +1173,7 @@ export interface ProvisioningArtifactProperties {
1085
1173
  */
1086
1174
  Type?: ProvisioningArtifactType | string;
1087
1175
  /**
1176
+ * @public
1088
1177
  * <p>If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.</p>
1089
1178
  */
1090
1179
  DisableTemplateValidation?: boolean;
@@ -1095,19 +1184,23 @@ export interface ProvisioningArtifactProperties {
1095
1184
  */
1096
1185
  export interface CodeStarParameters {
1097
1186
  /**
1187
+ * @public
1098
1188
  * <p>The CodeStar ARN, which is the connection between Service Catalog and the external repository.</p>
1099
1189
  */
1100
1190
  ConnectionArn: string | undefined;
1101
1191
  /**
1192
+ * @public
1102
1193
  * <p>The specific repository where the product’s artifact-to-be-synced resides, formatted as
1103
1194
  * "Account/Repo." </p>
1104
1195
  */
1105
1196
  Repository: string | undefined;
1106
1197
  /**
1198
+ * @public
1107
1199
  * <p>The specific branch where the artifact resides. </p>
1108
1200
  */
1109
1201
  Branch: string | undefined;
1110
1202
  /**
1203
+ * @public
1111
1204
  * <p>The absolute path wehre the artifact resides within the repo and branch, formatted as
1112
1205
  * "folder/file.json." </p>
1113
1206
  */
@@ -1119,6 +1212,7 @@ export interface CodeStarParameters {
1119
1212
  */
1120
1213
  export interface SourceConnectionParameters {
1121
1214
  /**
1215
+ * @public
1122
1216
  * <p>Provides <code>ConnectionType</code> details.</p>
1123
1217
  */
1124
1218
  CodeStar?: CodeStarParameters;
@@ -1144,10 +1238,12 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
1144
1238
  */
1145
1239
  export interface SourceConnection {
1146
1240
  /**
1241
+ * @public
1147
1242
  * <p>The only supported <code>SourceConnection</code> type is Codestar. </p>
1148
1243
  */
1149
1244
  Type?: SourceType | string;
1150
1245
  /**
1246
+ * @public
1151
1247
  * <p>The connection details based on the connection <code>Type</code>. </p>
1152
1248
  */
1153
1249
  ConnectionParameters: SourceConnectionParameters | undefined;
@@ -1157,6 +1253,7 @@ export interface SourceConnection {
1157
1253
  */
1158
1254
  export interface CreateProductInput {
1159
1255
  /**
1256
+ * @public
1160
1257
  * <p>The language code.</p>
1161
1258
  * <ul>
1162
1259
  * <li>
@@ -1171,53 +1268,65 @@ export interface CreateProductInput {
1171
1268
  */
1172
1269
  AcceptLanguage?: string;
1173
1270
  /**
1271
+ * @public
1174
1272
  * <p>The name of the product.</p>
1175
1273
  */
1176
1274
  Name: string | undefined;
1177
1275
  /**
1276
+ * @public
1178
1277
  * <p>The owner of the product.</p>
1179
1278
  */
1180
1279
  Owner: string | undefined;
1181
1280
  /**
1281
+ * @public
1182
1282
  * <p>The description of the product.</p>
1183
1283
  */
1184
1284
  Description?: string;
1185
1285
  /**
1286
+ * @public
1186
1287
  * <p>The distributor of the product.</p>
1187
1288
  */
1188
1289
  Distributor?: string;
1189
1290
  /**
1291
+ * @public
1190
1292
  * <p>The support information about the product.</p>
1191
1293
  */
1192
1294
  SupportDescription?: string;
1193
1295
  /**
1296
+ * @public
1194
1297
  * <p>The contact email for product support.</p>
1195
1298
  */
1196
1299
  SupportEmail?: string;
1197
1300
  /**
1301
+ * @public
1198
1302
  * <p>The contact URL for product support.</p>
1199
1303
  * <p>
1200
1304
  * <code>^https?:\/\// </code>/ is the pattern used to validate SupportUrl.</p>
1201
1305
  */
1202
1306
  SupportUrl?: string;
1203
1307
  /**
1308
+ * @public
1204
1309
  * <p>The type of product.</p>
1205
1310
  */
1206
1311
  ProductType: ProductType | string | undefined;
1207
1312
  /**
1313
+ * @public
1208
1314
  * <p>One or more tags.</p>
1209
1315
  */
1210
1316
  Tags?: Tag[];
1211
1317
  /**
1318
+ * @public
1212
1319
  * <p>The configuration of the provisioning artifact. </p>
1213
1320
  */
1214
1321
  ProvisioningArtifactParameters?: ProvisioningArtifactProperties;
1215
1322
  /**
1323
+ * @public
1216
1324
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
1217
1325
  * the same response is returned for each repeated request.</p>
1218
1326
  */
1219
1327
  IdempotencyToken?: string;
1220
1328
  /**
1329
+ * @public
1221
1330
  * <p>Specifies connection details for the created product and syncs the product to the connection source
1222
1331
  * artifact. This automatically manages the product's artifacts based on changes to the source.
1223
1332
  * The <code>SourceConnection</code> parameter consists of the following sub-fields.</p>
@@ -1242,37 +1351,45 @@ export interface CreateProductInput {
1242
1351
  */
1243
1352
  export interface ProductViewSummary {
1244
1353
  /**
1354
+ * @public
1245
1355
  * <p>The product view identifier.</p>
1246
1356
  */
1247
1357
  Id?: string;
1248
1358
  /**
1359
+ * @public
1249
1360
  * <p>The product identifier.</p>
1250
1361
  */
1251
1362
  ProductId?: string;
1252
1363
  /**
1364
+ * @public
1253
1365
  * <p>The name of the product.</p>
1254
1366
  */
1255
1367
  Name?: string;
1256
1368
  /**
1369
+ * @public
1257
1370
  * <p>The owner of the product. Contact the product administrator for the significance of
1258
1371
  * this value.</p>
1259
1372
  */
1260
1373
  Owner?: string;
1261
1374
  /**
1375
+ * @public
1262
1376
  * <p>Short description of the product.</p>
1263
1377
  */
1264
1378
  ShortDescription?: string;
1265
1379
  /**
1380
+ * @public
1266
1381
  * <p>The product type. Contact the product administrator for the significance of this
1267
1382
  * value. If this value is <code>MARKETPLACE</code>, the product was created by Amazon Web Services Marketplace.</p>
1268
1383
  */
1269
1384
  Type?: ProductType | string;
1270
1385
  /**
1386
+ * @public
1271
1387
  * <p>The distributor of the product. Contact the product administrator for the
1272
1388
  * significance of this value.</p>
1273
1389
  */
1274
1390
  Distributor?: string;
1275
1391
  /**
1392
+ * @public
1276
1393
  * <p>Indicates whether the product has a default path.
1277
1394
  * If the product does not have a default path, call <a>ListLaunchPaths</a>
1278
1395
  * to disambiguate between paths. Otherwise, <a>ListLaunchPaths</a> is not
@@ -1281,14 +1398,17 @@ export interface ProductViewSummary {
1281
1398
  */
1282
1399
  HasDefaultPath?: boolean;
1283
1400
  /**
1401
+ * @public
1284
1402
  * <p>The email contact information to obtain support for this Product.</p>
1285
1403
  */
1286
1404
  SupportEmail?: string;
1287
1405
  /**
1406
+ * @public
1288
1407
  * <p>The description of the support for this Product.</p>
1289
1408
  */
1290
1409
  SupportDescription?: string;
1291
1410
  /**
1411
+ * @public
1292
1412
  * <p>The URL information to obtain support for this Product.</p>
1293
1413
  */
1294
1414
  SupportUrl?: string;
@@ -1338,22 +1458,27 @@ export type LastSyncStatus = (typeof LastSyncStatus)[keyof typeof LastSyncStatus
1338
1458
  */
1339
1459
  export interface LastSync {
1340
1460
  /**
1461
+ * @public
1341
1462
  * <p>The time of the last attempted sync from the repository to the Service Catalog product. </p>
1342
1463
  */
1343
1464
  LastSyncTime?: Date;
1344
1465
  /**
1466
+ * @public
1345
1467
  * <p>The current status of the sync. Responses include <code>SUCCEEDED</code> or <code>FAILED</code>. </p>
1346
1468
  */
1347
1469
  LastSyncStatus?: LastSyncStatus | string;
1348
1470
  /**
1471
+ * @public
1349
1472
  * <p>The sync's status message. </p>
1350
1473
  */
1351
1474
  LastSyncStatusMessage?: string;
1352
1475
  /**
1476
+ * @public
1353
1477
  * <p>The time of the latest successful sync from the source repo artifact to the Service Catalog product.</p>
1354
1478
  */
1355
1479
  LastSuccessfulSyncTime?: Date;
1356
1480
  /**
1481
+ * @public
1357
1482
  * <p>The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync. </p>
1358
1483
  */
1359
1484
  LastSuccessfulSyncProvisioningArtifactId?: string;
@@ -1364,14 +1489,17 @@ export interface LastSync {
1364
1489
  */
1365
1490
  export interface SourceConnectionDetail {
1366
1491
  /**
1492
+ * @public
1367
1493
  * <p>The only supported <code>SourceConnection</code> type is Codestar.</p>
1368
1494
  */
1369
1495
  Type?: SourceType | string;
1370
1496
  /**
1497
+ * @public
1371
1498
  * <p>The connection details based on the connection <code>Type</code>.</p>
1372
1499
  */
1373
1500
  ConnectionParameters?: SourceConnectionParameters;
1374
1501
  /**
1502
+ * @public
1375
1503
  * <p>Provides details about the product's connection sync and contains the following sub-fields. </p>
1376
1504
  * <ul>
1377
1505
  * <li>
@@ -1409,10 +1537,12 @@ export interface SourceConnectionDetail {
1409
1537
  */
1410
1538
  export interface ProductViewDetail {
1411
1539
  /**
1540
+ * @public
1412
1541
  * <p>Summary information about the product view.</p>
1413
1542
  */
1414
1543
  ProductViewSummary?: ProductViewSummary;
1415
1544
  /**
1545
+ * @public
1416
1546
  * <p>The status of the product.</p>
1417
1547
  * <ul>
1418
1548
  * <li>
@@ -1431,14 +1561,17 @@ export interface ProductViewDetail {
1431
1561
  */
1432
1562
  Status?: Status | string;
1433
1563
  /**
1564
+ * @public
1434
1565
  * <p>The ARN of the product.</p>
1435
1566
  */
1436
1567
  ProductARN?: string;
1437
1568
  /**
1569
+ * @public
1438
1570
  * <p>The UTC time stamp of the creation time.</p>
1439
1571
  */
1440
1572
  CreatedTime?: Date;
1441
1573
  /**
1574
+ * @public
1442
1575
  * <p>A top level <code>ProductViewDetail</code> response containing details about the product’s connection.
1443
1576
  * Service Catalog returns this field for the <code>CreateProduct</code>, <code>UpdateProduct</code>,
1444
1577
  * <code>DescribeProductAsAdmin</code>, and <code>SearchProductAsAdmin</code> APIs.
@@ -1465,18 +1598,22 @@ export type ProvisioningArtifactGuidance = (typeof ProvisioningArtifactGuidance)
1465
1598
  */
1466
1599
  export interface ProvisioningArtifactDetail {
1467
1600
  /**
1601
+ * @public
1468
1602
  * <p>The identifier of the provisioning artifact.</p>
1469
1603
  */
1470
1604
  Id?: string;
1471
1605
  /**
1606
+ * @public
1472
1607
  * <p>The name of the provisioning artifact.</p>
1473
1608
  */
1474
1609
  Name?: string;
1475
1610
  /**
1611
+ * @public
1476
1612
  * <p>The description of the provisioning artifact.</p>
1477
1613
  */
1478
1614
  Description?: string;
1479
1615
  /**
1616
+ * @public
1480
1617
  * <p>The type of provisioning artifact.</p>
1481
1618
  * <ul>
1482
1619
  * <li>
@@ -1495,18 +1632,22 @@ export interface ProvisioningArtifactDetail {
1495
1632
  */
1496
1633
  Type?: ProvisioningArtifactType | string;
1497
1634
  /**
1635
+ * @public
1498
1636
  * <p>The UTC time stamp of the creation time.</p>
1499
1637
  */
1500
1638
  CreatedTime?: Date;
1501
1639
  /**
1640
+ * @public
1502
1641
  * <p>Indicates whether the product version is active.</p>
1503
1642
  */
1504
1643
  Active?: boolean;
1505
1644
  /**
1645
+ * @public
1506
1646
  * <p>Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.</p>
1507
1647
  */
1508
1648
  Guidance?: ProvisioningArtifactGuidance | string;
1509
1649
  /**
1650
+ * @public
1510
1651
  * <p>Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product
1511
1652
  * and create the provisioning artifact. Service Catalog includes this response parameter as a high level
1512
1653
  * field to the existing <code>ProvisioningArtifactDetail</code> type, which is returned as part of the
@@ -1522,14 +1663,17 @@ export interface ProvisioningArtifactDetail {
1522
1663
  */
1523
1664
  export interface CreateProductOutput {
1524
1665
  /**
1666
+ * @public
1525
1667
  * <p>Information about the product view.</p>
1526
1668
  */
1527
1669
  ProductViewDetail?: ProductViewDetail;
1528
1670
  /**
1671
+ * @public
1529
1672
  * <p>Information about the provisioning artifact. </p>
1530
1673
  */
1531
1674
  ProvisioningArtifactDetail?: ProvisioningArtifactDetail;
1532
1675
  /**
1676
+ * @public
1533
1677
  * <p>Information about the tags associated with the product.</p>
1534
1678
  */
1535
1679
  Tags?: Tag[];
@@ -1551,14 +1695,17 @@ export type ProvisionedProductPlanType = (typeof ProvisionedProductPlanType)[key
1551
1695
  */
1552
1696
  export interface UpdateProvisioningParameter {
1553
1697
  /**
1698
+ * @public
1554
1699
  * <p>The parameter key.</p>
1555
1700
  */
1556
1701
  Key?: string;
1557
1702
  /**
1703
+ * @public
1558
1704
  * <p>The parameter value.</p>
1559
1705
  */
1560
1706
  Value?: string;
1561
1707
  /**
1708
+ * @public
1562
1709
  * <p>If set to true, <code>Value</code> is ignored and the previous parameter value is kept.</p>
1563
1710
  */
1564
1711
  UsePreviousValue?: boolean;
@@ -1568,6 +1715,7 @@ export interface UpdateProvisioningParameter {
1568
1715
  */
1569
1716
  export interface CreateProvisionedProductPlanInput {
1570
1717
  /**
1718
+ * @public
1571
1719
  * <p>The language code.</p>
1572
1720
  * <ul>
1573
1721
  * <li>
@@ -1582,48 +1730,58 @@ export interface CreateProvisionedProductPlanInput {
1582
1730
  */
1583
1731
  AcceptLanguage?: string;
1584
1732
  /**
1733
+ * @public
1585
1734
  * <p>The name of the plan.</p>
1586
1735
  */
1587
1736
  PlanName: string | undefined;
1588
1737
  /**
1738
+ * @public
1589
1739
  * <p>The plan type.</p>
1590
1740
  */
1591
1741
  PlanType: ProvisionedProductPlanType | string | undefined;
1592
1742
  /**
1743
+ * @public
1593
1744
  * <p>Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related
1594
1745
  * events.</p>
1595
1746
  */
1596
1747
  NotificationArns?: string[];
1597
1748
  /**
1749
+ * @public
1598
1750
  * <p>The path identifier of the product. This value is optional if the product
1599
1751
  * has a default path, and required if the product has more than one path.
1600
1752
  * To list the paths for a product, use <a>ListLaunchPaths</a>.</p>
1601
1753
  */
1602
1754
  PathId?: string;
1603
1755
  /**
1756
+ * @public
1604
1757
  * <p>The product identifier.</p>
1605
1758
  */
1606
1759
  ProductId: string | undefined;
1607
1760
  /**
1761
+ * @public
1608
1762
  * <p>A user-friendly name for the provisioned product. This value must be
1609
1763
  * unique for the Amazon Web Services account and cannot be updated after the product is provisioned.</p>
1610
1764
  */
1611
1765
  ProvisionedProductName: string | undefined;
1612
1766
  /**
1767
+ * @public
1613
1768
  * <p>The identifier of the provisioning artifact.</p>
1614
1769
  */
1615
1770
  ProvisioningArtifactId: string | undefined;
1616
1771
  /**
1772
+ * @public
1617
1773
  * <p>Parameters specified by the administrator that are required for provisioning the
1618
1774
  * product.</p>
1619
1775
  */
1620
1776
  ProvisioningParameters?: UpdateProvisioningParameter[];
1621
1777
  /**
1778
+ * @public
1622
1779
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
1623
1780
  * the same response is returned for each repeated request.</p>
1624
1781
  */
1625
1782
  IdempotencyToken?: string;
1626
1783
  /**
1784
+ * @public
1627
1785
  * <p>One or more tags.</p>
1628
1786
  * <p>If the plan is for an existing provisioned product, the product must have a <code>RESOURCE_UPDATE</code> constraint with <code>TagUpdatesOnProvisionedProduct</code> set to <code>ALLOWED</code> to allow tag updates.</p>
1629
1787
  */
@@ -1634,22 +1792,27 @@ export interface CreateProvisionedProductPlanInput {
1634
1792
  */
1635
1793
  export interface CreateProvisionedProductPlanOutput {
1636
1794
  /**
1795
+ * @public
1637
1796
  * <p>The name of the plan.</p>
1638
1797
  */
1639
1798
  PlanName?: string;
1640
1799
  /**
1800
+ * @public
1641
1801
  * <p>The plan identifier.</p>
1642
1802
  */
1643
1803
  PlanId?: string;
1644
1804
  /**
1805
+ * @public
1645
1806
  * <p>The product identifier.</p>
1646
1807
  */
1647
1808
  ProvisionProductId?: string;
1648
1809
  /**
1810
+ * @public
1649
1811
  * <p>The user-friendly name of the provisioned product.</p>
1650
1812
  */
1651
1813
  ProvisionedProductName?: string;
1652
1814
  /**
1815
+ * @public
1653
1816
  * <p>The identifier of the provisioning artifact.</p>
1654
1817
  */
1655
1818
  ProvisioningArtifactId?: string;
@@ -1659,6 +1822,7 @@ export interface CreateProvisionedProductPlanOutput {
1659
1822
  */
1660
1823
  export interface CreateProvisioningArtifactInput {
1661
1824
  /**
1825
+ * @public
1662
1826
  * <p>The language code.</p>
1663
1827
  * <ul>
1664
1828
  * <li>
@@ -1673,14 +1837,17 @@ export interface CreateProvisioningArtifactInput {
1673
1837
  */
1674
1838
  AcceptLanguage?: string;
1675
1839
  /**
1840
+ * @public
1676
1841
  * <p>The product identifier.</p>
1677
1842
  */
1678
1843
  ProductId: string | undefined;
1679
1844
  /**
1845
+ * @public
1680
1846
  * <p>The configuration for the provisioning artifact.</p>
1681
1847
  */
1682
1848
  Parameters: ProvisioningArtifactProperties | undefined;
1683
1849
  /**
1850
+ * @public
1684
1851
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
1685
1852
  * the same response is returned for each repeated request.</p>
1686
1853
  */
@@ -1691,10 +1858,12 @@ export interface CreateProvisioningArtifactInput {
1691
1858
  */
1692
1859
  export interface CreateProvisioningArtifactOutput {
1693
1860
  /**
1861
+ * @public
1694
1862
  * <p>Information about the provisioning artifact.</p>
1695
1863
  */
1696
1864
  ProvisioningArtifactDetail?: ProvisioningArtifactDetail;
1697
1865
  /**
1866
+ * @public
1698
1867
  * <p>Specify the template source with one of the following options, but not both. Keys
1699
1868
  * accepted: [ <code>LoadTemplateFromURL</code>, <code>ImportFromPhysicalId</code> ].</p>
1700
1869
  * <p>Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. </p>
@@ -1709,6 +1878,7 @@ export interface CreateProvisioningArtifactOutput {
1709
1878
  */
1710
1879
  Info?: Record<string, string>;
1711
1880
  /**
1881
+ * @public
1712
1882
  * <p>The status of the current request.</p>
1713
1883
  */
1714
1884
  Status?: Status | string;
@@ -1743,14 +1913,17 @@ export type ServiceActionDefinitionType = (typeof ServiceActionDefinitionType)[k
1743
1913
  */
1744
1914
  export interface CreateServiceActionInput {
1745
1915
  /**
1916
+ * @public
1746
1917
  * <p>The self-service action name.</p>
1747
1918
  */
1748
1919
  Name: string | undefined;
1749
1920
  /**
1921
+ * @public
1750
1922
  * <p>The service action definition type. For example, <code>SSM_AUTOMATION</code>.</p>
1751
1923
  */
1752
1924
  DefinitionType: ServiceActionDefinitionType | string | undefined;
1753
1925
  /**
1926
+ * @public
1754
1927
  * <p>The self-service action definition. Can be one of the following:</p>
1755
1928
  * <dl>
1756
1929
  * <dt>Name</dt>
@@ -1777,10 +1950,12 @@ export interface CreateServiceActionInput {
1777
1950
  */
1778
1951
  Definition: Record<string, string> | undefined;
1779
1952
  /**
1953
+ * @public
1780
1954
  * <p>The self-service action description.</p>
1781
1955
  */
1782
1956
  Description?: string;
1783
1957
  /**
1958
+ * @public
1784
1959
  * <p>The language code.</p>
1785
1960
  * <ul>
1786
1961
  * <li>
@@ -1795,6 +1970,7 @@ export interface CreateServiceActionInput {
1795
1970
  */
1796
1971
  AcceptLanguage?: string;
1797
1972
  /**
1973
+ * @public
1798
1974
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
1799
1975
  * the same response is returned for each repeated request.</p>
1800
1976
  */
@@ -1806,18 +1982,22 @@ export interface CreateServiceActionInput {
1806
1982
  */
1807
1983
  export interface ServiceActionSummary {
1808
1984
  /**
1985
+ * @public
1809
1986
  * <p>The self-service action identifier.</p>
1810
1987
  */
1811
1988
  Id?: string;
1812
1989
  /**
1990
+ * @public
1813
1991
  * <p>The self-service action name.</p>
1814
1992
  */
1815
1993
  Name?: string;
1816
1994
  /**
1995
+ * @public
1817
1996
  * <p>The self-service action description.</p>
1818
1997
  */
1819
1998
  Description?: string;
1820
1999
  /**
2000
+ * @public
1821
2001
  * <p>The self-service action definition type. For example, <code>SSM_AUTOMATION</code>.</p>
1822
2002
  */
1823
2003
  DefinitionType?: ServiceActionDefinitionType | string;
@@ -1828,10 +2008,12 @@ export interface ServiceActionSummary {
1828
2008
  */
1829
2009
  export interface ServiceActionDetail {
1830
2010
  /**
2011
+ * @public
1831
2012
  * <p>Summary information about the self-service action.</p>
1832
2013
  */
1833
2014
  ServiceActionSummary?: ServiceActionSummary;
1834
2015
  /**
2016
+ * @public
1835
2017
  * <p>A map that defines the self-service action.</p>
1836
2018
  */
1837
2019
  Definition?: Record<string, string>;
@@ -1841,6 +2023,7 @@ export interface ServiceActionDetail {
1841
2023
  */
1842
2024
  export interface CreateServiceActionOutput {
1843
2025
  /**
2026
+ * @public
1844
2027
  * <p>An object containing information about the self-service action.</p>
1845
2028
  */
1846
2029
  ServiceActionDetail?: ServiceActionDetail;
@@ -1850,10 +2033,12 @@ export interface CreateServiceActionOutput {
1850
2033
  */
1851
2034
  export interface CreateTagOptionInput {
1852
2035
  /**
2036
+ * @public
1853
2037
  * <p>The TagOption key.</p>
1854
2038
  */
1855
2039
  Key: string | undefined;
1856
2040
  /**
2041
+ * @public
1857
2042
  * <p>The TagOption value.</p>
1858
2043
  */
1859
2044
  Value: string | undefined;
@@ -1864,22 +2049,27 @@ export interface CreateTagOptionInput {
1864
2049
  */
1865
2050
  export interface TagOptionDetail {
1866
2051
  /**
2052
+ * @public
1867
2053
  * <p>The TagOption key.</p>
1868
2054
  */
1869
2055
  Key?: string;
1870
2056
  /**
2057
+ * @public
1871
2058
  * <p>The TagOption value.</p>
1872
2059
  */
1873
2060
  Value?: string;
1874
2061
  /**
2062
+ * @public
1875
2063
  * <p>The TagOption active state.</p>
1876
2064
  */
1877
2065
  Active?: boolean;
1878
2066
  /**
2067
+ * @public
1879
2068
  * <p>The TagOption identifier.</p>
1880
2069
  */
1881
2070
  Id?: string;
1882
2071
  /**
2072
+ * @public
1883
2073
  * <p>The Amazon Web Services account Id of the owner account that created the TagOption.</p>
1884
2074
  */
1885
2075
  Owner?: string;
@@ -1889,6 +2079,7 @@ export interface TagOptionDetail {
1889
2079
  */
1890
2080
  export interface CreateTagOptionOutput {
1891
2081
  /**
2082
+ * @public
1892
2083
  * <p>Information about the TagOption.</p>
1893
2084
  */
1894
2085
  TagOptionDetail?: TagOptionDetail;
@@ -1898,6 +2089,7 @@ export interface CreateTagOptionOutput {
1898
2089
  */
1899
2090
  export interface DeleteConstraintInput {
1900
2091
  /**
2092
+ * @public
1901
2093
  * <p>The language code.</p>
1902
2094
  * <ul>
1903
2095
  * <li>
@@ -1912,6 +2104,7 @@ export interface DeleteConstraintInput {
1912
2104
  */
1913
2105
  AcceptLanguage?: string;
1914
2106
  /**
2107
+ * @public
1915
2108
  * <p>The identifier of the constraint.</p>
1916
2109
  */
1917
2110
  Id: string | undefined;
@@ -1926,6 +2119,7 @@ export interface DeleteConstraintOutput {
1926
2119
  */
1927
2120
  export interface DeletePortfolioInput {
1928
2121
  /**
2122
+ * @public
1929
2123
  * <p>The language code.</p>
1930
2124
  * <ul>
1931
2125
  * <li>
@@ -1940,6 +2134,7 @@ export interface DeletePortfolioInput {
1940
2134
  */
1941
2135
  AcceptLanguage?: string;
1942
2136
  /**
2137
+ * @public
1943
2138
  * <p>The portfolio identifier.</p>
1944
2139
  */
1945
2140
  Id: string | undefined;
@@ -1967,6 +2162,7 @@ export declare class ResourceInUseException extends __BaseException {
1967
2162
  */
1968
2163
  export interface DeletePortfolioShareInput {
1969
2164
  /**
2165
+ * @public
1970
2166
  * <p>The language code.</p>
1971
2167
  * <ul>
1972
2168
  * <li>
@@ -1981,14 +2177,17 @@ export interface DeletePortfolioShareInput {
1981
2177
  */
1982
2178
  AcceptLanguage?: string;
1983
2179
  /**
2180
+ * @public
1984
2181
  * <p>The portfolio identifier.</p>
1985
2182
  */
1986
2183
  PortfolioId: string | undefined;
1987
2184
  /**
2185
+ * @public
1988
2186
  * <p>The Amazon Web Services account ID.</p>
1989
2187
  */
1990
2188
  AccountId?: string;
1991
2189
  /**
2190
+ * @public
1992
2191
  * <p>The organization node to whom you are going to stop sharing.</p>
1993
2192
  */
1994
2193
  OrganizationNode?: OrganizationNode;
@@ -1998,6 +2197,7 @@ export interface DeletePortfolioShareInput {
1998
2197
  */
1999
2198
  export interface DeletePortfolioShareOutput {
2000
2199
  /**
2200
+ * @public
2001
2201
  * <p>The portfolio share unique identifier. This will only be returned if delete is made to an organization node.</p>
2002
2202
  */
2003
2203
  PortfolioShareToken?: string;
@@ -2007,6 +2207,7 @@ export interface DeletePortfolioShareOutput {
2007
2207
  */
2008
2208
  export interface DeleteProductInput {
2009
2209
  /**
2210
+ * @public
2010
2211
  * <p>The language code.</p>
2011
2212
  * <ul>
2012
2213
  * <li>
@@ -2021,6 +2222,7 @@ export interface DeleteProductInput {
2021
2222
  */
2022
2223
  AcceptLanguage?: string;
2023
2224
  /**
2225
+ * @public
2024
2226
  * <p>The product identifier.</p>
2025
2227
  */
2026
2228
  Id: string | undefined;
@@ -2035,6 +2237,7 @@ export interface DeleteProductOutput {
2035
2237
  */
2036
2238
  export interface DeleteProvisionedProductPlanInput {
2037
2239
  /**
2240
+ * @public
2038
2241
  * <p>The language code.</p>
2039
2242
  * <ul>
2040
2243
  * <li>
@@ -2049,10 +2252,12 @@ export interface DeleteProvisionedProductPlanInput {
2049
2252
  */
2050
2253
  AcceptLanguage?: string;
2051
2254
  /**
2255
+ * @public
2052
2256
  * <p>The plan identifier.</p>
2053
2257
  */
2054
2258
  PlanId: string | undefined;
2055
2259
  /**
2260
+ * @public
2056
2261
  * <p>If set to true, Service Catalog stops managing the specified provisioned product even
2057
2262
  * if it cannot delete the underlying resources.</p>
2058
2263
  */
@@ -2068,6 +2273,7 @@ export interface DeleteProvisionedProductPlanOutput {
2068
2273
  */
2069
2274
  export interface DeleteProvisioningArtifactInput {
2070
2275
  /**
2276
+ * @public
2071
2277
  * <p>The language code.</p>
2072
2278
  * <ul>
2073
2279
  * <li>
@@ -2082,10 +2288,12 @@ export interface DeleteProvisioningArtifactInput {
2082
2288
  */
2083
2289
  AcceptLanguage?: string;
2084
2290
  /**
2291
+ * @public
2085
2292
  * <p>The product identifier.</p>
2086
2293
  */
2087
2294
  ProductId: string | undefined;
2088
2295
  /**
2296
+ * @public
2089
2297
  * <p>The identifier of the provisioning artifact.</p>
2090
2298
  */
2091
2299
  ProvisioningArtifactId: string | undefined;
@@ -2100,10 +2308,12 @@ export interface DeleteProvisioningArtifactOutput {
2100
2308
  */
2101
2309
  export interface DeleteServiceActionInput {
2102
2310
  /**
2311
+ * @public
2103
2312
  * <p>The self-service action identifier. For example, <code>act-fs7abcd89wxyz</code>.</p>
2104
2313
  */
2105
2314
  Id: string | undefined;
2106
2315
  /**
2316
+ * @public
2107
2317
  * <p>The language code.</p>
2108
2318
  * <ul>
2109
2319
  * <li>
@@ -2128,6 +2338,7 @@ export interface DeleteServiceActionOutput {
2128
2338
  */
2129
2339
  export interface DeleteTagOptionInput {
2130
2340
  /**
2341
+ * @public
2131
2342
  * <p>The TagOption identifier.</p>
2132
2343
  */
2133
2344
  Id: string | undefined;
@@ -2142,6 +2353,7 @@ export interface DeleteTagOptionOutput {
2142
2353
  */
2143
2354
  export interface DescribeConstraintInput {
2144
2355
  /**
2356
+ * @public
2145
2357
  * <p>The language code.</p>
2146
2358
  * <ul>
2147
2359
  * <li>
@@ -2156,6 +2368,7 @@ export interface DescribeConstraintInput {
2156
2368
  */
2157
2369
  AcceptLanguage?: string;
2158
2370
  /**
2371
+ * @public
2159
2372
  * <p>The identifier of the constraint.</p>
2160
2373
  */
2161
2374
  Id: string | undefined;
@@ -2165,14 +2378,17 @@ export interface DescribeConstraintInput {
2165
2378
  */
2166
2379
  export interface DescribeConstraintOutput {
2167
2380
  /**
2381
+ * @public
2168
2382
  * <p>Information about the constraint.</p>
2169
2383
  */
2170
2384
  ConstraintDetail?: ConstraintDetail;
2171
2385
  /**
2386
+ * @public
2172
2387
  * <p>The constraint parameters.</p>
2173
2388
  */
2174
2389
  ConstraintParameters?: string;
2175
2390
  /**
2391
+ * @public
2176
2392
  * <p>The status of the current request.</p>
2177
2393
  */
2178
2394
  Status?: Status | string;
@@ -2182,6 +2398,7 @@ export interface DescribeConstraintOutput {
2182
2398
  */
2183
2399
  export interface DescribeCopyProductStatusInput {
2184
2400
  /**
2401
+ * @public
2185
2402
  * <p>The language code.</p>
2186
2403
  * <ul>
2187
2404
  * <li>
@@ -2196,6 +2413,7 @@ export interface DescribeCopyProductStatusInput {
2196
2413
  */
2197
2414
  AcceptLanguage?: string;
2198
2415
  /**
2416
+ * @public
2199
2417
  * <p>The token for the copy product operation. This token is returned by <a>CopyProduct</a>.</p>
2200
2418
  */
2201
2419
  CopyProductToken: string | undefined;
@@ -2218,14 +2436,17 @@ export type CopyProductStatus = (typeof CopyProductStatus)[keyof typeof CopyProd
2218
2436
  */
2219
2437
  export interface DescribeCopyProductStatusOutput {
2220
2438
  /**
2439
+ * @public
2221
2440
  * <p>The status of the copy product operation.</p>
2222
2441
  */
2223
2442
  CopyProductStatus?: CopyProductStatus | string;
2224
2443
  /**
2444
+ * @public
2225
2445
  * <p>The identifier of the copied product.</p>
2226
2446
  */
2227
2447
  TargetProductId?: string;
2228
2448
  /**
2449
+ * @public
2229
2450
  * <p>The status message.</p>
2230
2451
  */
2231
2452
  StatusDetail?: string;
@@ -2235,6 +2456,7 @@ export interface DescribeCopyProductStatusOutput {
2235
2456
  */
2236
2457
  export interface DescribePortfolioInput {
2237
2458
  /**
2459
+ * @public
2238
2460
  * <p>The language code.</p>
2239
2461
  * <ul>
2240
2462
  * <li>
@@ -2249,6 +2471,7 @@ export interface DescribePortfolioInput {
2249
2471
  */
2250
2472
  AcceptLanguage?: string;
2251
2473
  /**
2474
+ * @public
2252
2475
  * <p>The portfolio identifier.</p>
2253
2476
  */
2254
2477
  Id: string | undefined;
@@ -2259,6 +2482,7 @@ export interface DescribePortfolioInput {
2259
2482
  */
2260
2483
  export interface BudgetDetail {
2261
2484
  /**
2485
+ * @public
2262
2486
  * <p>Name of the associated budget.</p>
2263
2487
  */
2264
2488
  BudgetName?: string;
@@ -2268,18 +2492,22 @@ export interface BudgetDetail {
2268
2492
  */
2269
2493
  export interface DescribePortfolioOutput {
2270
2494
  /**
2495
+ * @public
2271
2496
  * <p>Information about the portfolio.</p>
2272
2497
  */
2273
2498
  PortfolioDetail?: PortfolioDetail;
2274
2499
  /**
2500
+ * @public
2275
2501
  * <p>Information about the tags associated with the portfolio.</p>
2276
2502
  */
2277
2503
  Tags?: Tag[];
2278
2504
  /**
2505
+ * @public
2279
2506
  * <p>Information about the TagOptions associated with the portfolio.</p>
2280
2507
  */
2281
2508
  TagOptions?: TagOptionDetail[];
2282
2509
  /**
2510
+ * @public
2283
2511
  * <p>Information about the associated budgets.</p>
2284
2512
  */
2285
2513
  Budgets?: BudgetDetail[];
@@ -2303,10 +2531,12 @@ export type DescribePortfolioShareType = (typeof DescribePortfolioShareType)[key
2303
2531
  */
2304
2532
  export interface DescribePortfolioSharesInput {
2305
2533
  /**
2534
+ * @public
2306
2535
  * <p>The unique identifier of the portfolio for which shares will be retrieved.</p>
2307
2536
  */
2308
2537
  PortfolioId: string | undefined;
2309
2538
  /**
2539
+ * @public
2310
2540
  * <p>The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:</p>
2311
2541
  * <p>1. <code>ACCOUNT</code> - Represents an external account to account share.</p>
2312
2542
  * <p>2. <code>ORGANIZATION</code> - Represents a share to an organization. This share is available to every account in the organization.</p>
@@ -2315,10 +2545,12 @@ export interface DescribePortfolioSharesInput {
2315
2545
  */
2316
2546
  Type: DescribePortfolioShareType | string | undefined;
2317
2547
  /**
2548
+ * @public
2318
2549
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
2319
2550
  */
2320
2551
  PageToken?: string;
2321
2552
  /**
2553
+ * @public
2322
2554
  * <p>The maximum number of items to return with this call.</p>
2323
2555
  */
2324
2556
  PageSize?: number;
@@ -2329,6 +2561,7 @@ export interface DescribePortfolioSharesInput {
2329
2561
  */
2330
2562
  export interface PortfolioShareDetail {
2331
2563
  /**
2564
+ * @public
2332
2565
  * <p>The identifier of the recipient entity that received the portfolio share.
2333
2566
  * The recipient entity can be one of the following:</p>
2334
2567
  * <p>1. An external account.</p>
@@ -2338,18 +2571,22 @@ export interface PortfolioShareDetail {
2338
2571
  */
2339
2572
  PrincipalId?: string;
2340
2573
  /**
2574
+ * @public
2341
2575
  * <p>The type of the portfolio share.</p>
2342
2576
  */
2343
2577
  Type?: DescribePortfolioShareType | string;
2344
2578
  /**
2579
+ * @public
2345
2580
  * <p>Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.</p>
2346
2581
  */
2347
2582
  Accepted?: boolean;
2348
2583
  /**
2584
+ * @public
2349
2585
  * <p>Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.</p>
2350
2586
  */
2351
2587
  ShareTagOptions?: boolean;
2352
2588
  /**
2589
+ * @public
2353
2590
  * <p>Indicates if <code>Principal</code> sharing is enabled or disabled for the portfolio share. </p>
2354
2591
  */
2355
2592
  SharePrincipals?: boolean;
@@ -2359,10 +2596,12 @@ export interface PortfolioShareDetail {
2359
2596
  */
2360
2597
  export interface DescribePortfolioSharesOutput {
2361
2598
  /**
2599
+ * @public
2362
2600
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
2363
2601
  */
2364
2602
  NextPageToken?: string;
2365
2603
  /**
2604
+ * @public
2366
2605
  * <p>Summaries about each of the portfolio shares.</p>
2367
2606
  */
2368
2607
  PortfolioShareDetails?: PortfolioShareDetail[];
@@ -2372,6 +2611,7 @@ export interface DescribePortfolioSharesOutput {
2372
2611
  */
2373
2612
  export interface DescribePortfolioShareStatusInput {
2374
2613
  /**
2614
+ * @public
2375
2615
  * <p>The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.</p>
2376
2616
  */
2377
2617
  PortfolioShareToken: string | undefined;
@@ -2382,14 +2622,17 @@ export interface DescribePortfolioShareStatusInput {
2382
2622
  */
2383
2623
  export interface ShareError {
2384
2624
  /**
2625
+ * @public
2385
2626
  * <p>List of accounts impacted by the error.</p>
2386
2627
  */
2387
2628
  Accounts?: string[];
2388
2629
  /**
2630
+ * @public
2389
2631
  * <p>Information about the error.</p>
2390
2632
  */
2391
2633
  Message?: string;
2392
2634
  /**
2635
+ * @public
2393
2636
  * <p>Error type that happened when processing the operation.</p>
2394
2637
  */
2395
2638
  Error?: string;
@@ -2400,10 +2643,12 @@ export interface ShareError {
2400
2643
  */
2401
2644
  export interface ShareDetails {
2402
2645
  /**
2646
+ * @public
2403
2647
  * <p>List of accounts for whom the operation succeeded.</p>
2404
2648
  */
2405
2649
  SuccessfulShares?: string[];
2406
2650
  /**
2651
+ * @public
2407
2652
  * <p>List of errors.</p>
2408
2653
  */
2409
2654
  ShareErrors?: ShareError[];
@@ -2428,22 +2673,27 @@ export type ShareStatus = (typeof ShareStatus)[keyof typeof ShareStatus];
2428
2673
  */
2429
2674
  export interface DescribePortfolioShareStatusOutput {
2430
2675
  /**
2676
+ * @public
2431
2677
  * <p>The token for the portfolio share operation. For example, <code>share-6v24abcdefghi</code>.</p>
2432
2678
  */
2433
2679
  PortfolioShareToken?: string;
2434
2680
  /**
2681
+ * @public
2435
2682
  * <p>The portfolio identifier.</p>
2436
2683
  */
2437
2684
  PortfolioId?: string;
2438
2685
  /**
2686
+ * @public
2439
2687
  * <p>Organization node identifier. It can be either account id, organizational unit id or organization id.</p>
2440
2688
  */
2441
2689
  OrganizationNodeValue?: string;
2442
2690
  /**
2691
+ * @public
2443
2692
  * <p>Status of the portfolio share operation.</p>
2444
2693
  */
2445
2694
  Status?: ShareStatus | string;
2446
2695
  /**
2696
+ * @public
2447
2697
  * <p>Information about the portfolio share operation.</p>
2448
2698
  */
2449
2699
  ShareDetails?: ShareDetails;
@@ -2453,6 +2703,7 @@ export interface DescribePortfolioShareStatusOutput {
2453
2703
  */
2454
2704
  export interface DescribeProductInput {
2455
2705
  /**
2706
+ * @public
2456
2707
  * <p>The language code.</p>
2457
2708
  * <ul>
2458
2709
  * <li>
@@ -2467,10 +2718,12 @@ export interface DescribeProductInput {
2467
2718
  */
2468
2719
  AcceptLanguage?: string;
2469
2720
  /**
2721
+ * @public
2470
2722
  * <p>The product identifier.</p>
2471
2723
  */
2472
2724
  Id?: string;
2473
2725
  /**
2726
+ * @public
2474
2727
  * <p>The product name.</p>
2475
2728
  */
2476
2729
  Name?: string;
@@ -2481,10 +2734,12 @@ export interface DescribeProductInput {
2481
2734
  */
2482
2735
  export interface LaunchPath {
2483
2736
  /**
2737
+ * @public
2484
2738
  * <p>The identifier of the launch path.</p>
2485
2739
  */
2486
2740
  Id?: string;
2487
2741
  /**
2742
+ * @public
2488
2743
  * <p>The name of the launch path.</p>
2489
2744
  */
2490
2745
  Name?: string;
@@ -2495,22 +2750,27 @@ export interface LaunchPath {
2495
2750
  */
2496
2751
  export interface ProvisioningArtifact {
2497
2752
  /**
2753
+ * @public
2498
2754
  * <p>The identifier of the provisioning artifact.</p>
2499
2755
  */
2500
2756
  Id?: string;
2501
2757
  /**
2758
+ * @public
2502
2759
  * <p>The name of the provisioning artifact.</p>
2503
2760
  */
2504
2761
  Name?: string;
2505
2762
  /**
2763
+ * @public
2506
2764
  * <p>The description of the provisioning artifact.</p>
2507
2765
  */
2508
2766
  Description?: string;
2509
2767
  /**
2768
+ * @public
2510
2769
  * <p>The UTC time stamp of the creation time.</p>
2511
2770
  */
2512
2771
  CreatedTime?: Date;
2513
2772
  /**
2773
+ * @public
2514
2774
  * <p>Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.</p>
2515
2775
  */
2516
2776
  Guidance?: ProvisioningArtifactGuidance | string;
@@ -2520,18 +2780,22 @@ export interface ProvisioningArtifact {
2520
2780
  */
2521
2781
  export interface DescribeProductOutput {
2522
2782
  /**
2783
+ * @public
2523
2784
  * <p>Summary information about the product view.</p>
2524
2785
  */
2525
2786
  ProductViewSummary?: ProductViewSummary;
2526
2787
  /**
2788
+ * @public
2527
2789
  * <p>Information about the provisioning artifacts for the specified product.</p>
2528
2790
  */
2529
2791
  ProvisioningArtifacts?: ProvisioningArtifact[];
2530
2792
  /**
2793
+ * @public
2531
2794
  * <p>Information about the associated budgets.</p>
2532
2795
  */
2533
2796
  Budgets?: BudgetDetail[];
2534
2797
  /**
2798
+ * @public
2535
2799
  * <p>Information about the associated launch paths.</p>
2536
2800
  */
2537
2801
  LaunchPaths?: LaunchPath[];
@@ -2541,6 +2805,7 @@ export interface DescribeProductOutput {
2541
2805
  */
2542
2806
  export interface DescribeProductAsAdminInput {
2543
2807
  /**
2808
+ * @public
2544
2809
  * <p>The language code.</p>
2545
2810
  * <ul>
2546
2811
  * <li>
@@ -2555,14 +2820,17 @@ export interface DescribeProductAsAdminInput {
2555
2820
  */
2556
2821
  AcceptLanguage?: string;
2557
2822
  /**
2823
+ * @public
2558
2824
  * <p>The product identifier.</p>
2559
2825
  */
2560
2826
  Id?: string;
2561
2827
  /**
2828
+ * @public
2562
2829
  * <p>The product name.</p>
2563
2830
  */
2564
2831
  Name?: string;
2565
2832
  /**
2833
+ * @public
2566
2834
  * <p>The unique identifier of the shared portfolio that the specified product is associated
2567
2835
  * with.</p>
2568
2836
  * <p>You can provide this parameter to retrieve the shared TagOptions associated with the
@@ -2578,22 +2846,27 @@ export interface DescribeProductAsAdminInput {
2578
2846
  */
2579
2847
  export interface ProvisioningArtifactSummary {
2580
2848
  /**
2849
+ * @public
2581
2850
  * <p>The identifier of the provisioning artifact.</p>
2582
2851
  */
2583
2852
  Id?: string;
2584
2853
  /**
2854
+ * @public
2585
2855
  * <p>The name of the provisioning artifact.</p>
2586
2856
  */
2587
2857
  Name?: string;
2588
2858
  /**
2859
+ * @public
2589
2860
  * <p>The description of the provisioning artifact.</p>
2590
2861
  */
2591
2862
  Description?: string;
2592
2863
  /**
2864
+ * @public
2593
2865
  * <p>The UTC time stamp of the creation time.</p>
2594
2866
  */
2595
2867
  CreatedTime?: Date;
2596
2868
  /**
2869
+ * @public
2597
2870
  * <p>The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.</p>
2598
2871
  */
2599
2872
  ProvisioningArtifactMetadata?: Record<string, string>;
@@ -2603,22 +2876,27 @@ export interface ProvisioningArtifactSummary {
2603
2876
  */
2604
2877
  export interface DescribeProductAsAdminOutput {
2605
2878
  /**
2879
+ * @public
2606
2880
  * <p>Information about the product view.</p>
2607
2881
  */
2608
2882
  ProductViewDetail?: ProductViewDetail;
2609
2883
  /**
2884
+ * @public
2610
2885
  * <p>Information about the provisioning artifacts (also known as versions) for the specified product.</p>
2611
2886
  */
2612
2887
  ProvisioningArtifactSummaries?: ProvisioningArtifactSummary[];
2613
2888
  /**
2889
+ * @public
2614
2890
  * <p>Information about the tags associated with the product.</p>
2615
2891
  */
2616
2892
  Tags?: Tag[];
2617
2893
  /**
2894
+ * @public
2618
2895
  * <p>Information about the TagOptions associated with the product.</p>
2619
2896
  */
2620
2897
  TagOptions?: TagOptionDetail[];
2621
2898
  /**
2899
+ * @public
2622
2900
  * <p>Information about the associated budgets.</p>
2623
2901
  */
2624
2902
  Budgets?: BudgetDetail[];
@@ -2628,6 +2906,7 @@ export interface DescribeProductAsAdminOutput {
2628
2906
  */
2629
2907
  export interface DescribeProductViewInput {
2630
2908
  /**
2909
+ * @public
2631
2910
  * <p>The language code.</p>
2632
2911
  * <ul>
2633
2912
  * <li>
@@ -2642,6 +2921,7 @@ export interface DescribeProductViewInput {
2642
2921
  */
2643
2922
  AcceptLanguage?: string;
2644
2923
  /**
2924
+ * @public
2645
2925
  * <p>The product view identifier.</p>
2646
2926
  */
2647
2927
  Id: string | undefined;
@@ -2651,10 +2931,12 @@ export interface DescribeProductViewInput {
2651
2931
  */
2652
2932
  export interface DescribeProductViewOutput {
2653
2933
  /**
2934
+ * @public
2654
2935
  * <p>Summary information about the product.</p>
2655
2936
  */
2656
2937
  ProductViewSummary?: ProductViewSummary;
2657
2938
  /**
2939
+ * @public
2658
2940
  * <p>Information about the provisioning artifacts for the product.</p>
2659
2941
  */
2660
2942
  ProvisioningArtifacts?: ProvisioningArtifact[];
@@ -2674,6 +2956,7 @@ export interface DescribeProductViewOutput {
2674
2956
  */
2675
2957
  export interface DescribeProvisionedProductInput {
2676
2958
  /**
2959
+ * @public
2677
2960
  * <p>The language code.</p>
2678
2961
  * <ul>
2679
2962
  * <li>
@@ -2688,11 +2971,13 @@ export interface DescribeProvisionedProductInput {
2688
2971
  */
2689
2972
  AcceptLanguage?: string;
2690
2973
  /**
2974
+ * @public
2691
2975
  * <p>The provisioned product identifier. You must provide the name or ID, but not both.</p>
2692
2976
  * <p>If you do not provide a name or ID, or you provide both name and ID, an <code>InvalidParametersException</code> will occur.</p>
2693
2977
  */
2694
2978
  Id?: string;
2695
2979
  /**
2980
+ * @public
2696
2981
  * <p>The name of the provisioned product. You must provide the name or ID, but not both.</p>
2697
2982
  * <p>If you do not provide a name or ID, or you provide both name and ID, an <code>InvalidParametersException</code> will occur.</p>
2698
2983
  */
@@ -2704,6 +2989,7 @@ export interface DescribeProvisionedProductInput {
2704
2989
  */
2705
2990
  export interface CloudWatchDashboard {
2706
2991
  /**
2992
+ * @public
2707
2993
  * <p>The name of the CloudWatch dashboard.</p>
2708
2994
  */
2709
2995
  Name?: string;
@@ -2729,22 +3015,27 @@ export type ProvisionedProductStatus = (typeof ProvisionedProductStatus)[keyof t
2729
3015
  */
2730
3016
  export interface ProvisionedProductDetail {
2731
3017
  /**
3018
+ * @public
2732
3019
  * <p>The user-friendly name of the provisioned product.</p>
2733
3020
  */
2734
3021
  Name?: string;
2735
3022
  /**
3023
+ * @public
2736
3024
  * <p>The ARN of the provisioned product.</p>
2737
3025
  */
2738
3026
  Arn?: string;
2739
3027
  /**
3028
+ * @public
2740
3029
  * <p>The type of provisioned product. The supported values are <code>CFN_STACK</code> and <code>CFN_STACKSET</code>.</p>
2741
3030
  */
2742
3031
  Type?: string;
2743
3032
  /**
3033
+ * @public
2744
3034
  * <p>The identifier of the provisioned product.</p>
2745
3035
  */
2746
3036
  Id?: string;
2747
3037
  /**
3038
+ * @public
2748
3039
  * <p>The current status of the provisioned product.</p>
2749
3040
  * <ul>
2750
3041
  * <li>
@@ -2777,23 +3068,28 @@ export interface ProvisionedProductDetail {
2777
3068
  */
2778
3069
  Status?: ProvisionedProductStatus | string;
2779
3070
  /**
3071
+ * @public
2780
3072
  * <p>The current status message of the provisioned product.</p>
2781
3073
  */
2782
3074
  StatusMessage?: string;
2783
3075
  /**
3076
+ * @public
2784
3077
  * <p>The UTC time stamp of the creation time.</p>
2785
3078
  */
2786
3079
  CreatedTime?: Date;
2787
3080
  /**
3081
+ * @public
2788
3082
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
2789
3083
  * the same response is returned for each repeated request.</p>
2790
3084
  */
2791
3085
  IdempotencyToken?: string;
2792
3086
  /**
3087
+ * @public
2793
3088
  * <p>The record identifier of the last request performed on this provisioned product.</p>
2794
3089
  */
2795
3090
  LastRecordId?: string;
2796
3091
  /**
3092
+ * @public
2797
3093
  * <p>The record identifier of the last request performed on this provisioned product of the following types:</p>
2798
3094
  * <ul>
2799
3095
  * <li>
@@ -2820,6 +3116,7 @@ export interface ProvisionedProductDetail {
2820
3116
  */
2821
3117
  LastProvisioningRecordId?: string;
2822
3118
  /**
3119
+ * @public
2823
3120
  * <p>The record identifier of the last successful request performed on this provisioned product of the following types:</p>
2824
3121
  * <ul>
2825
3122
  * <li>
@@ -2846,14 +3143,17 @@ export interface ProvisionedProductDetail {
2846
3143
  */
2847
3144
  LastSuccessfulProvisioningRecordId?: string;
2848
3145
  /**
3146
+ * @public
2849
3147
  * <p>The product identifier. For example, <code>prod-abcdzk7xy33qa</code>.</p>
2850
3148
  */
2851
3149
  ProductId?: string;
2852
3150
  /**
3151
+ * @public
2853
3152
  * <p>The identifier of the provisioning artifact. For example, <code>pa-4abcdjnxjj6ne</code>.</p>
2854
3153
  */
2855
3154
  ProvisioningArtifactId?: string;
2856
3155
  /**
3156
+ * @public
2857
3157
  * <p>The ARN of the launch role associated with the provisioned product.</p>
2858
3158
  */
2859
3159
  LaunchRoleArn?: string;
@@ -2863,10 +3163,12 @@ export interface ProvisionedProductDetail {
2863
3163
  */
2864
3164
  export interface DescribeProvisionedProductOutput {
2865
3165
  /**
3166
+ * @public
2866
3167
  * <p>Information about the provisioned product.</p>
2867
3168
  */
2868
3169
  ProvisionedProductDetail?: ProvisionedProductDetail;
2869
3170
  /**
3171
+ * @public
2870
3172
  * <p>Any CloudWatch dashboards that were created when provisioning the product.</p>
2871
3173
  */
2872
3174
  CloudWatchDashboards?: CloudWatchDashboard[];
@@ -2876,6 +3178,7 @@ export interface DescribeProvisionedProductOutput {
2876
3178
  */
2877
3179
  export interface DescribeProvisionedProductPlanInput {
2878
3180
  /**
3181
+ * @public
2879
3182
  * <p>The language code.</p>
2880
3183
  * <ul>
2881
3184
  * <li>
@@ -2890,14 +3193,17 @@ export interface DescribeProvisionedProductPlanInput {
2890
3193
  */
2891
3194
  AcceptLanguage?: string;
2892
3195
  /**
3196
+ * @public
2893
3197
  * <p>The plan identifier.</p>
2894
3198
  */
2895
3199
  PlanId: string | undefined;
2896
3200
  /**
3201
+ * @public
2897
3202
  * <p>The maximum number of items to return with this call.</p>
2898
3203
  */
2899
3204
  PageSize?: number;
2900
3205
  /**
3206
+ * @public
2901
3207
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
2902
3208
  */
2903
3209
  PageToken?: string;
@@ -2924,66 +3230,81 @@ export type ProvisionedProductPlanStatus = (typeof ProvisionedProductPlanStatus)
2924
3230
  */
2925
3231
  export interface ProvisionedProductPlanDetails {
2926
3232
  /**
3233
+ * @public
2927
3234
  * <p>The UTC time stamp of the creation time.</p>
2928
3235
  */
2929
3236
  CreatedTime?: Date;
2930
3237
  /**
3238
+ * @public
2931
3239
  * <p>The path identifier of the product. This value is optional if the product
2932
3240
  * has a default path, and required if the product has more than one path.
2933
3241
  * To list the paths for a product, use <a>ListLaunchPaths</a>.</p>
2934
3242
  */
2935
3243
  PathId?: string;
2936
3244
  /**
3245
+ * @public
2937
3246
  * <p>The product identifier.</p>
2938
3247
  */
2939
3248
  ProductId?: string;
2940
3249
  /**
3250
+ * @public
2941
3251
  * <p>The name of the plan.</p>
2942
3252
  */
2943
3253
  PlanName?: string;
2944
3254
  /**
3255
+ * @public
2945
3256
  * <p>The plan identifier.</p>
2946
3257
  */
2947
3258
  PlanId?: string;
2948
3259
  /**
3260
+ * @public
2949
3261
  * <p>The product identifier.</p>
2950
3262
  */
2951
3263
  ProvisionProductId?: string;
2952
3264
  /**
3265
+ * @public
2953
3266
  * <p>The user-friendly name of the provisioned product.</p>
2954
3267
  */
2955
3268
  ProvisionProductName?: string;
2956
3269
  /**
3270
+ * @public
2957
3271
  * <p>The plan type.</p>
2958
3272
  */
2959
3273
  PlanType?: ProvisionedProductPlanType | string;
2960
3274
  /**
3275
+ * @public
2961
3276
  * <p>The identifier of the provisioning artifact.</p>
2962
3277
  */
2963
3278
  ProvisioningArtifactId?: string;
2964
3279
  /**
3280
+ * @public
2965
3281
  * <p>The status.</p>
2966
3282
  */
2967
3283
  Status?: ProvisionedProductPlanStatus | string;
2968
3284
  /**
3285
+ * @public
2969
3286
  * <p>The UTC time stamp when the plan was last updated.</p>
2970
3287
  */
2971
3288
  UpdatedTime?: Date;
2972
3289
  /**
3290
+ * @public
2973
3291
  * <p>Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related
2974
3292
  * events.</p>
2975
3293
  */
2976
3294
  NotificationArns?: string[];
2977
3295
  /**
3296
+ * @public
2978
3297
  * <p>Parameters specified by the administrator that are required for provisioning the
2979
3298
  * product.</p>
2980
3299
  */
2981
3300
  ProvisioningParameters?: UpdateProvisioningParameter[];
2982
3301
  /**
3302
+ * @public
2983
3303
  * <p>One or more tags.</p>
2984
3304
  */
2985
3305
  Tags?: Tag[];
2986
3306
  /**
3307
+ * @public
2987
3308
  * <p>The status message.</p>
2988
3309
  */
2989
3310
  StatusMessage?: string;
@@ -3048,15 +3369,18 @@ export type RequiresRecreation = (typeof RequiresRecreation)[keyof typeof Requir
3048
3369
  */
3049
3370
  export interface ResourceTargetDefinition {
3050
3371
  /**
3372
+ * @public
3051
3373
  * <p>The attribute to be changed.</p>
3052
3374
  */
3053
3375
  Attribute?: ResourceAttribute | string;
3054
3376
  /**
3377
+ * @public
3055
3378
  * <p>If the attribute is <code>Properties</code>, the value is the name of the property.
3056
3379
  * Otherwise, the value is null.</p>
3057
3380
  */
3058
3381
  Name?: string;
3059
3382
  /**
3383
+ * @public
3060
3384
  * <p>If the attribute is <code>Properties</code>, indicates whether a change to this property
3061
3385
  * causes the resource to be re-created.</p>
3062
3386
  */
@@ -3068,15 +3392,18 @@ export interface ResourceTargetDefinition {
3068
3392
  */
3069
3393
  export interface ResourceChangeDetail {
3070
3394
  /**
3395
+ * @public
3071
3396
  * <p>Information about the resource attribute to be modified.</p>
3072
3397
  */
3073
3398
  Target?: ResourceTargetDefinition;
3074
3399
  /**
3400
+ * @public
3075
3401
  * <p>For static evaluations, the value of the resource attribute will change and the new value is known.
3076
3402
  * For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.</p>
3077
3403
  */
3078
3404
  Evaluation?: EvaluationType | string;
3079
3405
  /**
3406
+ * @public
3080
3407
  * <p>The ID of the entity that caused the change.</p>
3081
3408
  */
3082
3409
  CausingEntity?: string;
@@ -3100,31 +3427,38 @@ export type Replacement = (typeof Replacement)[keyof typeof Replacement];
3100
3427
  */
3101
3428
  export interface ResourceChange {
3102
3429
  /**
3430
+ * @public
3103
3431
  * <p>The change action.</p>
3104
3432
  */
3105
3433
  Action?: ChangeAction | string;
3106
3434
  /**
3435
+ * @public
3107
3436
  * <p>The ID of the resource, as defined in the CloudFormation template.</p>
3108
3437
  */
3109
3438
  LogicalResourceId?: string;
3110
3439
  /**
3440
+ * @public
3111
3441
  * <p>The ID of the resource, if it was already created.</p>
3112
3442
  */
3113
3443
  PhysicalResourceId?: string;
3114
3444
  /**
3445
+ * @public
3115
3446
  * <p>The type of resource.</p>
3116
3447
  */
3117
3448
  ResourceType?: string;
3118
3449
  /**
3450
+ * @public
3119
3451
  * <p>If the change type is <code>Modify</code>, indicates whether the existing resource
3120
3452
  * is deleted and replaced with a new one.</p>
3121
3453
  */
3122
3454
  Replacement?: Replacement | string;
3123
3455
  /**
3456
+ * @public
3124
3457
  * <p>The change scope.</p>
3125
3458
  */
3126
3459
  Scope?: (ResourceAttribute | string)[];
3127
3460
  /**
3461
+ * @public
3128
3462
  * <p>Information about the resource changes.</p>
3129
3463
  */
3130
3464
  Details?: ResourceChangeDetail[];
@@ -3134,14 +3468,17 @@ export interface ResourceChange {
3134
3468
  */
3135
3469
  export interface DescribeProvisionedProductPlanOutput {
3136
3470
  /**
3471
+ * @public
3137
3472
  * <p>Information about the plan.</p>
3138
3473
  */
3139
3474
  ProvisionedProductPlanDetails?: ProvisionedProductPlanDetails;
3140
3475
  /**
3476
+ * @public
3141
3477
  * <p>Information about the resource changes that will occur when the plan is executed.</p>
3142
3478
  */
3143
3479
  ResourceChanges?: ResourceChange[];
3144
3480
  /**
3481
+ * @public
3145
3482
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
3146
3483
  */
3147
3484
  NextPageToken?: string;
@@ -3151,6 +3488,7 @@ export interface DescribeProvisionedProductPlanOutput {
3151
3488
  */
3152
3489
  export interface DescribeProvisioningArtifactInput {
3153
3490
  /**
3491
+ * @public
3154
3492
  * <p>The language code.</p>
3155
3493
  * <ul>
3156
3494
  * <li>
@@ -3165,26 +3503,32 @@ export interface DescribeProvisioningArtifactInput {
3165
3503
  */
3166
3504
  AcceptLanguage?: string;
3167
3505
  /**
3506
+ * @public
3168
3507
  * <p>The identifier of the provisioning artifact.</p>
3169
3508
  */
3170
3509
  ProvisioningArtifactId?: string;
3171
3510
  /**
3511
+ * @public
3172
3512
  * <p>The product identifier.</p>
3173
3513
  */
3174
3514
  ProductId?: string;
3175
3515
  /**
3516
+ * @public
3176
3517
  * <p>The provisioning artifact name.</p>
3177
3518
  */
3178
3519
  ProvisioningArtifactName?: string;
3179
3520
  /**
3521
+ * @public
3180
3522
  * <p>The product name.</p>
3181
3523
  */
3182
3524
  ProductName?: string;
3183
3525
  /**
3526
+ * @public
3184
3527
  * <p>Indicates whether a verbose level of detail is enabled.</p>
3185
3528
  */
3186
3529
  Verbose?: boolean;
3187
3530
  /**
3531
+ * @public
3188
3532
  * <p>Indicates if the API call response does or does not include additional details about the provisioning parameters. </p>
3189
3533
  */
3190
3534
  IncludeProvisioningArtifactParameters?: boolean;
@@ -3195,14 +3539,17 @@ export interface DescribeProvisioningArtifactInput {
3195
3539
  */
3196
3540
  export interface ParameterConstraints {
3197
3541
  /**
3542
+ * @public
3198
3543
  * <p>The values that the administrator has allowed for the parameter.</p>
3199
3544
  */
3200
3545
  AllowedValues?: string[];
3201
3546
  /**
3547
+ * @public
3202
3548
  * <p>A regular expression that represents the patterns that allow for <code>String</code> types. The pattern must match the entire parameter value provided.</p>
3203
3549
  */
3204
3550
  AllowedPattern?: string;
3205
3551
  /**
3552
+ * @public
3206
3553
  * <p>A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of <code>[A-Za-z0-9]+</code> displays the following error message when the user specifies an invalid value:</p>
3207
3554
  * <p>
3208
3555
  * <code>Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+</code>
@@ -3214,18 +3561,22 @@ export interface ParameterConstraints {
3214
3561
  */
3215
3562
  ConstraintDescription?: string;
3216
3563
  /**
3564
+ * @public
3217
3565
  * <p>An integer value that determines the largest number of characters you want to allow for <code>String</code> types. </p>
3218
3566
  */
3219
3567
  MaxLength?: string;
3220
3568
  /**
3569
+ * @public
3221
3570
  * <p>An integer value that determines the smallest number of characters you want to allow for <code>String</code> types.</p>
3222
3571
  */
3223
3572
  MinLength?: string;
3224
3573
  /**
3574
+ * @public
3225
3575
  * <p>A numeric value that determines the largest numeric value you want to allow for <code>Number</code> types.</p>
3226
3576
  */
3227
3577
  MaxValue?: string;
3228
3578
  /**
3579
+ * @public
3229
3580
  * <p>A numeric value that determines the smallest numeric value you want to allow for <code>Number</code> types. </p>
3230
3581
  */
3231
3582
  MinValue?: string;
@@ -3236,27 +3587,33 @@ export interface ParameterConstraints {
3236
3587
  */
3237
3588
  export interface ProvisioningArtifactParameter {
3238
3589
  /**
3590
+ * @public
3239
3591
  * <p>The parameter key.</p>
3240
3592
  */
3241
3593
  ParameterKey?: string;
3242
3594
  /**
3595
+ * @public
3243
3596
  * <p>The default value.</p>
3244
3597
  */
3245
3598
  DefaultValue?: string;
3246
3599
  /**
3600
+ * @public
3247
3601
  * <p>The parameter type.</p>
3248
3602
  */
3249
3603
  ParameterType?: string;
3250
3604
  /**
3605
+ * @public
3251
3606
  * <p>If this value is true, the value for this parameter is obfuscated from view when the
3252
3607
  * parameter is retrieved. This parameter is used to hide sensitive information.</p>
3253
3608
  */
3254
3609
  IsNoEcho?: boolean;
3255
3610
  /**
3611
+ * @public
3256
3612
  * <p>The description of the parameter.</p>
3257
3613
  */
3258
3614
  Description?: string;
3259
3615
  /**
3616
+ * @public
3260
3617
  * <p>Constraints that the administrator has put on a parameter.</p>
3261
3618
  */
3262
3619
  ParameterConstraints?: ParameterConstraints;
@@ -3266,18 +3623,22 @@ export interface ProvisioningArtifactParameter {
3266
3623
  */
3267
3624
  export interface DescribeProvisioningArtifactOutput {
3268
3625
  /**
3626
+ * @public
3269
3627
  * <p>Information about the provisioning artifact.</p>
3270
3628
  */
3271
3629
  ProvisioningArtifactDetail?: ProvisioningArtifactDetail;
3272
3630
  /**
3631
+ * @public
3273
3632
  * <p>The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.</p>
3274
3633
  */
3275
3634
  Info?: Record<string, string>;
3276
3635
  /**
3636
+ * @public
3277
3637
  * <p>The status of the current request.</p>
3278
3638
  */
3279
3639
  Status?: Status | string;
3280
3640
  /**
3641
+ * @public
3281
3642
  * <p>Information about the parameters used to provision the product. </p>
3282
3643
  */
3283
3644
  ProvisioningArtifactParameters?: ProvisioningArtifactParameter[];
@@ -3287,6 +3648,7 @@ export interface DescribeProvisioningArtifactOutput {
3287
3648
  */
3288
3649
  export interface DescribeProvisioningParametersInput {
3289
3650
  /**
3651
+ * @public
3290
3652
  * <p>The language code.</p>
3291
3653
  * <ul>
3292
3654
  * <li>
@@ -3301,28 +3663,34 @@ export interface DescribeProvisioningParametersInput {
3301
3663
  */
3302
3664
  AcceptLanguage?: string;
3303
3665
  /**
3666
+ * @public
3304
3667
  * <p>The product identifier. You must provide the product name or ID, but not both.</p>
3305
3668
  */
3306
3669
  ProductId?: string;
3307
3670
  /**
3671
+ * @public
3308
3672
  * <p>The name of the product. You must provide the name or ID, but not both.</p>
3309
3673
  */
3310
3674
  ProductName?: string;
3311
3675
  /**
3676
+ * @public
3312
3677
  * <p>The identifier of the provisioning artifact. You must provide the name or ID, but not both.</p>
3313
3678
  */
3314
3679
  ProvisioningArtifactId?: string;
3315
3680
  /**
3681
+ * @public
3316
3682
  * <p>The name of the provisioning artifact. You must provide the name or ID, but not both.</p>
3317
3683
  */
3318
3684
  ProvisioningArtifactName?: string;
3319
3685
  /**
3686
+ * @public
3320
3687
  * <p>The path identifier of the product. This value is optional if the product
3321
3688
  * has a default path, and required if the product has more than one path.
3322
3689
  * To list the paths for a product, use <a>ListLaunchPaths</a>. You must provide the name or ID, but not both.</p>
3323
3690
  */
3324
3691
  PathId?: string;
3325
3692
  /**
3693
+ * @public
3326
3694
  * <p>The name of the path. You must provide the name or ID, but not both.</p>
3327
3695
  */
3328
3696
  PathName?: string;
@@ -3333,6 +3701,7 @@ export interface DescribeProvisioningParametersInput {
3333
3701
  */
3334
3702
  export interface ConstraintSummary {
3335
3703
  /**
3704
+ * @public
3336
3705
  * <p>The type of constraint.</p>
3337
3706
  * <ul>
3338
3707
  * <li>
@@ -3357,6 +3726,7 @@ export interface ConstraintSummary {
3357
3726
  */
3358
3727
  Type?: string;
3359
3728
  /**
3729
+ * @public
3360
3730
  * <p>The description of the constraint.</p>
3361
3731
  */
3362
3732
  Description?: string;
@@ -3367,10 +3737,12 @@ export interface ConstraintSummary {
3367
3737
  */
3368
3738
  export interface ProvisioningArtifactOutput {
3369
3739
  /**
3740
+ * @public
3370
3741
  * <p>The provisioning artifact output key.</p>
3371
3742
  */
3372
3743
  Key?: string;
3373
3744
  /**
3745
+ * @public
3374
3746
  * <p>Description of the provisioning artifact output key.</p>
3375
3747
  */
3376
3748
  Description?: string;
@@ -3382,11 +3754,13 @@ export interface ProvisioningArtifactOutput {
3382
3754
  */
3383
3755
  export interface ProvisioningArtifactPreferences {
3384
3756
  /**
3757
+ * @public
3385
3758
  * <p>One or more Amazon Web Services accounts where stack instances are deployed from the stack set. These accounts can be scoped in <code>ProvisioningPreferences$StackSetAccounts</code> and <code>UpdateProvisioningPreferences$StackSetAccounts</code>.</p>
3386
3759
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
3387
3760
  */
3388
3761
  StackSetAccounts?: string[];
3389
3762
  /**
3763
+ * @public
3390
3764
  * <p>One or more Amazon Web Services Regions where stack instances are deployed from the stack set. These Regions can be scoped in <code>ProvisioningPreferences$StackSetRegions</code> and <code>UpdateProvisioningPreferences$StackSetRegions</code>.</p>
3391
3765
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
3392
3766
  */
@@ -3398,10 +3772,12 @@ export interface ProvisioningArtifactPreferences {
3398
3772
  */
3399
3773
  export interface TagOptionSummary {
3400
3774
  /**
3775
+ * @public
3401
3776
  * <p>The TagOption key.</p>
3402
3777
  */
3403
3778
  Key?: string;
3404
3779
  /**
3780
+ * @public
3405
3781
  * <p>The TagOption value.</p>
3406
3782
  */
3407
3783
  Values?: string[];
@@ -3412,10 +3788,12 @@ export interface TagOptionSummary {
3412
3788
  */
3413
3789
  export interface UsageInstruction {
3414
3790
  /**
3791
+ * @public
3415
3792
  * <p>The usage instruction type for the value.</p>
3416
3793
  */
3417
3794
  Type?: string;
3418
3795
  /**
3796
+ * @public
3419
3797
  * <p>The usage instruction value for this type.</p>
3420
3798
  */
3421
3799
  Value?: string;
@@ -3425,33 +3803,40 @@ export interface UsageInstruction {
3425
3803
  */
3426
3804
  export interface DescribeProvisioningParametersOutput {
3427
3805
  /**
3806
+ * @public
3428
3807
  * <p>Information about the parameters used to provision the product.</p>
3429
3808
  */
3430
3809
  ProvisioningArtifactParameters?: ProvisioningArtifactParameter[];
3431
3810
  /**
3811
+ * @public
3432
3812
  * <p>Information about the constraints used to provision the product.</p>
3433
3813
  */
3434
3814
  ConstraintSummaries?: ConstraintSummary[];
3435
3815
  /**
3816
+ * @public
3436
3817
  * <p>Any additional metadata specifically related to the provisioning of the product. For
3437
3818
  * example, see the <code>Version</code> field of the CloudFormation template.</p>
3438
3819
  */
3439
3820
  UsageInstructions?: UsageInstruction[];
3440
3821
  /**
3822
+ * @public
3441
3823
  * <p>Information about the TagOptions associated with the resource.</p>
3442
3824
  */
3443
3825
  TagOptions?: TagOptionSummary[];
3444
3826
  /**
3827
+ * @public
3445
3828
  * <p>An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.</p>
3446
3829
  */
3447
3830
  ProvisioningArtifactPreferences?: ProvisioningArtifactPreferences;
3448
3831
  /**
3832
+ * @public
3449
3833
  * @deprecated
3450
3834
  *
3451
3835
  * <p>The output of the provisioning artifact.</p>
3452
3836
  */
3453
3837
  ProvisioningArtifactOutputs?: ProvisioningArtifactOutput[];
3454
3838
  /**
3839
+ * @public
3455
3840
  * <p>A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.</p>
3456
3841
  */
3457
3842
  ProvisioningArtifactOutputKeys?: ProvisioningArtifactOutput[];
@@ -3461,6 +3846,7 @@ export interface DescribeProvisioningParametersOutput {
3461
3846
  */
3462
3847
  export interface DescribeRecordInput {
3463
3848
  /**
3849
+ * @public
3464
3850
  * <p>The language code.</p>
3465
3851
  * <ul>
3466
3852
  * <li>
@@ -3475,15 +3861,18 @@ export interface DescribeRecordInput {
3475
3861
  */
3476
3862
  AcceptLanguage?: string;
3477
3863
  /**
3864
+ * @public
3478
3865
  * <p>The record identifier of the provisioned product. This identifier is returned by the
3479
3866
  * request operation.</p>
3480
3867
  */
3481
3868
  Id: string | undefined;
3482
3869
  /**
3870
+ * @public
3483
3871
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
3484
3872
  */
3485
3873
  PageToken?: string;
3486
3874
  /**
3875
+ * @public
3487
3876
  * <p>The maximum number of items to return with this call.</p>
3488
3877
  */
3489
3878
  PageSize?: number;
@@ -3494,10 +3883,12 @@ export interface DescribeRecordInput {
3494
3883
  */
3495
3884
  export interface RecordError {
3496
3885
  /**
3886
+ * @public
3497
3887
  * <p>The numeric value of the error.</p>
3498
3888
  */
3499
3889
  Code?: string;
3500
3890
  /**
3891
+ * @public
3501
3892
  * <p>The description of the error.</p>
3502
3893
  */
3503
3894
  Description?: string;
@@ -3508,10 +3899,12 @@ export interface RecordError {
3508
3899
  */
3509
3900
  export interface RecordTag {
3510
3901
  /**
3902
+ * @public
3511
3903
  * <p>The key for this tag.</p>
3512
3904
  */
3513
3905
  Key?: string;
3514
3906
  /**
3907
+ * @public
3515
3908
  * <p>The value for this tag.</p>
3516
3909
  */
3517
3910
  Value?: string;
@@ -3537,14 +3930,17 @@ export type RecordStatus = (typeof RecordStatus)[keyof typeof RecordStatus];
3537
3930
  */
3538
3931
  export interface RecordDetail {
3539
3932
  /**
3933
+ * @public
3540
3934
  * <p>The identifier of the record.</p>
3541
3935
  */
3542
3936
  RecordId?: string;
3543
3937
  /**
3938
+ * @public
3544
3939
  * <p>The user-friendly name of the provisioned product.</p>
3545
3940
  */
3546
3941
  ProvisionedProductName?: string;
3547
3942
  /**
3943
+ * @public
3548
3944
  * <p>The status of the provisioned product.</p>
3549
3945
  * <ul>
3550
3946
  * <li>
@@ -3573,18 +3969,22 @@ export interface RecordDetail {
3573
3969
  */
3574
3970
  Status?: RecordStatus | string;
3575
3971
  /**
3972
+ * @public
3576
3973
  * <p>The UTC time stamp of the creation time.</p>
3577
3974
  */
3578
3975
  CreatedTime?: Date;
3579
3976
  /**
3977
+ * @public
3580
3978
  * <p>The time when the record was last updated.</p>
3581
3979
  */
3582
3980
  UpdatedTime?: Date;
3583
3981
  /**
3982
+ * @public
3584
3983
  * <p>The type of provisioned product. The supported values are <code>CFN_STACK</code> and <code>CFN_STACKSET</code>.</p>
3585
3984
  */
3586
3985
  ProvisionedProductType?: string;
3587
3986
  /**
3987
+ * @public
3588
3988
  * <p>The record type.</p>
3589
3989
  * <ul>
3590
3990
  * <li>
@@ -3606,30 +4006,37 @@ export interface RecordDetail {
3606
4006
  */
3607
4007
  RecordType?: string;
3608
4008
  /**
4009
+ * @public
3609
4010
  * <p>The identifier of the provisioned product.</p>
3610
4011
  */
3611
4012
  ProvisionedProductId?: string;
3612
4013
  /**
4014
+ * @public
3613
4015
  * <p>The product identifier.</p>
3614
4016
  */
3615
4017
  ProductId?: string;
3616
4018
  /**
4019
+ * @public
3617
4020
  * <p>The identifier of the provisioning artifact.</p>
3618
4021
  */
3619
4022
  ProvisioningArtifactId?: string;
3620
4023
  /**
4024
+ * @public
3621
4025
  * <p>The path identifier.</p>
3622
4026
  */
3623
4027
  PathId?: string;
3624
4028
  /**
4029
+ * @public
3625
4030
  * <p>The errors that occurred.</p>
3626
4031
  */
3627
4032
  RecordErrors?: RecordError[];
3628
4033
  /**
4034
+ * @public
3629
4035
  * <p>One or more tags.</p>
3630
4036
  */
3631
4037
  RecordTags?: RecordTag[];
3632
4038
  /**
4039
+ * @public
3633
4040
  * <p>The ARN of the launch role associated with the provisioned product.</p>
3634
4041
  */
3635
4042
  LaunchRoleArn?: string;
@@ -3641,14 +4048,17 @@ export interface RecordDetail {
3641
4048
  */
3642
4049
  export interface RecordOutput {
3643
4050
  /**
4051
+ * @public
3644
4052
  * <p>The output key.</p>
3645
4053
  */
3646
4054
  OutputKey?: string;
3647
4055
  /**
4056
+ * @public
3648
4057
  * <p>The output value.</p>
3649
4058
  */
3650
4059
  OutputValue?: string;
3651
4060
  /**
4061
+ * @public
3652
4062
  * <p>The description of the output.</p>
3653
4063
  */
3654
4064
  Description?: string;
@@ -3658,15 +4068,18 @@ export interface RecordOutput {
3658
4068
  */
3659
4069
  export interface DescribeRecordOutput {
3660
4070
  /**
4071
+ * @public
3661
4072
  * <p>Information about the product.</p>
3662
4073
  */
3663
4074
  RecordDetail?: RecordDetail;
3664
4075
  /**
4076
+ * @public
3665
4077
  * <p>Information about the product created as the result of a request. For example, the output for
3666
4078
  * a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.</p>
3667
4079
  */
3668
4080
  RecordOutputs?: RecordOutput[];
3669
4081
  /**
4082
+ * @public
3670
4083
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
3671
4084
  */
3672
4085
  NextPageToken?: string;
@@ -3676,10 +4089,12 @@ export interface DescribeRecordOutput {
3676
4089
  */
3677
4090
  export interface DescribeServiceActionInput {
3678
4091
  /**
4092
+ * @public
3679
4093
  * <p>The self-service action identifier.</p>
3680
4094
  */
3681
4095
  Id: string | undefined;
3682
4096
  /**
4097
+ * @public
3683
4098
  * <p>The language code.</p>
3684
4099
  * <ul>
3685
4100
  * <li>
@@ -3699,6 +4114,7 @@ export interface DescribeServiceActionInput {
3699
4114
  */
3700
4115
  export interface DescribeServiceActionOutput {
3701
4116
  /**
4117
+ * @public
3702
4118
  * <p>Detailed information about the self-service action.</p>
3703
4119
  */
3704
4120
  ServiceActionDetail?: ServiceActionDetail;
@@ -3708,14 +4124,17 @@ export interface DescribeServiceActionOutput {
3708
4124
  */
3709
4125
  export interface DescribeServiceActionExecutionParametersInput {
3710
4126
  /**
4127
+ * @public
3711
4128
  * <p>The identifier of the provisioned product.</p>
3712
4129
  */
3713
4130
  ProvisionedProductId: string | undefined;
3714
4131
  /**
4132
+ * @public
3715
4133
  * <p>The self-service action identifier.</p>
3716
4134
  */
3717
4135
  ServiceActionId: string | undefined;
3718
4136
  /**
4137
+ * @public
3719
4138
  * <p>The language code.</p>
3720
4139
  * <ul>
3721
4140
  * <li>
@@ -3736,14 +4155,17 @@ export interface DescribeServiceActionExecutionParametersInput {
3736
4155
  */
3737
4156
  export interface ExecutionParameter {
3738
4157
  /**
4158
+ * @public
3739
4159
  * <p>The name of the execution parameter.</p>
3740
4160
  */
3741
4161
  Name?: string;
3742
4162
  /**
4163
+ * @public
3743
4164
  * <p>The execution parameter type.</p>
3744
4165
  */
3745
4166
  Type?: string;
3746
4167
  /**
4168
+ * @public
3747
4169
  * <p>The default values for the execution parameter.</p>
3748
4170
  */
3749
4171
  DefaultValues?: string[];
@@ -3753,6 +4175,7 @@ export interface ExecutionParameter {
3753
4175
  */
3754
4176
  export interface DescribeServiceActionExecutionParametersOutput {
3755
4177
  /**
4178
+ * @public
3756
4179
  * <p>The parameters of the self-service action.</p>
3757
4180
  */
3758
4181
  ServiceActionParameters?: ExecutionParameter[];
@@ -3762,6 +4185,7 @@ export interface DescribeServiceActionExecutionParametersOutput {
3762
4185
  */
3763
4186
  export interface DescribeTagOptionInput {
3764
4187
  /**
4188
+ * @public
3765
4189
  * <p>The TagOption identifier.</p>
3766
4190
  */
3767
4191
  Id: string | undefined;
@@ -3771,6 +4195,7 @@ export interface DescribeTagOptionInput {
3771
4195
  */
3772
4196
  export interface DescribeTagOptionOutput {
3773
4197
  /**
4198
+ * @public
3774
4199
  * <p>Information about the TagOption.</p>
3775
4200
  */
3776
4201
  TagOptionDetail?: TagOptionDetail;
@@ -3790,10 +4215,12 @@ export interface DisableAWSOrganizationsAccessOutput {
3790
4215
  */
3791
4216
  export interface DisassociateBudgetFromResourceInput {
3792
4217
  /**
4218
+ * @public
3793
4219
  * <p>The name of the budget you want to disassociate.</p>
3794
4220
  */
3795
4221
  BudgetName: string | undefined;
3796
4222
  /**
4223
+ * @public
3797
4224
  * <p>The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.</p>
3798
4225
  */
3799
4226
  ResourceId: string | undefined;
@@ -3808,6 +4235,7 @@ export interface DisassociateBudgetFromResourceOutput {
3808
4235
  */
3809
4236
  export interface DisassociatePrincipalFromPortfolioInput {
3810
4237
  /**
4238
+ * @public
3811
4239
  * <p>The language code.</p>
3812
4240
  * <ul>
3813
4241
  * <li>
@@ -3822,15 +4250,18 @@ export interface DisassociatePrincipalFromPortfolioInput {
3822
4250
  */
3823
4251
  AcceptLanguage?: string;
3824
4252
  /**
4253
+ * @public
3825
4254
  * <p>The portfolio identifier.</p>
3826
4255
  */
3827
4256
  PortfolioId: string | undefined;
3828
4257
  /**
4258
+ * @public
3829
4259
  * <p>The ARN of the principal (user, role, or group). This field allows an ARN with no <code>accountID</code> with or without wildcard characters if
3830
4260
  * <code>PrincipalType</code> is <code>IAM_PATTERN</code>.</p>
3831
4261
  */
3832
4262
  PrincipalARN: string | undefined;
3833
4263
  /**
4264
+ * @public
3834
4265
  * <p>The supported value is <code>IAM</code> if you use a fully defined ARN, or <code>IAM_PATTERN</code>
3835
4266
  * if you specify an <code>IAM</code> ARN with no AccountId, with or without wildcard characters. </p>
3836
4267
  */
@@ -3846,6 +4277,7 @@ export interface DisassociatePrincipalFromPortfolioOutput {
3846
4277
  */
3847
4278
  export interface DisassociateProductFromPortfolioInput {
3848
4279
  /**
4280
+ * @public
3849
4281
  * <p>The language code.</p>
3850
4282
  * <ul>
3851
4283
  * <li>
@@ -3860,10 +4292,12 @@ export interface DisassociateProductFromPortfolioInput {
3860
4292
  */
3861
4293
  AcceptLanguage?: string;
3862
4294
  /**
4295
+ * @public
3863
4296
  * <p>The product identifier.</p>
3864
4297
  */
3865
4298
  ProductId: string | undefined;
3866
4299
  /**
4300
+ * @public
3867
4301
  * <p>The portfolio identifier.</p>
3868
4302
  */
3869
4303
  PortfolioId: string | undefined;
@@ -3878,18 +4312,22 @@ export interface DisassociateProductFromPortfolioOutput {
3878
4312
  */
3879
4313
  export interface DisassociateServiceActionFromProvisioningArtifactInput {
3880
4314
  /**
4315
+ * @public
3881
4316
  * <p>The product identifier. For example, <code>prod-abcdzk7xy33qa</code>.</p>
3882
4317
  */
3883
4318
  ProductId: string | undefined;
3884
4319
  /**
4320
+ * @public
3885
4321
  * <p>The identifier of the provisioning artifact. For example, <code>pa-4abcdjnxjj6ne</code>.</p>
3886
4322
  */
3887
4323
  ProvisioningArtifactId: string | undefined;
3888
4324
  /**
4325
+ * @public
3889
4326
  * <p>The self-service action identifier. For example, <code>act-fs7abcd89wxyz</code>.</p>
3890
4327
  */
3891
4328
  ServiceActionId: string | undefined;
3892
4329
  /**
4330
+ * @public
3893
4331
  * <p>The language code.</p>
3894
4332
  * <ul>
3895
4333
  * <li>
@@ -3914,10 +4352,12 @@ export interface DisassociateServiceActionFromProvisioningArtifactOutput {
3914
4352
  */
3915
4353
  export interface DisassociateTagOptionFromResourceInput {
3916
4354
  /**
4355
+ * @public
3917
4356
  * <p>The resource identifier.</p>
3918
4357
  */
3919
4358
  ResourceId: string | undefined;
3920
4359
  /**
4360
+ * @public
3921
4361
  * <p>The TagOption identifier.</p>
3922
4362
  */
3923
4363
  TagOptionId: string | undefined;
@@ -3942,6 +4382,7 @@ export interface EnableAWSOrganizationsAccessOutput {
3942
4382
  */
3943
4383
  export interface ExecuteProvisionedProductPlanInput {
3944
4384
  /**
4385
+ * @public
3945
4386
  * <p>The language code.</p>
3946
4387
  * <ul>
3947
4388
  * <li>
@@ -3956,10 +4397,12 @@ export interface ExecuteProvisionedProductPlanInput {
3956
4397
  */
3957
4398
  AcceptLanguage?: string;
3958
4399
  /**
4400
+ * @public
3959
4401
  * <p>The plan identifier.</p>
3960
4402
  */
3961
4403
  PlanId: string | undefined;
3962
4404
  /**
4405
+ * @public
3963
4406
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
3964
4407
  * the same response is returned for each repeated request.</p>
3965
4408
  */
@@ -3970,6 +4413,7 @@ export interface ExecuteProvisionedProductPlanInput {
3970
4413
  */
3971
4414
  export interface ExecuteProvisionedProductPlanOutput {
3972
4415
  /**
4416
+ * @public
3973
4417
  * <p>Information about the result of provisioning the product.</p>
3974
4418
  */
3975
4419
  RecordDetail?: RecordDetail;
@@ -3979,18 +4423,22 @@ export interface ExecuteProvisionedProductPlanOutput {
3979
4423
  */
3980
4424
  export interface ExecuteProvisionedProductServiceActionInput {
3981
4425
  /**
4426
+ * @public
3982
4427
  * <p>The identifier of the provisioned product.</p>
3983
4428
  */
3984
4429
  ProvisionedProductId: string | undefined;
3985
4430
  /**
4431
+ * @public
3986
4432
  * <p>The self-service action identifier. For example, <code>act-fs7abcd89wxyz</code>.</p>
3987
4433
  */
3988
4434
  ServiceActionId: string | undefined;
3989
4435
  /**
4436
+ * @public
3990
4437
  * <p>An idempotency token that uniquely identifies the execute request.</p>
3991
4438
  */
3992
4439
  ExecuteToken?: string;
3993
4440
  /**
4441
+ * @public
3994
4442
  * <p>The language code.</p>
3995
4443
  * <ul>
3996
4444
  * <li>
@@ -4005,6 +4453,7 @@ export interface ExecuteProvisionedProductServiceActionInput {
4005
4453
  */
4006
4454
  AcceptLanguage?: string;
4007
4455
  /**
4456
+ * @public
4008
4457
  * <p>A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as <code>TARGET</code>, the provided value will
4009
4458
  * override the default value generated by Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for
4010
4459
  * any special parameters such as <code>TARGET</code>.</p>
@@ -4016,6 +4465,7 @@ export interface ExecuteProvisionedProductServiceActionInput {
4016
4465
  */
4017
4466
  export interface ExecuteProvisionedProductServiceActionOutput {
4018
4467
  /**
4468
+ * @public
4019
4469
  * <p>An object containing detailed information about the result of provisioning the product.</p>
4020
4470
  */
4021
4471
  RecordDetail?: RecordDetail;
@@ -4030,6 +4480,7 @@ export interface GetAWSOrganizationsAccessStatusInput {
4030
4480
  */
4031
4481
  export interface GetAWSOrganizationsAccessStatusOutput {
4032
4482
  /**
4483
+ * @public
4033
4484
  * <p>The status of the portfolio share feature.</p>
4034
4485
  */
4035
4486
  AccessStatus?: AccessStatus | string;
@@ -4039,6 +4490,7 @@ export interface GetAWSOrganizationsAccessStatusOutput {
4039
4490
  */
4040
4491
  export interface GetProvisionedProductOutputsInput {
4041
4492
  /**
4493
+ * @public
4042
4494
  * <p>The language code.</p>
4043
4495
  * <ul>
4044
4496
  * <li>
@@ -4053,22 +4505,27 @@ export interface GetProvisionedProductOutputsInput {
4053
4505
  */
4054
4506
  AcceptLanguage?: string;
4055
4507
  /**
4508
+ * @public
4056
4509
  * <p>The identifier of the provisioned product that you want the outputs from.</p>
4057
4510
  */
4058
4511
  ProvisionedProductId?: string;
4059
4512
  /**
4513
+ * @public
4060
4514
  * <p>The name of the provisioned product that you want the outputs from.</p>
4061
4515
  */
4062
4516
  ProvisionedProductName?: string;
4063
4517
  /**
4518
+ * @public
4064
4519
  * <p>The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.</p>
4065
4520
  */
4066
4521
  OutputKeys?: string[];
4067
4522
  /**
4523
+ * @public
4068
4524
  * <p>The maximum number of items to return with this call.</p>
4069
4525
  */
4070
4526
  PageSize?: number;
4071
4527
  /**
4528
+ * @public
4072
4529
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4073
4530
  */
4074
4531
  PageToken?: string;
@@ -4078,11 +4535,13 @@ export interface GetProvisionedProductOutputsInput {
4078
4535
  */
4079
4536
  export interface GetProvisionedProductOutputsOutput {
4080
4537
  /**
4538
+ * @public
4081
4539
  * <p>Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
4082
4540
  * </p>
4083
4541
  */
4084
4542
  Outputs?: RecordOutput[];
4085
4543
  /**
4544
+ * @public
4086
4545
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4087
4546
  */
4088
4547
  NextPageToken?: string;
@@ -4092,6 +4551,7 @@ export interface GetProvisionedProductOutputsOutput {
4092
4551
  */
4093
4552
  export interface ImportAsProvisionedProductInput {
4094
4553
  /**
4554
+ * @public
4095
4555
  * <p>The language code.</p>
4096
4556
  * <ul>
4097
4557
  * <li>
@@ -4106,23 +4566,28 @@ export interface ImportAsProvisionedProductInput {
4106
4566
  */
4107
4567
  AcceptLanguage?: string;
4108
4568
  /**
4569
+ * @public
4109
4570
  * <p>The product identifier.</p>
4110
4571
  */
4111
4572
  ProductId: string | undefined;
4112
4573
  /**
4574
+ * @public
4113
4575
  * <p>The identifier of the provisioning artifact.</p>
4114
4576
  */
4115
4577
  ProvisioningArtifactId: string | undefined;
4116
4578
  /**
4579
+ * @public
4117
4580
  * <p>The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned. </p>
4118
4581
  */
4119
4582
  ProvisionedProductName: string | undefined;
4120
4583
  /**
4584
+ * @public
4121
4585
  * <p>The unique identifier of the resource to be imported. It only currently supports
4122
4586
  * CloudFormation stack IDs.</p>
4123
4587
  */
4124
4588
  PhysicalId: string | undefined;
4125
4589
  /**
4590
+ * @public
4126
4591
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
4127
4592
  * the same response is returned for each repeated request.</p>
4128
4593
  */
@@ -4133,6 +4598,7 @@ export interface ImportAsProvisionedProductInput {
4133
4598
  */
4134
4599
  export interface ImportAsProvisionedProductOutput {
4135
4600
  /**
4601
+ * @public
4136
4602
  * <p>Information about a request operation.</p>
4137
4603
  */
4138
4604
  RecordDetail?: RecordDetail;
@@ -4142,6 +4608,7 @@ export interface ImportAsProvisionedProductOutput {
4142
4608
  */
4143
4609
  export interface ListAcceptedPortfolioSharesInput {
4144
4610
  /**
4611
+ * @public
4145
4612
  * <p>The language code.</p>
4146
4613
  * <ul>
4147
4614
  * <li>
@@ -4156,14 +4623,17 @@ export interface ListAcceptedPortfolioSharesInput {
4156
4623
  */
4157
4624
  AcceptLanguage?: string;
4158
4625
  /**
4626
+ * @public
4159
4627
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4160
4628
  */
4161
4629
  PageToken?: string;
4162
4630
  /**
4631
+ * @public
4163
4632
  * <p>The maximum number of items to return with this call.</p>
4164
4633
  */
4165
4634
  PageSize?: number;
4166
4635
  /**
4636
+ * @public
4167
4637
  * <p>The type of shared portfolios to list. The default is to list imported portfolios.</p>
4168
4638
  * <ul>
4169
4639
  * <li>
@@ -4188,10 +4658,12 @@ export interface ListAcceptedPortfolioSharesInput {
4188
4658
  */
4189
4659
  export interface ListAcceptedPortfolioSharesOutput {
4190
4660
  /**
4661
+ * @public
4191
4662
  * <p>Information about the portfolios.</p>
4192
4663
  */
4193
4664
  PortfolioDetails?: PortfolioDetail[];
4194
4665
  /**
4666
+ * @public
4195
4667
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4196
4668
  */
4197
4669
  NextPageToken?: string;
@@ -4201,6 +4673,7 @@ export interface ListAcceptedPortfolioSharesOutput {
4201
4673
  */
4202
4674
  export interface ListBudgetsForResourceInput {
4203
4675
  /**
4676
+ * @public
4204
4677
  * <p>The language code.</p>
4205
4678
  * <ul>
4206
4679
  * <li>
@@ -4215,14 +4688,17 @@ export interface ListBudgetsForResourceInput {
4215
4688
  */
4216
4689
  AcceptLanguage?: string;
4217
4690
  /**
4691
+ * @public
4218
4692
  * <p>The resource identifier.</p>
4219
4693
  */
4220
4694
  ResourceId: string | undefined;
4221
4695
  /**
4696
+ * @public
4222
4697
  * <p>The maximum number of items to return with this call.</p>
4223
4698
  */
4224
4699
  PageSize?: number;
4225
4700
  /**
4701
+ * @public
4226
4702
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4227
4703
  */
4228
4704
  PageToken?: string;
@@ -4232,10 +4708,12 @@ export interface ListBudgetsForResourceInput {
4232
4708
  */
4233
4709
  export interface ListBudgetsForResourceOutput {
4234
4710
  /**
4711
+ * @public
4235
4712
  * <p>Information about the associated budgets.</p>
4236
4713
  */
4237
4714
  Budgets?: BudgetDetail[];
4238
4715
  /**
4716
+ * @public
4239
4717
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4240
4718
  */
4241
4719
  NextPageToken?: string;
@@ -4245,6 +4723,7 @@ export interface ListBudgetsForResourceOutput {
4245
4723
  */
4246
4724
  export interface ListConstraintsForPortfolioInput {
4247
4725
  /**
4726
+ * @public
4248
4727
  * <p>The language code.</p>
4249
4728
  * <ul>
4250
4729
  * <li>
@@ -4259,18 +4738,22 @@ export interface ListConstraintsForPortfolioInput {
4259
4738
  */
4260
4739
  AcceptLanguage?: string;
4261
4740
  /**
4741
+ * @public
4262
4742
  * <p>The portfolio identifier.</p>
4263
4743
  */
4264
4744
  PortfolioId: string | undefined;
4265
4745
  /**
4746
+ * @public
4266
4747
  * <p>The product identifier.</p>
4267
4748
  */
4268
4749
  ProductId?: string;
4269
4750
  /**
4751
+ * @public
4270
4752
  * <p>The maximum number of items to return with this call.</p>
4271
4753
  */
4272
4754
  PageSize?: number;
4273
4755
  /**
4756
+ * @public
4274
4757
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4275
4758
  */
4276
4759
  PageToken?: string;
@@ -4280,10 +4763,12 @@ export interface ListConstraintsForPortfolioInput {
4280
4763
  */
4281
4764
  export interface ListConstraintsForPortfolioOutput {
4282
4765
  /**
4766
+ * @public
4283
4767
  * <p>Information about the constraints.</p>
4284
4768
  */
4285
4769
  ConstraintDetails?: ConstraintDetail[];
4286
4770
  /**
4771
+ * @public
4287
4772
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4288
4773
  */
4289
4774
  NextPageToken?: string;
@@ -4293,6 +4778,7 @@ export interface ListConstraintsForPortfolioOutput {
4293
4778
  */
4294
4779
  export interface ListLaunchPathsInput {
4295
4780
  /**
4781
+ * @public
4296
4782
  * <p>The language code.</p>
4297
4783
  * <ul>
4298
4784
  * <li>
@@ -4307,14 +4793,17 @@ export interface ListLaunchPathsInput {
4307
4793
  */
4308
4794
  AcceptLanguage?: string;
4309
4795
  /**
4796
+ * @public
4310
4797
  * <p>The product identifier.</p>
4311
4798
  */
4312
4799
  ProductId: string | undefined;
4313
4800
  /**
4801
+ * @public
4314
4802
  * <p>The maximum number of items to return with this call.</p>
4315
4803
  */
4316
4804
  PageSize?: number;
4317
4805
  /**
4806
+ * @public
4318
4807
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4319
4808
  */
4320
4809
  PageToken?: string;
@@ -4325,18 +4814,22 @@ export interface ListLaunchPathsInput {
4325
4814
  */
4326
4815
  export interface LaunchPathSummary {
4327
4816
  /**
4817
+ * @public
4328
4818
  * <p>The identifier of the product path.</p>
4329
4819
  */
4330
4820
  Id?: string;
4331
4821
  /**
4822
+ * @public
4332
4823
  * <p>The constraints on the portfolio-product relationship.</p>
4333
4824
  */
4334
4825
  ConstraintSummaries?: ConstraintSummary[];
4335
4826
  /**
4827
+ * @public
4336
4828
  * <p>The tags associated with this product path.</p>
4337
4829
  */
4338
4830
  Tags?: Tag[];
4339
4831
  /**
4832
+ * @public
4340
4833
  * <p>The name of the portfolio that contains the product. </p>
4341
4834
  */
4342
4835
  Name?: string;
@@ -4346,10 +4839,12 @@ export interface LaunchPathSummary {
4346
4839
  */
4347
4840
  export interface ListLaunchPathsOutput {
4348
4841
  /**
4842
+ * @public
4349
4843
  * <p>Information about the launch path.</p>
4350
4844
  */
4351
4845
  LaunchPathSummaries?: LaunchPathSummary[];
4352
4846
  /**
4847
+ * @public
4353
4848
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4354
4849
  */
4355
4850
  NextPageToken?: string;
@@ -4359,6 +4854,7 @@ export interface ListLaunchPathsOutput {
4359
4854
  */
4360
4855
  export interface ListOrganizationPortfolioAccessInput {
4361
4856
  /**
4857
+ * @public
4362
4858
  * <p>The language code.</p>
4363
4859
  * <ul>
4364
4860
  * <li>
@@ -4373,10 +4869,12 @@ export interface ListOrganizationPortfolioAccessInput {
4373
4869
  */
4374
4870
  AcceptLanguage?: string;
4375
4871
  /**
4872
+ * @public
4376
4873
  * <p>The portfolio identifier. For example, <code>port-2abcdext3y5fk</code>.</p>
4377
4874
  */
4378
4875
  PortfolioId: string | undefined;
4379
4876
  /**
4877
+ * @public
4380
4878
  * <p>The organization node type that will be returned in the output.</p>
4381
4879
  * <ul>
4382
4880
  * <li>
@@ -4395,10 +4893,12 @@ export interface ListOrganizationPortfolioAccessInput {
4395
4893
  */
4396
4894
  OrganizationNodeType: OrganizationNodeType | string | undefined;
4397
4895
  /**
4896
+ * @public
4398
4897
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4399
4898
  */
4400
4899
  PageToken?: string;
4401
4900
  /**
4901
+ * @public
4402
4902
  * <p>The maximum number of items to return with this call.</p>
4403
4903
  */
4404
4904
  PageSize?: number;
@@ -4408,10 +4908,12 @@ export interface ListOrganizationPortfolioAccessInput {
4408
4908
  */
4409
4909
  export interface ListOrganizationPortfolioAccessOutput {
4410
4910
  /**
4911
+ * @public
4411
4912
  * <p>Displays information about the organization nodes.</p>
4412
4913
  */
4413
4914
  OrganizationNodes?: OrganizationNode[];
4414
4915
  /**
4916
+ * @public
4415
4917
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4416
4918
  */
4417
4919
  NextPageToken?: string;
@@ -4421,6 +4923,7 @@ export interface ListOrganizationPortfolioAccessOutput {
4421
4923
  */
4422
4924
  export interface ListPortfolioAccessInput {
4423
4925
  /**
4926
+ * @public
4424
4927
  * <p>The language code.</p>
4425
4928
  * <ul>
4426
4929
  * <li>
@@ -4435,18 +4938,22 @@ export interface ListPortfolioAccessInput {
4435
4938
  */
4436
4939
  AcceptLanguage?: string;
4437
4940
  /**
4941
+ * @public
4438
4942
  * <p>The portfolio identifier.</p>
4439
4943
  */
4440
4944
  PortfolioId: string | undefined;
4441
4945
  /**
4946
+ * @public
4442
4947
  * <p>The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.</p>
4443
4948
  */
4444
4949
  OrganizationParentId?: string;
4445
4950
  /**
4951
+ * @public
4446
4952
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4447
4953
  */
4448
4954
  PageToken?: string;
4449
4955
  /**
4956
+ * @public
4450
4957
  * <p>The maximum number of items to return with this call.</p>
4451
4958
  */
4452
4959
  PageSize?: number;
@@ -4456,10 +4963,12 @@ export interface ListPortfolioAccessInput {
4456
4963
  */
4457
4964
  export interface ListPortfolioAccessOutput {
4458
4965
  /**
4966
+ * @public
4459
4967
  * <p>Information about the Amazon Web Services accounts with access to the portfolio.</p>
4460
4968
  */
4461
4969
  AccountIds?: string[];
4462
4970
  /**
4971
+ * @public
4463
4972
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4464
4973
  */
4465
4974
  NextPageToken?: string;
@@ -4469,6 +4978,7 @@ export interface ListPortfolioAccessOutput {
4469
4978
  */
4470
4979
  export interface ListPortfoliosInput {
4471
4980
  /**
4981
+ * @public
4472
4982
  * <p>The language code.</p>
4473
4983
  * <ul>
4474
4984
  * <li>
@@ -4483,10 +4993,12 @@ export interface ListPortfoliosInput {
4483
4993
  */
4484
4994
  AcceptLanguage?: string;
4485
4995
  /**
4996
+ * @public
4486
4997
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4487
4998
  */
4488
4999
  PageToken?: string;
4489
5000
  /**
5001
+ * @public
4490
5002
  * <p>The maximum number of items to return with this call.</p>
4491
5003
  */
4492
5004
  PageSize?: number;
@@ -4496,10 +5008,12 @@ export interface ListPortfoliosInput {
4496
5008
  */
4497
5009
  export interface ListPortfoliosOutput {
4498
5010
  /**
5011
+ * @public
4499
5012
  * <p>Information about the portfolios.</p>
4500
5013
  */
4501
5014
  PortfolioDetails?: PortfolioDetail[];
4502
5015
  /**
5016
+ * @public
4503
5017
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4504
5018
  */
4505
5019
  NextPageToken?: string;
@@ -4509,6 +5023,7 @@ export interface ListPortfoliosOutput {
4509
5023
  */
4510
5024
  export interface ListPortfoliosForProductInput {
4511
5025
  /**
5026
+ * @public
4512
5027
  * <p>The language code.</p>
4513
5028
  * <ul>
4514
5029
  * <li>
@@ -4523,14 +5038,17 @@ export interface ListPortfoliosForProductInput {
4523
5038
  */
4524
5039
  AcceptLanguage?: string;
4525
5040
  /**
5041
+ * @public
4526
5042
  * <p>The product identifier.</p>
4527
5043
  */
4528
5044
  ProductId: string | undefined;
4529
5045
  /**
5046
+ * @public
4530
5047
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4531
5048
  */
4532
5049
  PageToken?: string;
4533
5050
  /**
5051
+ * @public
4534
5052
  * <p>The maximum number of items to return with this call.</p>
4535
5053
  */
4536
5054
  PageSize?: number;
@@ -4540,10 +5058,12 @@ export interface ListPortfoliosForProductInput {
4540
5058
  */
4541
5059
  export interface ListPortfoliosForProductOutput {
4542
5060
  /**
5061
+ * @public
4543
5062
  * <p>Information about the portfolios.</p>
4544
5063
  */
4545
5064
  PortfolioDetails?: PortfolioDetail[];
4546
5065
  /**
5066
+ * @public
4547
5067
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4548
5068
  */
4549
5069
  NextPageToken?: string;
@@ -4553,6 +5073,7 @@ export interface ListPortfoliosForProductOutput {
4553
5073
  */
4554
5074
  export interface ListPrincipalsForPortfolioInput {
4555
5075
  /**
5076
+ * @public
4556
5077
  * <p>The language code.</p>
4557
5078
  * <ul>
4558
5079
  * <li>
@@ -4567,14 +5088,17 @@ export interface ListPrincipalsForPortfolioInput {
4567
5088
  */
4568
5089
  AcceptLanguage?: string;
4569
5090
  /**
5091
+ * @public
4570
5092
  * <p>The portfolio identifier.</p>
4571
5093
  */
4572
5094
  PortfolioId: string | undefined;
4573
5095
  /**
5096
+ * @public
4574
5097
  * <p>The maximum number of items to return with this call.</p>
4575
5098
  */
4576
5099
  PageSize?: number;
4577
5100
  /**
5101
+ * @public
4578
5102
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4579
5103
  */
4580
5104
  PageToken?: string;
@@ -4585,6 +5109,7 @@ export interface ListPrincipalsForPortfolioInput {
4585
5109
  */
4586
5110
  export interface Principal {
4587
5111
  /**
5112
+ * @public
4588
5113
  * <p>The ARN of the principal (user, role, or group). This field allows for an ARN with no <code>accountID</code>, with or without wildcard characters if the
4589
5114
  * <code>PrincipalType</code> is an <code>IAM_PATTERN</code>. </p>
4590
5115
  * <p>For more information, review <a href="https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options">associate-principal-with-portfolio</a>
@@ -4592,6 +5117,7 @@ export interface Principal {
4592
5117
  */
4593
5118
  PrincipalARN?: string;
4594
5119
  /**
5120
+ * @public
4595
5121
  * <p>The principal type. The supported value is <code>IAM</code> if you use a fully defined ARN, or
4596
5122
  * <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>, with or without wildcard characters. </p>
4597
5123
  */
@@ -4602,10 +5128,12 @@ export interface Principal {
4602
5128
  */
4603
5129
  export interface ListPrincipalsForPortfolioOutput {
4604
5130
  /**
5131
+ * @public
4605
5132
  * <p>The <code>PrincipalARN</code>s and corresponding <code>PrincipalType</code>s associated with the portfolio.</p>
4606
5133
  */
4607
5134
  Principals?: Principal[];
4608
5135
  /**
5136
+ * @public
4609
5137
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4610
5138
  */
4611
5139
  NextPageToken?: string;
@@ -4615,6 +5143,7 @@ export interface ListPrincipalsForPortfolioOutput {
4615
5143
  */
4616
5144
  export interface ListProvisionedProductPlansInput {
4617
5145
  /**
5146
+ * @public
4618
5147
  * <p>The language code.</p>
4619
5148
  * <ul>
4620
5149
  * <li>
@@ -4629,18 +5158,22 @@ export interface ListProvisionedProductPlansInput {
4629
5158
  */
4630
5159
  AcceptLanguage?: string;
4631
5160
  /**
5161
+ * @public
4632
5162
  * <p>The product identifier.</p>
4633
5163
  */
4634
5164
  ProvisionProductId?: string;
4635
5165
  /**
5166
+ * @public
4636
5167
  * <p>The maximum number of items to return with this call.</p>
4637
5168
  */
4638
5169
  PageSize?: number;
4639
5170
  /**
5171
+ * @public
4640
5172
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4641
5173
  */
4642
5174
  PageToken?: string;
4643
5175
  /**
5176
+ * @public
4644
5177
  * <p>The access level to use to obtain results. The default is <code>User</code>.</p>
4645
5178
  */
4646
5179
  AccessLevelFilter?: AccessLevelFilter;
@@ -4651,26 +5184,32 @@ export interface ListProvisionedProductPlansInput {
4651
5184
  */
4652
5185
  export interface ProvisionedProductPlanSummary {
4653
5186
  /**
5187
+ * @public
4654
5188
  * <p>The name of the plan.</p>
4655
5189
  */
4656
5190
  PlanName?: string;
4657
5191
  /**
5192
+ * @public
4658
5193
  * <p>The plan identifier.</p>
4659
5194
  */
4660
5195
  PlanId?: string;
4661
5196
  /**
5197
+ * @public
4662
5198
  * <p>The product identifier.</p>
4663
5199
  */
4664
5200
  ProvisionProductId?: string;
4665
5201
  /**
5202
+ * @public
4666
5203
  * <p>The user-friendly name of the provisioned product.</p>
4667
5204
  */
4668
5205
  ProvisionProductName?: string;
4669
5206
  /**
5207
+ * @public
4670
5208
  * <p>The plan type.</p>
4671
5209
  */
4672
5210
  PlanType?: ProvisionedProductPlanType | string;
4673
5211
  /**
5212
+ * @public
4674
5213
  * <p>The identifier of the provisioning artifact.</p>
4675
5214
  */
4676
5215
  ProvisioningArtifactId?: string;
@@ -4680,10 +5219,12 @@ export interface ProvisionedProductPlanSummary {
4680
5219
  */
4681
5220
  export interface ListProvisionedProductPlansOutput {
4682
5221
  /**
5222
+ * @public
4683
5223
  * <p>Information about the plans.</p>
4684
5224
  */
4685
5225
  ProvisionedProductPlans?: ProvisionedProductPlanSummary[];
4686
5226
  /**
5227
+ * @public
4687
5228
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4688
5229
  */
4689
5230
  NextPageToken?: string;
@@ -4693,6 +5234,7 @@ export interface ListProvisionedProductPlansOutput {
4693
5234
  */
4694
5235
  export interface ListProvisioningArtifactsInput {
4695
5236
  /**
5237
+ * @public
4696
5238
  * <p>The language code.</p>
4697
5239
  * <ul>
4698
5240
  * <li>
@@ -4707,6 +5249,7 @@ export interface ListProvisioningArtifactsInput {
4707
5249
  */
4708
5250
  AcceptLanguage?: string;
4709
5251
  /**
5252
+ * @public
4710
5253
  * <p>The product identifier.</p>
4711
5254
  */
4712
5255
  ProductId: string | undefined;
@@ -4716,10 +5259,12 @@ export interface ListProvisioningArtifactsInput {
4716
5259
  */
4717
5260
  export interface ListProvisioningArtifactsOutput {
4718
5261
  /**
5262
+ * @public
4719
5263
  * <p>Information about the provisioning artifacts.</p>
4720
5264
  */
4721
5265
  ProvisioningArtifactDetails?: ProvisioningArtifactDetail[];
4722
5266
  /**
5267
+ * @public
4723
5268
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4724
5269
  */
4725
5270
  NextPageToken?: string;
@@ -4729,18 +5274,22 @@ export interface ListProvisioningArtifactsOutput {
4729
5274
  */
4730
5275
  export interface ListProvisioningArtifactsForServiceActionInput {
4731
5276
  /**
5277
+ * @public
4732
5278
  * <p>The self-service action identifier. For example, <code>act-fs7abcd89wxyz</code>.</p>
4733
5279
  */
4734
5280
  ServiceActionId: string | undefined;
4735
5281
  /**
5282
+ * @public
4736
5283
  * <p>The maximum number of items to return with this call.</p>
4737
5284
  */
4738
5285
  PageSize?: number;
4739
5286
  /**
5287
+ * @public
4740
5288
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4741
5289
  */
4742
5290
  PageToken?: string;
4743
5291
  /**
5292
+ * @public
4744
5293
  * <p>The language code.</p>
4745
5294
  * <ul>
4746
5295
  * <li>
@@ -4761,10 +5310,12 @@ export interface ListProvisioningArtifactsForServiceActionInput {
4761
5310
  */
4762
5311
  export interface ProvisioningArtifactView {
4763
5312
  /**
5313
+ * @public
4764
5314
  * <p>Summary information about a product view.</p>
4765
5315
  */
4766
5316
  ProductViewSummary?: ProductViewSummary;
4767
5317
  /**
5318
+ * @public
4768
5319
  * <p>Information about a provisioning artifact. A provisioning artifact is also known as a product version.</p>
4769
5320
  */
4770
5321
  ProvisioningArtifact?: ProvisioningArtifact;
@@ -4774,10 +5325,12 @@ export interface ProvisioningArtifactView {
4774
5325
  */
4775
5326
  export interface ListProvisioningArtifactsForServiceActionOutput {
4776
5327
  /**
5328
+ * @public
4777
5329
  * <p>An array of objects with information about product views and provisioning artifacts.</p>
4778
5330
  */
4779
5331
  ProvisioningArtifactViews?: ProvisioningArtifactView[];
4780
5332
  /**
5333
+ * @public
4781
5334
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4782
5335
  */
4783
5336
  NextPageToken?: string;
@@ -4788,6 +5341,7 @@ export interface ListProvisioningArtifactsForServiceActionOutput {
4788
5341
  */
4789
5342
  export interface ListRecordHistorySearchFilter {
4790
5343
  /**
5344
+ * @public
4791
5345
  * <p>The filter key.</p>
4792
5346
  * <ul>
4793
5347
  * <li>
@@ -4802,6 +5356,7 @@ export interface ListRecordHistorySearchFilter {
4802
5356
  */
4803
5357
  Key?: string;
4804
5358
  /**
5359
+ * @public
4805
5360
  * <p>The filter value.</p>
4806
5361
  */
4807
5362
  Value?: string;
@@ -4811,6 +5366,7 @@ export interface ListRecordHistorySearchFilter {
4811
5366
  */
4812
5367
  export interface ListRecordHistoryInput {
4813
5368
  /**
5369
+ * @public
4814
5370
  * <p>The language code.</p>
4815
5371
  * <ul>
4816
5372
  * <li>
@@ -4825,18 +5381,22 @@ export interface ListRecordHistoryInput {
4825
5381
  */
4826
5382
  AcceptLanguage?: string;
4827
5383
  /**
5384
+ * @public
4828
5385
  * <p>The access level to use to obtain results. The default is <code>User</code>.</p>
4829
5386
  */
4830
5387
  AccessLevelFilter?: AccessLevelFilter;
4831
5388
  /**
5389
+ * @public
4832
5390
  * <p>The search filter to scope the results.</p>
4833
5391
  */
4834
5392
  SearchFilter?: ListRecordHistorySearchFilter;
4835
5393
  /**
5394
+ * @public
4836
5395
  * <p>The maximum number of items to return with this call.</p>
4837
5396
  */
4838
5397
  PageSize?: number;
4839
5398
  /**
5399
+ * @public
4840
5400
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4841
5401
  */
4842
5402
  PageToken?: string;
@@ -4846,10 +5406,12 @@ export interface ListRecordHistoryInput {
4846
5406
  */
4847
5407
  export interface ListRecordHistoryOutput {
4848
5408
  /**
5409
+ * @public
4849
5410
  * <p>The records, in reverse chronological order.</p>
4850
5411
  */
4851
5412
  RecordDetails?: RecordDetail[];
4852
5413
  /**
5414
+ * @public
4853
5415
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4854
5416
  */
4855
5417
  NextPageToken?: string;
@@ -4859,10 +5421,12 @@ export interface ListRecordHistoryOutput {
4859
5421
  */
4860
5422
  export interface ListResourcesForTagOptionInput {
4861
5423
  /**
5424
+ * @public
4862
5425
  * <p>The TagOption identifier.</p>
4863
5426
  */
4864
5427
  TagOptionId: string | undefined;
4865
5428
  /**
5429
+ * @public
4866
5430
  * <p>The resource type.</p>
4867
5431
  * <ul>
4868
5432
  * <li>
@@ -4879,10 +5443,12 @@ export interface ListResourcesForTagOptionInput {
4879
5443
  */
4880
5444
  ResourceType?: string;
4881
5445
  /**
5446
+ * @public
4882
5447
  * <p>The maximum number of items to return with this call.</p>
4883
5448
  */
4884
5449
  PageSize?: number;
4885
5450
  /**
5451
+ * @public
4886
5452
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4887
5453
  */
4888
5454
  PageToken?: string;
@@ -4893,22 +5459,27 @@ export interface ListResourcesForTagOptionInput {
4893
5459
  */
4894
5460
  export interface ResourceDetail {
4895
5461
  /**
5462
+ * @public
4896
5463
  * <p>The identifier of the resource.</p>
4897
5464
  */
4898
5465
  Id?: string;
4899
5466
  /**
5467
+ * @public
4900
5468
  * <p>The ARN of the resource.</p>
4901
5469
  */
4902
5470
  ARN?: string;
4903
5471
  /**
5472
+ * @public
4904
5473
  * <p>The name of the resource.</p>
4905
5474
  */
4906
5475
  Name?: string;
4907
5476
  /**
5477
+ * @public
4908
5478
  * <p>The description of the resource.</p>
4909
5479
  */
4910
5480
  Description?: string;
4911
5481
  /**
5482
+ * @public
4912
5483
  * <p>The creation time of the resource.</p>
4913
5484
  */
4914
5485
  CreatedTime?: Date;
@@ -4918,10 +5489,12 @@ export interface ResourceDetail {
4918
5489
  */
4919
5490
  export interface ListResourcesForTagOptionOutput {
4920
5491
  /**
5492
+ * @public
4921
5493
  * <p>Information about the resources.</p>
4922
5494
  */
4923
5495
  ResourceDetails?: ResourceDetail[];
4924
5496
  /**
5497
+ * @public
4925
5498
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4926
5499
  */
4927
5500
  PageToken?: string;
@@ -4931,6 +5504,7 @@ export interface ListResourcesForTagOptionOutput {
4931
5504
  */
4932
5505
  export interface ListServiceActionsInput {
4933
5506
  /**
5507
+ * @public
4934
5508
  * <p>The language code.</p>
4935
5509
  * <ul>
4936
5510
  * <li>
@@ -4945,10 +5519,12 @@ export interface ListServiceActionsInput {
4945
5519
  */
4946
5520
  AcceptLanguage?: string;
4947
5521
  /**
5522
+ * @public
4948
5523
  * <p>The maximum number of items to return with this call.</p>
4949
5524
  */
4950
5525
  PageSize?: number;
4951
5526
  /**
5527
+ * @public
4952
5528
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4953
5529
  */
4954
5530
  PageToken?: string;
@@ -4958,10 +5534,12 @@ export interface ListServiceActionsInput {
4958
5534
  */
4959
5535
  export interface ListServiceActionsOutput {
4960
5536
  /**
5537
+ * @public
4961
5538
  * <p>An object containing information about the service actions associated with the provisioning artifact.</p>
4962
5539
  */
4963
5540
  ServiceActionSummaries?: ServiceActionSummary[];
4964
5541
  /**
5542
+ * @public
4965
5543
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
4966
5544
  */
4967
5545
  NextPageToken?: string;
@@ -4971,22 +5549,27 @@ export interface ListServiceActionsOutput {
4971
5549
  */
4972
5550
  export interface ListServiceActionsForProvisioningArtifactInput {
4973
5551
  /**
5552
+ * @public
4974
5553
  * <p>The product identifier. For example, <code>prod-abcdzk7xy33qa</code>.</p>
4975
5554
  */
4976
5555
  ProductId: string | undefined;
4977
5556
  /**
5557
+ * @public
4978
5558
  * <p>The identifier of the provisioning artifact. For example, <code>pa-4abcdjnxjj6ne</code>.</p>
4979
5559
  */
4980
5560
  ProvisioningArtifactId: string | undefined;
4981
5561
  /**
5562
+ * @public
4982
5563
  * <p>The maximum number of items to return with this call.</p>
4983
5564
  */
4984
5565
  PageSize?: number;
4985
5566
  /**
5567
+ * @public
4986
5568
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
4987
5569
  */
4988
5570
  PageToken?: string;
4989
5571
  /**
5572
+ * @public
4990
5573
  * <p>The language code.</p>
4991
5574
  * <ul>
4992
5575
  * <li>
@@ -5006,10 +5589,12 @@ export interface ListServiceActionsForProvisioningArtifactInput {
5006
5589
  */
5007
5590
  export interface ListServiceActionsForProvisioningArtifactOutput {
5008
5591
  /**
5592
+ * @public
5009
5593
  * <p>An object containing information about the self-service actions associated with the provisioning artifact.</p>
5010
5594
  */
5011
5595
  ServiceActionSummaries?: ServiceActionSummary[];
5012
5596
  /**
5597
+ * @public
5013
5598
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
5014
5599
  */
5015
5600
  NextPageToken?: string;
@@ -5019,6 +5604,7 @@ export interface ListServiceActionsForProvisioningArtifactOutput {
5019
5604
  */
5020
5605
  export interface ListStackInstancesForProvisionedProductInput {
5021
5606
  /**
5607
+ * @public
5022
5608
  * <p>The language code.</p>
5023
5609
  * <ul>
5024
5610
  * <li>
@@ -5033,14 +5619,17 @@ export interface ListStackInstancesForProvisionedProductInput {
5033
5619
  */
5034
5620
  AcceptLanguage?: string;
5035
5621
  /**
5622
+ * @public
5036
5623
  * <p>The identifier of the provisioned product.</p>
5037
5624
  */
5038
5625
  ProvisionedProductId: string | undefined;
5039
5626
  /**
5627
+ * @public
5040
5628
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
5041
5629
  */
5042
5630
  PageToken?: string;
5043
5631
  /**
5632
+ * @public
5044
5633
  * <p>The maximum number of items to return with this call.</p>
5045
5634
  */
5046
5635
  PageSize?: number;
@@ -5064,14 +5653,17 @@ export type StackInstanceStatus = (typeof StackInstanceStatus)[keyof typeof Stac
5064
5653
  */
5065
5654
  export interface StackInstance {
5066
5655
  /**
5656
+ * @public
5067
5657
  * <p>The name of the Amazon Web Services account that the stack instance is associated with.</p>
5068
5658
  */
5069
5659
  Account?: string;
5070
5660
  /**
5661
+ * @public
5071
5662
  * <p>The name of the Amazon Web Services Region that the stack instance is associated with.</p>
5072
5663
  */
5073
5664
  Region?: string;
5074
5665
  /**
5666
+ * @public
5075
5667
  * <p>The status of the stack instance, in terms of its synchronization with its associated stack set. </p>
5076
5668
  * <ul>
5077
5669
  * <li>
@@ -5097,10 +5689,12 @@ export interface StackInstance {
5097
5689
  */
5098
5690
  export interface ListStackInstancesForProvisionedProductOutput {
5099
5691
  /**
5692
+ * @public
5100
5693
  * <p>List of stack instances.</p>
5101
5694
  */
5102
5695
  StackInstances?: StackInstance[];
5103
5696
  /**
5697
+ * @public
5104
5698
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
5105
5699
  */
5106
5700
  NextPageToken?: string;
@@ -5111,14 +5705,17 @@ export interface ListStackInstancesForProvisionedProductOutput {
5111
5705
  */
5112
5706
  export interface ListTagOptionsFilters {
5113
5707
  /**
5708
+ * @public
5114
5709
  * <p>The TagOption key.</p>
5115
5710
  */
5116
5711
  Key?: string;
5117
5712
  /**
5713
+ * @public
5118
5714
  * <p>The TagOption value.</p>
5119
5715
  */
5120
5716
  Value?: string;
5121
5717
  /**
5718
+ * @public
5122
5719
  * <p>The active state.</p>
5123
5720
  */
5124
5721
  Active?: boolean;
@@ -5128,14 +5725,17 @@ export interface ListTagOptionsFilters {
5128
5725
  */
5129
5726
  export interface ListTagOptionsInput {
5130
5727
  /**
5728
+ * @public
5131
5729
  * <p>The search filters. If no search filters are specified, the output includes all TagOptions.</p>
5132
5730
  */
5133
5731
  Filters?: ListTagOptionsFilters;
5134
5732
  /**
5733
+ * @public
5135
5734
  * <p>The maximum number of items to return with this call.</p>
5136
5735
  */
5137
5736
  PageSize?: number;
5138
5737
  /**
5738
+ * @public
5139
5739
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
5140
5740
  */
5141
5741
  PageToken?: string;
@@ -5145,10 +5745,12 @@ export interface ListTagOptionsInput {
5145
5745
  */
5146
5746
  export interface ListTagOptionsOutput {
5147
5747
  /**
5748
+ * @public
5148
5749
  * <p>Information about the TagOptions.</p>
5149
5750
  */
5150
5751
  TagOptionDetails?: TagOptionDetail[];
5151
5752
  /**
5753
+ * @public
5152
5754
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
5153
5755
  */
5154
5756
  PageToken?: string;
@@ -5163,6 +5765,7 @@ export interface ListTagOptionsOutput {
5163
5765
  */
5164
5766
  export interface UniqueTagResourceIdentifier {
5165
5767
  /**
5768
+ * @public
5166
5769
  * <p>
5167
5770
  * A unique key
5168
5771
  * that's attached
@@ -5171,6 +5774,7 @@ export interface UniqueTagResourceIdentifier {
5171
5774
  */
5172
5775
  Key?: string;
5173
5776
  /**
5777
+ * @public
5174
5778
  * <p>
5175
5779
  * A unique value
5176
5780
  * that's attached
@@ -5190,6 +5794,7 @@ export interface UniqueTagResourceIdentifier {
5190
5794
  */
5191
5795
  export interface EngineWorkflowResourceIdentifier {
5192
5796
  /**
5797
+ * @public
5193
5798
  * <p>
5194
5799
  * The unique key-value pair
5195
5800
  * for a tag
@@ -5215,6 +5820,7 @@ export type EngineWorkflowStatus = (typeof EngineWorkflowStatus)[keyof typeof En
5215
5820
  */
5216
5821
  export interface NotifyProvisionProductEngineWorkflowResultInput {
5217
5822
  /**
5823
+ * @public
5218
5824
  * <p>
5219
5825
  * The encrypted contents
5220
5826
  * of the provisioning engine execution payload
@@ -5224,6 +5830,7 @@ export interface NotifyProvisionProductEngineWorkflowResultInput {
5224
5830
  */
5225
5831
  WorkflowToken: string | undefined;
5226
5832
  /**
5833
+ * @public
5227
5834
  * <p>
5228
5835
  * The identifier
5229
5836
  * of the record.
@@ -5231,6 +5838,7 @@ export interface NotifyProvisionProductEngineWorkflowResultInput {
5231
5838
  */
5232
5839
  RecordId: string | undefined;
5233
5840
  /**
5841
+ * @public
5234
5842
  * <p>
5235
5843
  * The status
5236
5844
  * of the provisioning engine execution.
@@ -5238,6 +5846,7 @@ export interface NotifyProvisionProductEngineWorkflowResultInput {
5238
5846
  */
5239
5847
  Status: EngineWorkflowStatus | string | undefined;
5240
5848
  /**
5849
+ * @public
5241
5850
  * <p>
5242
5851
  * The reason
5243
5852
  * why the provisioning engine execution failed.
@@ -5245,6 +5854,7 @@ export interface NotifyProvisionProductEngineWorkflowResultInput {
5245
5854
  */
5246
5855
  FailureReason?: string;
5247
5856
  /**
5857
+ * @public
5248
5858
  * <p>
5249
5859
  * The ID
5250
5860
  * for the provisioned product resources
@@ -5254,6 +5864,7 @@ export interface NotifyProvisionProductEngineWorkflowResultInput {
5254
5864
  */
5255
5865
  ResourceIdentifier?: EngineWorkflowResourceIdentifier;
5256
5866
  /**
5867
+ * @public
5257
5868
  * <p>
5258
5869
  * The output
5259
5870
  * of the provisioning engine execution.
@@ -5261,6 +5872,7 @@ export interface NotifyProvisionProductEngineWorkflowResultInput {
5261
5872
  */
5262
5873
  Outputs?: RecordOutput[];
5263
5874
  /**
5875
+ * @public
5264
5876
  * <p>
5265
5877
  * The idempotency token
5266
5878
  * that identifies the provisioning engine execution.
@@ -5278,6 +5890,7 @@ export interface NotifyProvisionProductEngineWorkflowResultOutput {
5278
5890
  */
5279
5891
  export interface NotifyTerminateProvisionedProductEngineWorkflowResultInput {
5280
5892
  /**
5893
+ * @public
5281
5894
  * <p>
5282
5895
  * The encrypted contents
5283
5896
  * of the terminate engine execution payload
@@ -5287,6 +5900,7 @@ export interface NotifyTerminateProvisionedProductEngineWorkflowResultInput {
5287
5900
  */
5288
5901
  WorkflowToken: string | undefined;
5289
5902
  /**
5903
+ * @public
5290
5904
  * <p>
5291
5905
  * The identifier
5292
5906
  * of the record.
@@ -5294,6 +5908,7 @@ export interface NotifyTerminateProvisionedProductEngineWorkflowResultInput {
5294
5908
  */
5295
5909
  RecordId: string | undefined;
5296
5910
  /**
5911
+ * @public
5297
5912
  * <p>
5298
5913
  * The status
5299
5914
  * of the terminate engine execution.
@@ -5301,6 +5916,7 @@ export interface NotifyTerminateProvisionedProductEngineWorkflowResultInput {
5301
5916
  */
5302
5917
  Status: EngineWorkflowStatus | string | undefined;
5303
5918
  /**
5919
+ * @public
5304
5920
  * <p>
5305
5921
  * The reason
5306
5922
  * why the terminate engine execution failed.
@@ -5308,6 +5924,7 @@ export interface NotifyTerminateProvisionedProductEngineWorkflowResultInput {
5308
5924
  */
5309
5925
  FailureReason?: string;
5310
5926
  /**
5927
+ * @public
5311
5928
  * <p>
5312
5929
  * The idempotency token
5313
5930
  * that identifies the terminate engine execution.
@@ -5325,6 +5942,7 @@ export interface NotifyTerminateProvisionedProductEngineWorkflowResultOutput {
5325
5942
  */
5326
5943
  export interface NotifyUpdateProvisionedProductEngineWorkflowResultInput {
5327
5944
  /**
5945
+ * @public
5328
5946
  * <p>
5329
5947
  * The encrypted contents
5330
5948
  * of the update engine execution payload
@@ -5334,6 +5952,7 @@ export interface NotifyUpdateProvisionedProductEngineWorkflowResultInput {
5334
5952
  */
5335
5953
  WorkflowToken: string | undefined;
5336
5954
  /**
5955
+ * @public
5337
5956
  * <p>
5338
5957
  * The identifier
5339
5958
  * of the record.
@@ -5341,6 +5960,7 @@ export interface NotifyUpdateProvisionedProductEngineWorkflowResultInput {
5341
5960
  */
5342
5961
  RecordId: string | undefined;
5343
5962
  /**
5963
+ * @public
5344
5964
  * <p>
5345
5965
  * The status
5346
5966
  * of the update engine execution.
@@ -5348,6 +5968,7 @@ export interface NotifyUpdateProvisionedProductEngineWorkflowResultInput {
5348
5968
  */
5349
5969
  Status: EngineWorkflowStatus | string | undefined;
5350
5970
  /**
5971
+ * @public
5351
5972
  * <p>
5352
5973
  * The reason
5353
5974
  * why the update engine execution failed.
@@ -5355,6 +5976,7 @@ export interface NotifyUpdateProvisionedProductEngineWorkflowResultInput {
5355
5976
  */
5356
5977
  FailureReason?: string;
5357
5978
  /**
5979
+ * @public
5358
5980
  * <p>
5359
5981
  * The output
5360
5982
  * of the update engine execution.
@@ -5362,6 +5984,7 @@ export interface NotifyUpdateProvisionedProductEngineWorkflowResultInput {
5362
5984
  */
5363
5985
  Outputs?: RecordOutput[];
5364
5986
  /**
5987
+ * @public
5365
5988
  * <p>
5366
5989
  * The idempotency token
5367
5990
  * that identifies the update engine execution.
@@ -5380,10 +6003,12 @@ export interface NotifyUpdateProvisionedProductEngineWorkflowResultOutput {
5380
6003
  */
5381
6004
  export interface ProvisioningParameter {
5382
6005
  /**
6006
+ * @public
5383
6007
  * <p>The parameter key.</p>
5384
6008
  */
5385
6009
  Key?: string;
5386
6010
  /**
6011
+ * @public
5387
6012
  * <p>The parameter value.</p>
5388
6013
  */
5389
6014
  Value?: string;
@@ -5403,6 +6028,7 @@ export interface ProvisioningParameter {
5403
6028
  */
5404
6029
  export interface ProvisioningPreferences {
5405
6030
  /**
6031
+ * @public
5406
6032
  * <p>One or more Amazon Web Services accounts where the provisioned product will be available.</p>
5407
6033
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
5408
6034
  * <p>The specified accounts should be within the list of accounts from the <code>STACKSET</code> constraint. To get the list of accounts in the <code>STACKSET</code> constraint, use the <code>DescribeProvisioningParameters</code> operation.</p>
@@ -5410,6 +6036,7 @@ export interface ProvisioningPreferences {
5410
6036
  */
5411
6037
  StackSetAccounts?: string[];
5412
6038
  /**
6039
+ * @public
5413
6040
  * <p>One or more Amazon Web Services Regions where the provisioned product will be available.</p>
5414
6041
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
5415
6042
  * <p>The specified Regions should be within the list of Regions from the <code>STACKSET</code> constraint. To get the list of Regions in the <code>STACKSET</code> constraint, use the <code>DescribeProvisioningParameters</code> operation.</p>
@@ -5417,6 +6044,7 @@ export interface ProvisioningPreferences {
5417
6044
  */
5418
6045
  StackSetRegions?: string[];
5419
6046
  /**
6047
+ * @public
5420
6048
  * <p>The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.</p>
5421
6049
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
5422
6050
  * <p>Conditional: You must specify either <code>StackSetFailureToleranceCount</code> or <code>StackSetFailureTolerancePercentage</code>, but not both.</p>
@@ -5424,6 +6052,7 @@ export interface ProvisioningPreferences {
5424
6052
  */
5425
6053
  StackSetFailureToleranceCount?: number;
5426
6054
  /**
6055
+ * @public
5427
6056
  * <p>The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.</p>
5428
6057
  * <p>When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.</p>
5429
6058
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
@@ -5431,6 +6060,7 @@ export interface ProvisioningPreferences {
5431
6060
  */
5432
6061
  StackSetFailureTolerancePercentage?: number;
5433
6062
  /**
6063
+ * @public
5434
6064
  * <p>The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of <code>StackSetFailureToleranceCount</code>. <code>StackSetMaxConcurrentCount</code> is at most one more than the <code>StackSetFailureToleranceCount</code>.</p>
5435
6065
  * <p>Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p>
5436
6066
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
@@ -5438,6 +6068,7 @@ export interface ProvisioningPreferences {
5438
6068
  */
5439
6069
  StackSetMaxConcurrencyCount?: number;
5440
6070
  /**
6071
+ * @public
5441
6072
  * <p>The maximum percentage of accounts in which to perform this operation at one time.</p>
5442
6073
  * <p>When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as <code>1</code> instead.</p>
5443
6074
  * <p>Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p>
@@ -5451,6 +6082,7 @@ export interface ProvisioningPreferences {
5451
6082
  */
5452
6083
  export interface ProvisionProductInput {
5453
6084
  /**
6085
+ * @public
5454
6086
  * <p>The language code.</p>
5455
6087
  * <ul>
5456
6088
  * <li>
@@ -5465,55 +6097,67 @@ export interface ProvisionProductInput {
5465
6097
  */
5466
6098
  AcceptLanguage?: string;
5467
6099
  /**
6100
+ * @public
5468
6101
  * <p>The product identifier. You must provide the name or ID, but not both.</p>
5469
6102
  */
5470
6103
  ProductId?: string;
5471
6104
  /**
6105
+ * @public
5472
6106
  * <p>The name of the product. You must provide the name or ID, but not both.</p>
5473
6107
  */
5474
6108
  ProductName?: string;
5475
6109
  /**
6110
+ * @public
5476
6111
  * <p>The identifier of the provisioning artifact. You must provide the name or ID, but not both.</p>
5477
6112
  */
5478
6113
  ProvisioningArtifactId?: string;
5479
6114
  /**
6115
+ * @public
5480
6116
  * <p>The name of the provisioning artifact. You must provide the name or ID, but not both.</p>
5481
6117
  */
5482
6118
  ProvisioningArtifactName?: string;
5483
6119
  /**
6120
+ * @public
5484
6121
  * <p>The path identifier of the product. This value is optional if the product
5485
6122
  * has a default path, and required if the product has more than one path.
5486
6123
  * To list the paths for a product, use <a>ListLaunchPaths</a>. You must provide the name or ID, but not both.</p>
5487
6124
  */
5488
6125
  PathId?: string;
5489
6126
  /**
6127
+ * @public
5490
6128
  * <p>The name of the path. You must provide the name or ID, but not both.</p>
5491
6129
  */
5492
6130
  PathName?: string;
5493
6131
  /**
6132
+ * @public
5494
6133
  * <p>A user-friendly name for the provisioned product. This value must be
5495
6134
  * unique for the Amazon Web Services account and cannot be updated after the product is provisioned.</p>
5496
6135
  */
5497
6136
  ProvisionedProductName: string | undefined;
5498
6137
  /**
6138
+ * @public
5499
6139
  * <p>Parameters specified by the administrator that are required for provisioning the
5500
6140
  * product.</p>
5501
6141
  */
5502
6142
  ProvisioningParameters?: ProvisioningParameter[];
5503
6143
  /**
6144
+ * @public
5504
6145
  * <p>An object that contains information about the provisioning preferences for a stack set.</p>
5505
6146
  */
5506
6147
  ProvisioningPreferences?: ProvisioningPreferences;
5507
6148
  /**
6149
+ * @public
5508
6150
  * <p>One or more tags.</p>
5509
6151
  */
5510
6152
  Tags?: Tag[];
5511
6153
  /**
6154
+ * @public
5512
6155
  * <p>Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related
5513
6156
  * events.</p>
5514
6157
  */
5515
6158
  NotificationArns?: string[];
5516
6159
  /**
6160
+ * @public
5517
6161
  * <p>An idempotency token that uniquely identifies the provisioning request.</p>
5518
6162
  */
5519
6163
  ProvisionToken?: string;
@@ -5523,6 +6167,7 @@ export interface ProvisionProductInput {
5523
6167
  */
5524
6168
  export interface ProvisionProductOutput {
5525
6169
  /**
6170
+ * @public
5526
6171
  * <p>Information about the result of provisioning the product.</p>
5527
6172
  */
5528
6173
  RecordDetail?: RecordDetail;
@@ -5532,6 +6177,7 @@ export interface ProvisionProductOutput {
5532
6177
  */
5533
6178
  export interface RejectPortfolioShareInput {
5534
6179
  /**
6180
+ * @public
5535
6181
  * <p>The language code.</p>
5536
6182
  * <ul>
5537
6183
  * <li>
@@ -5546,10 +6192,12 @@ export interface RejectPortfolioShareInput {
5546
6192
  */
5547
6193
  AcceptLanguage?: string;
5548
6194
  /**
6195
+ * @public
5549
6196
  * <p>The portfolio identifier.</p>
5550
6197
  */
5551
6198
  PortfolioId: string | undefined;
5552
6199
  /**
6200
+ * @public
5553
6201
  * <p>The type of shared portfolios to reject. The default is to reject imported portfolios.</p>
5554
6202
  * <ul>
5555
6203
  * <li>
@@ -5581,6 +6229,7 @@ export interface RejectPortfolioShareOutput {
5581
6229
  */
5582
6230
  export interface ScanProvisionedProductsInput {
5583
6231
  /**
6232
+ * @public
5584
6233
  * <p>The language code.</p>
5585
6234
  * <ul>
5586
6235
  * <li>
@@ -5595,14 +6244,17 @@ export interface ScanProvisionedProductsInput {
5595
6244
  */
5596
6245
  AcceptLanguage?: string;
5597
6246
  /**
6247
+ * @public
5598
6248
  * <p>The access level to use to obtain results. The default is <code>User</code>.</p>
5599
6249
  */
5600
6250
  AccessLevelFilter?: AccessLevelFilter;
5601
6251
  /**
6252
+ * @public
5602
6253
  * <p>The maximum number of items to return with this call.</p>
5603
6254
  */
5604
6255
  PageSize?: number;
5605
6256
  /**
6257
+ * @public
5606
6258
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
5607
6259
  */
5608
6260
  PageToken?: string;
@@ -5612,10 +6264,12 @@ export interface ScanProvisionedProductsInput {
5612
6264
  */
5613
6265
  export interface ScanProvisionedProductsOutput {
5614
6266
  /**
6267
+ * @public
5615
6268
  * <p>Information about the provisioned products.</p>
5616
6269
  */
5617
6270
  ProvisionedProducts?: ProvisionedProductDetail[];
5618
6271
  /**
6272
+ * @public
5619
6273
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
5620
6274
  */
5621
6275
  NextPageToken?: string;
@@ -5664,6 +6318,7 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
5664
6318
  */
5665
6319
  export interface SearchProductsInput {
5666
6320
  /**
6321
+ * @public
5667
6322
  * <p>The language code.</p>
5668
6323
  * <ul>
5669
6324
  * <li>
@@ -5678,23 +6333,28 @@ export interface SearchProductsInput {
5678
6333
  */
5679
6334
  AcceptLanguage?: string;
5680
6335
  /**
6336
+ * @public
5681
6337
  * <p>The search filters. If no search filters are specified, the output includes
5682
6338
  * all products to which the caller has access.</p>
5683
6339
  */
5684
6340
  Filters?: Record<string, string[]>;
5685
6341
  /**
6342
+ * @public
5686
6343
  * <p>The maximum number of items to return with this call.</p>
5687
6344
  */
5688
6345
  PageSize?: number;
5689
6346
  /**
6347
+ * @public
5690
6348
  * <p>The sort field. If no value is specified, the results are not sorted.</p>
5691
6349
  */
5692
6350
  SortBy?: ProductViewSortBy | string;
5693
6351
  /**
6352
+ * @public
5694
6353
  * <p>The sort order. If no value is specified, the results are not sorted.</p>
5695
6354
  */
5696
6355
  SortOrder?: SortOrder | string;
5697
6356
  /**
6357
+ * @public
5698
6358
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
5699
6359
  */
5700
6360
  PageToken?: string;
@@ -5706,10 +6366,12 @@ export interface SearchProductsInput {
5706
6366
  */
5707
6367
  export interface ProductViewAggregationValue {
5708
6368
  /**
6369
+ * @public
5709
6370
  * <p>The value of the product view aggregation.</p>
5710
6371
  */
5711
6372
  Value?: string;
5712
6373
  /**
6374
+ * @public
5713
6375
  * <p>An approximate count of the products that match the value.</p>
5714
6376
  */
5715
6377
  ApproximateCount?: number;
@@ -5719,14 +6381,17 @@ export interface ProductViewAggregationValue {
5719
6381
  */
5720
6382
  export interface SearchProductsOutput {
5721
6383
  /**
6384
+ * @public
5722
6385
  * <p>Information about the product views.</p>
5723
6386
  */
5724
6387
  ProductViewSummaries?: ProductViewSummary[];
5725
6388
  /**
6389
+ * @public
5726
6390
  * <p>The product view aggregations.</p>
5727
6391
  */
5728
6392
  ProductViewAggregations?: Record<string, ProductViewAggregationValue[]>;
5729
6393
  /**
6394
+ * @public
5730
6395
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
5731
6396
  */
5732
6397
  NextPageToken?: string;
@@ -5747,6 +6412,7 @@ export type ProductSource = (typeof ProductSource)[keyof typeof ProductSource];
5747
6412
  */
5748
6413
  export interface SearchProductsAsAdminInput {
5749
6414
  /**
6415
+ * @public
5750
6416
  * <p>The language code.</p>
5751
6417
  * <ul>
5752
6418
  * <li>
@@ -5761,31 +6427,38 @@ export interface SearchProductsAsAdminInput {
5761
6427
  */
5762
6428
  AcceptLanguage?: string;
5763
6429
  /**
6430
+ * @public
5764
6431
  * <p>The portfolio identifier.</p>
5765
6432
  */
5766
6433
  PortfolioId?: string;
5767
6434
  /**
6435
+ * @public
5768
6436
  * <p>The search filters. If no search filters are specified, the output includes all products
5769
6437
  * to which the administrator has access.</p>
5770
6438
  */
5771
6439
  Filters?: Record<string, string[]>;
5772
6440
  /**
6441
+ * @public
5773
6442
  * <p>The sort field. If no value is specified, the results are not sorted.</p>
5774
6443
  */
5775
6444
  SortBy?: ProductViewSortBy | string;
5776
6445
  /**
6446
+ * @public
5777
6447
  * <p>The sort order. If no value is specified, the results are not sorted.</p>
5778
6448
  */
5779
6449
  SortOrder?: SortOrder | string;
5780
6450
  /**
6451
+ * @public
5781
6452
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
5782
6453
  */
5783
6454
  PageToken?: string;
5784
6455
  /**
6456
+ * @public
5785
6457
  * <p>The maximum number of items to return with this call.</p>
5786
6458
  */
5787
6459
  PageSize?: number;
5788
6460
  /**
6461
+ * @public
5789
6462
  * <p>Access level of the source of the product.</p>
5790
6463
  */
5791
6464
  ProductSource?: ProductSource | string;
@@ -5795,10 +6468,12 @@ export interface SearchProductsAsAdminInput {
5795
6468
  */
5796
6469
  export interface SearchProductsAsAdminOutput {
5797
6470
  /**
6471
+ * @public
5798
6472
  * <p>Information about the product views.</p>
5799
6473
  */
5800
6474
  ProductViewDetails?: ProductViewDetail[];
5801
6475
  /**
6476
+ * @public
5802
6477
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
5803
6478
  */
5804
6479
  NextPageToken?: string;
@@ -5819,6 +6494,7 @@ export type ProvisionedProductViewFilterBy = (typeof ProvisionedProductViewFilte
5819
6494
  */
5820
6495
  export interface SearchProvisionedProductsInput {
5821
6496
  /**
6497
+ * @public
5822
6498
  * <p>The language code.</p>
5823
6499
  * <ul>
5824
6500
  * <li>
@@ -5833,10 +6509,12 @@ export interface SearchProvisionedProductsInput {
5833
6509
  */
5834
6510
  AcceptLanguage?: string;
5835
6511
  /**
6512
+ * @public
5836
6513
  * <p>The access level to use to obtain results. The default is <code>User</code>.</p>
5837
6514
  */
5838
6515
  AccessLevelFilter?: AccessLevelFilter;
5839
6516
  /**
6517
+ * @public
5840
6518
  * <p>The search filters.</p>
5841
6519
  * <p>When the key is <code>SearchQuery</code>, the searchable fields are <code>arn</code>,
5842
6520
  * <code>createdTime</code>, <code>id</code>, <code>lastRecordId</code>,
@@ -5849,19 +6527,23 @@ export interface SearchProvisionedProductsInput {
5849
6527
  */
5850
6528
  Filters?: Record<string, string[]>;
5851
6529
  /**
6530
+ * @public
5852
6531
  * <p>The sort field. If no value is specified, the results are not sorted. The valid values are <code>arn</code>, <code>id</code>, <code>name</code>,
5853
6532
  * and <code>lastRecordId</code>.</p>
5854
6533
  */
5855
6534
  SortBy?: string;
5856
6535
  /**
6536
+ * @public
5857
6537
  * <p>The sort order. If no value is specified, the results are not sorted.</p>
5858
6538
  */
5859
6539
  SortOrder?: SortOrder | string;
5860
6540
  /**
6541
+ * @public
5861
6542
  * <p>The maximum number of items to return with this call.</p>
5862
6543
  */
5863
6544
  PageSize?: number;
5864
6545
  /**
6546
+ * @public
5865
6547
  * <p>The page token for the next set of results. To retrieve the first set of results, use null.</p>
5866
6548
  */
5867
6549
  PageToken?: string;
@@ -5872,22 +6554,27 @@ export interface SearchProvisionedProductsInput {
5872
6554
  */
5873
6555
  export interface ProvisionedProductAttribute {
5874
6556
  /**
6557
+ * @public
5875
6558
  * <p>The user-friendly name of the provisioned product.</p>
5876
6559
  */
5877
6560
  Name?: string;
5878
6561
  /**
6562
+ * @public
5879
6563
  * <p>The ARN of the provisioned product.</p>
5880
6564
  */
5881
6565
  Arn?: string;
5882
6566
  /**
6567
+ * @public
5883
6568
  * <p>The type of provisioned product. The supported values are <code>CFN_STACK</code> and <code>CFN_STACKSET</code>.</p>
5884
6569
  */
5885
6570
  Type?: string;
5886
6571
  /**
6572
+ * @public
5887
6573
  * <p>The identifier of the provisioned product.</p>
5888
6574
  */
5889
6575
  Id?: string;
5890
6576
  /**
6577
+ * @public
5891
6578
  * <p>The current status of the provisioned product.</p>
5892
6579
  * <ul>
5893
6580
  * <li>
@@ -5920,23 +6607,28 @@ export interface ProvisionedProductAttribute {
5920
6607
  */
5921
6608
  Status?: ProvisionedProductStatus | string;
5922
6609
  /**
6610
+ * @public
5923
6611
  * <p>The current status message of the provisioned product.</p>
5924
6612
  */
5925
6613
  StatusMessage?: string;
5926
6614
  /**
6615
+ * @public
5927
6616
  * <p>The UTC time stamp of the creation time.</p>
5928
6617
  */
5929
6618
  CreatedTime?: Date;
5930
6619
  /**
6620
+ * @public
5931
6621
  * <p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,
5932
6622
  * the same response is returned for each repeated request.</p>
5933
6623
  */
5934
6624
  IdempotencyToken?: string;
5935
6625
  /**
6626
+ * @public
5936
6627
  * <p>The record identifier of the last request performed on this provisioned product.</p>
5937
6628
  */
5938
6629
  LastRecordId?: string;
5939
6630
  /**
6631
+ * @public
5940
6632
  * <p>The record identifier of the last request performed on this provisioned product of the following types:</p>
5941
6633
  * <ul>
5942
6634
  * <li>
@@ -5963,6 +6655,7 @@ export interface ProvisionedProductAttribute {
5963
6655
  */
5964
6656
  LastProvisioningRecordId?: string;
5965
6657
  /**
6658
+ * @public
5966
6659
  * <p>The record identifier of the last successful request performed on this provisioned product of the following types:</p>
5967
6660
  * <ul>
5968
6661
  * <li>
@@ -5989,34 +6682,42 @@ export interface ProvisionedProductAttribute {
5989
6682
  */
5990
6683
  LastSuccessfulProvisioningRecordId?: string;
5991
6684
  /**
6685
+ * @public
5992
6686
  * <p>One or more tags.</p>
5993
6687
  */
5994
6688
  Tags?: Tag[];
5995
6689
  /**
6690
+ * @public
5996
6691
  * <p>The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.</p>
5997
6692
  */
5998
6693
  PhysicalId?: string;
5999
6694
  /**
6695
+ * @public
6000
6696
  * <p>The product identifier.</p>
6001
6697
  */
6002
6698
  ProductId?: string;
6003
6699
  /**
6700
+ * @public
6004
6701
  * <p>The name of the product.</p>
6005
6702
  */
6006
6703
  ProductName?: string;
6007
6704
  /**
6705
+ * @public
6008
6706
  * <p>The identifier of the provisioning artifact.</p>
6009
6707
  */
6010
6708
  ProvisioningArtifactId?: string;
6011
6709
  /**
6710
+ * @public
6012
6711
  * <p>The name of the provisioning artifact.</p>
6013
6712
  */
6014
6713
  ProvisioningArtifactName?: string;
6015
6714
  /**
6715
+ * @public
6016
6716
  * <p>The Amazon Resource Name (ARN) of the user.</p>
6017
6717
  */
6018
6718
  UserArn?: string;
6019
6719
  /**
6720
+ * @public
6020
6721
  * <p>The ARN of the user in the session. This ARN might contain a session ID.</p>
6021
6722
  */
6022
6723
  UserArnSession?: string;
@@ -6026,14 +6727,17 @@ export interface ProvisionedProductAttribute {
6026
6727
  */
6027
6728
  export interface SearchProvisionedProductsOutput {
6028
6729
  /**
6730
+ * @public
6029
6731
  * <p>Information about the provisioned products.</p>
6030
6732
  */
6031
6733
  ProvisionedProducts?: ProvisionedProductAttribute[];
6032
6734
  /**
6735
+ * @public
6033
6736
  * <p>The number of provisioned products found.</p>
6034
6737
  */
6035
6738
  TotalResultsCount?: number;
6036
6739
  /**
6740
+ * @public
6037
6741
  * <p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>
6038
6742
  */
6039
6743
  NextPageToken?: string;
@@ -6043,16 +6747,19 @@ export interface SearchProvisionedProductsOutput {
6043
6747
  */
6044
6748
  export interface TerminateProvisionedProductInput {
6045
6749
  /**
6750
+ * @public
6046
6751
  * <p>The name of the provisioned product. You cannot specify both
6047
6752
  * <code>ProvisionedProductName</code> and <code>ProvisionedProductId</code>.</p>
6048
6753
  */
6049
6754
  ProvisionedProductName?: string;
6050
6755
  /**
6756
+ * @public
6051
6757
  * <p>The identifier of the provisioned product. You cannot specify both
6052
6758
  * <code>ProvisionedProductName</code> and <code>ProvisionedProductId</code>.</p>
6053
6759
  */
6054
6760
  ProvisionedProductId?: string;
6055
6761
  /**
6762
+ * @public
6056
6763
  * <p>An idempotency token that uniquely identifies the termination request. This token is
6057
6764
  * only valid during the termination process. After the provisioned product is terminated,
6058
6765
  * subsequent requests to terminate the same provisioned product always return
@@ -6060,11 +6767,13 @@ export interface TerminateProvisionedProductInput {
6060
6767
  */
6061
6768
  TerminateToken?: string;
6062
6769
  /**
6770
+ * @public
6063
6771
  * <p>If set to true, Service Catalog stops managing the specified provisioned product even
6064
6772
  * if it cannot delete the underlying resources.</p>
6065
6773
  */
6066
6774
  IgnoreErrors?: boolean;
6067
6775
  /**
6776
+ * @public
6068
6777
  * <p>The language code.</p>
6069
6778
  * <ul>
6070
6779
  * <li>
@@ -6079,6 +6788,7 @@ export interface TerminateProvisionedProductInput {
6079
6788
  */
6080
6789
  AcceptLanguage?: string;
6081
6790
  /**
6791
+ * @public
6082
6792
  * <p>When this boolean parameter is set to true, the <code>TerminateProvisionedProduct</code> API deletes
6083
6793
  * the Service Catalog provisioned product. However, it does not remove the CloudFormation
6084
6794
  * stack, stack set, or the underlying resources of the deleted provisioned product. The
@@ -6091,6 +6801,7 @@ export interface TerminateProvisionedProductInput {
6091
6801
  */
6092
6802
  export interface TerminateProvisionedProductOutput {
6093
6803
  /**
6804
+ * @public
6094
6805
  * <p>Information about the result of this request.</p>
6095
6806
  */
6096
6807
  RecordDetail?: RecordDetail;
@@ -6100,6 +6811,7 @@ export interface TerminateProvisionedProductOutput {
6100
6811
  */
6101
6812
  export interface UpdateConstraintInput {
6102
6813
  /**
6814
+ * @public
6103
6815
  * <p>The language code.</p>
6104
6816
  * <ul>
6105
6817
  * <li>
@@ -6114,14 +6826,17 @@ export interface UpdateConstraintInput {
6114
6826
  */
6115
6827
  AcceptLanguage?: string;
6116
6828
  /**
6829
+ * @public
6117
6830
  * <p>The identifier of the constraint.</p>
6118
6831
  */
6119
6832
  Id: string | undefined;
6120
6833
  /**
6834
+ * @public
6121
6835
  * <p>The updated description of the constraint.</p>
6122
6836
  */
6123
6837
  Description?: string;
6124
6838
  /**
6839
+ * @public
6125
6840
  * <p>The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:</p>
6126
6841
  * <dl>
6127
6842
  * <dt>LAUNCH</dt>
@@ -6182,14 +6897,17 @@ export interface UpdateConstraintInput {
6182
6897
  */
6183
6898
  export interface UpdateConstraintOutput {
6184
6899
  /**
6900
+ * @public
6185
6901
  * <p>Information about the constraint.</p>
6186
6902
  */
6187
6903
  ConstraintDetail?: ConstraintDetail;
6188
6904
  /**
6905
+ * @public
6189
6906
  * <p>The constraint parameters.</p>
6190
6907
  */
6191
6908
  ConstraintParameters?: string;
6192
6909
  /**
6910
+ * @public
6193
6911
  * <p>The status of the current request.</p>
6194
6912
  */
6195
6913
  Status?: Status | string;
@@ -6199,6 +6917,7 @@ export interface UpdateConstraintOutput {
6199
6917
  */
6200
6918
  export interface UpdatePortfolioInput {
6201
6919
  /**
6920
+ * @public
6202
6921
  * <p>The language code.</p>
6203
6922
  * <ul>
6204
6923
  * <li>
@@ -6213,26 +6932,32 @@ export interface UpdatePortfolioInput {
6213
6932
  */
6214
6933
  AcceptLanguage?: string;
6215
6934
  /**
6935
+ * @public
6216
6936
  * <p>The portfolio identifier.</p>
6217
6937
  */
6218
6938
  Id: string | undefined;
6219
6939
  /**
6940
+ * @public
6220
6941
  * <p>The name to use for display purposes.</p>
6221
6942
  */
6222
6943
  DisplayName?: string;
6223
6944
  /**
6945
+ * @public
6224
6946
  * <p>The updated description of the portfolio.</p>
6225
6947
  */
6226
6948
  Description?: string;
6227
6949
  /**
6950
+ * @public
6228
6951
  * <p>The updated name of the portfolio provider.</p>
6229
6952
  */
6230
6953
  ProviderName?: string;
6231
6954
  /**
6955
+ * @public
6232
6956
  * <p>The tags to add.</p>
6233
6957
  */
6234
6958
  AddTags?: Tag[];
6235
6959
  /**
6960
+ * @public
6236
6961
  * <p>The tags to remove.</p>
6237
6962
  */
6238
6963
  RemoveTags?: string[];
@@ -6242,10 +6967,12 @@ export interface UpdatePortfolioInput {
6242
6967
  */
6243
6968
  export interface UpdatePortfolioOutput {
6244
6969
  /**
6970
+ * @public
6245
6971
  * <p>Information about the portfolio.</p>
6246
6972
  */
6247
6973
  PortfolioDetail?: PortfolioDetail;
6248
6974
  /**
6975
+ * @public
6249
6976
  * <p>Information about the tags associated with the portfolio.</p>
6250
6977
  */
6251
6978
  Tags?: Tag[];
@@ -6255,6 +6982,7 @@ export interface UpdatePortfolioOutput {
6255
6982
  */
6256
6983
  export interface UpdatePortfolioShareInput {
6257
6984
  /**
6985
+ * @public
6258
6986
  * <p>The language code.</p>
6259
6987
  * <ul>
6260
6988
  * <li>
@@ -6269,23 +6997,28 @@ export interface UpdatePortfolioShareInput {
6269
6997
  */
6270
6998
  AcceptLanguage?: string;
6271
6999
  /**
7000
+ * @public
6272
7001
  * <p>The unique identifier of the portfolio for which the share will be updated.</p>
6273
7002
  */
6274
7003
  PortfolioId: string | undefined;
6275
7004
  /**
7005
+ * @public
6276
7006
  * <p>The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.</p>
6277
7007
  */
6278
7008
  AccountId?: string;
6279
7009
  /**
7010
+ * @public
6280
7011
  * <p>Information about the organization node.</p>
6281
7012
  */
6282
7013
  OrganizationNode?: OrganizationNode;
6283
7014
  /**
7015
+ * @public
6284
7016
  * <p>Enables or disables <code>TagOptions</code> sharing for the portfolio share. If this field is not provided, the current state of
6285
7017
  * TagOptions sharing on the portfolio share will not be modified.</p>
6286
7018
  */
6287
7019
  ShareTagOptions?: boolean;
6288
7020
  /**
7021
+ * @public
6289
7022
  * <p>A flag to enables or disables <code>Principals</code> sharing in the portfolio. If this field is not provided,
6290
7023
  * the current state of the <code>Principals</code> sharing on the portfolio share will not be modified. </p>
6291
7024
  */
@@ -6296,10 +7029,12 @@ export interface UpdatePortfolioShareInput {
6296
7029
  */
6297
7030
  export interface UpdatePortfolioShareOutput {
6298
7031
  /**
7032
+ * @public
6299
7033
  * <p>The token that tracks the status of the <code>UpdatePortfolioShare</code> operation for external account to account or organizational type sharing.</p>
6300
7034
  */
6301
7035
  PortfolioShareToken?: string;
6302
7036
  /**
7037
+ * @public
6303
7038
  * <p>The status of <code>UpdatePortfolioShare</code> operation.
6304
7039
  * You can also obtain the operation status using <code>DescribePortfolioShareStatus</code> API.
6305
7040
  * </p>
@@ -6311,6 +7046,7 @@ export interface UpdatePortfolioShareOutput {
6311
7046
  */
6312
7047
  export interface UpdateProductInput {
6313
7048
  /**
7049
+ * @public
6314
7050
  * <p>The language code.</p>
6315
7051
  * <ul>
6316
7052
  * <li>
@@ -6325,46 +7061,57 @@ export interface UpdateProductInput {
6325
7061
  */
6326
7062
  AcceptLanguage?: string;
6327
7063
  /**
7064
+ * @public
6328
7065
  * <p>The product identifier.</p>
6329
7066
  */
6330
7067
  Id: string | undefined;
6331
7068
  /**
7069
+ * @public
6332
7070
  * <p>The updated product name.</p>
6333
7071
  */
6334
7072
  Name?: string;
6335
7073
  /**
7074
+ * @public
6336
7075
  * <p>The updated owner of the product.</p>
6337
7076
  */
6338
7077
  Owner?: string;
6339
7078
  /**
7079
+ * @public
6340
7080
  * <p>The updated description of the product.</p>
6341
7081
  */
6342
7082
  Description?: string;
6343
7083
  /**
7084
+ * @public
6344
7085
  * <p>The updated distributor of the product.</p>
6345
7086
  */
6346
7087
  Distributor?: string;
6347
7088
  /**
7089
+ * @public
6348
7090
  * <p>The updated support description for the product.</p>
6349
7091
  */
6350
7092
  SupportDescription?: string;
6351
7093
  /**
7094
+ * @public
6352
7095
  * <p>The updated support email for the product.</p>
6353
7096
  */
6354
7097
  SupportEmail?: string;
6355
7098
  /**
7099
+ * @public
6356
7100
  * <p>The updated support URL for the product.</p>
6357
7101
  */
6358
7102
  SupportUrl?: string;
6359
7103
  /**
7104
+ * @public
6360
7105
  * <p>The tags to add to the product.</p>
6361
7106
  */
6362
7107
  AddTags?: Tag[];
6363
7108
  /**
7109
+ * @public
6364
7110
  * <p>The tags to remove from the product.</p>
6365
7111
  */
6366
7112
  RemoveTags?: string[];
6367
7113
  /**
7114
+ * @public
6368
7115
  * <p>Specifies connection details for the updated product and syncs the product to the connection source
6369
7116
  * artifact. This automatically manages the product's artifacts based on changes to the source.
6370
7117
  * The <code>SourceConnection</code> parameter consists of the following sub-fields.</p>
@@ -6388,10 +7135,12 @@ export interface UpdateProductInput {
6388
7135
  */
6389
7136
  export interface UpdateProductOutput {
6390
7137
  /**
7138
+ * @public
6391
7139
  * <p>Information about the product view.</p>
6392
7140
  */
6393
7141
  ProductViewDetail?: ProductViewDetail;
6394
7142
  /**
7143
+ * @public
6395
7144
  * <p>Information about the tags associated with the product.</p>
6396
7145
  */
6397
7146
  Tags?: Tag[];
@@ -6415,6 +7164,7 @@ export type StackSetOperationType = (typeof StackSetOperationType)[keyof typeof
6415
7164
  */
6416
7165
  export interface UpdateProvisioningPreferences {
6417
7166
  /**
7167
+ * @public
6418
7168
  * <p>One or more Amazon Web Services accounts that will have access to the provisioned product.</p>
6419
7169
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
6420
7170
  * <p>The Amazon Web Services accounts specified should be within the list of accounts in the <code>STACKSET</code> constraint. To get the list of accounts in the <code>STACKSET</code> constraint, use the <code>DescribeProvisioningParameters</code> operation.</p>
@@ -6422,6 +7172,7 @@ export interface UpdateProvisioningPreferences {
6422
7172
  */
6423
7173
  StackSetAccounts?: string[];
6424
7174
  /**
7175
+ * @public
6425
7176
  * <p>One or more Amazon Web Services Regions where the provisioned product will be available.</p>
6426
7177
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
6427
7178
  * <p>The specified Regions should be within the list of Regions from the <code>STACKSET</code> constraint. To get the list of Regions in the <code>STACKSET</code> constraint, use the <code>DescribeProvisioningParameters</code> operation.</p>
@@ -6429,6 +7180,7 @@ export interface UpdateProvisioningPreferences {
6429
7180
  */
6430
7181
  StackSetRegions?: string[];
6431
7182
  /**
7183
+ * @public
6432
7184
  * <p>The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.</p>
6433
7185
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
6434
7186
  * <p>Conditional: You must specify either <code>StackSetFailureToleranceCount</code> or <code>StackSetFailureTolerancePercentage</code>, but not both.</p>
@@ -6436,6 +7188,7 @@ export interface UpdateProvisioningPreferences {
6436
7188
  */
6437
7189
  StackSetFailureToleranceCount?: number;
6438
7190
  /**
7191
+ * @public
6439
7192
  * <p>The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.</p>
6440
7193
  * <p>When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.</p>
6441
7194
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
@@ -6443,6 +7196,7 @@ export interface UpdateProvisioningPreferences {
6443
7196
  */
6444
7197
  StackSetFailureTolerancePercentage?: number;
6445
7198
  /**
7199
+ * @public
6446
7200
  * <p>The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of <code>StackSetFailureToleranceCount</code>. <code>StackSetMaxConcurrentCount</code> is at most one more than the <code>StackSetFailureToleranceCount</code>.</p>
6447
7201
  * <p>Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p>
6448
7202
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
@@ -6450,6 +7204,7 @@ export interface UpdateProvisioningPreferences {
6450
7204
  */
6451
7205
  StackSetMaxConcurrencyCount?: number;
6452
7206
  /**
7207
+ * @public
6453
7208
  * <p>The maximum percentage of accounts in which to perform this operation at one time.</p>
6454
7209
  * <p>When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, Service Catalog sets the number as <code>1</code> instead.</p>
6455
7210
  * <p>Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p>
@@ -6458,6 +7213,7 @@ export interface UpdateProvisioningPreferences {
6458
7213
  */
6459
7214
  StackSetMaxConcurrencyPercentage?: number;
6460
7215
  /**
7216
+ * @public
6461
7217
  * <p>Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is <code>UPDATE</code> if nothing is specified.</p>
6462
7218
  * <p>Applicable only to a <code>CFN_STACKSET</code> provisioned product type.</p>
6463
7219
  * <dl>
@@ -6482,6 +7238,7 @@ export interface UpdateProvisioningPreferences {
6482
7238
  */
6483
7239
  export interface UpdateProvisionedProductInput {
6484
7240
  /**
7241
+ * @public
6485
7242
  * <p>The language code.</p>
6486
7243
  * <ul>
6487
7244
  * <li>
@@ -6496,52 +7253,64 @@ export interface UpdateProvisionedProductInput {
6496
7253
  */
6497
7254
  AcceptLanguage?: string;
6498
7255
  /**
7256
+ * @public
6499
7257
  * <p>The name of the provisioned product. You cannot specify both
6500
7258
  * <code>ProvisionedProductName</code> and <code>ProvisionedProductId</code>.</p>
6501
7259
  */
6502
7260
  ProvisionedProductName?: string;
6503
7261
  /**
7262
+ * @public
6504
7263
  * <p>The identifier of the provisioned product. You must provide the name or ID, but not both.</p>
6505
7264
  */
6506
7265
  ProvisionedProductId?: string;
6507
7266
  /**
7267
+ * @public
6508
7268
  * <p>The identifier of the product. You must provide the name or ID, but not both.</p>
6509
7269
  */
6510
7270
  ProductId?: string;
6511
7271
  /**
7272
+ * @public
6512
7273
  * <p>The name of the product. You must provide the name or ID, but not both.</p>
6513
7274
  */
6514
7275
  ProductName?: string;
6515
7276
  /**
7277
+ * @public
6516
7278
  * <p>The identifier of the provisioning artifact.</p>
6517
7279
  */
6518
7280
  ProvisioningArtifactId?: string;
6519
7281
  /**
7282
+ * @public
6520
7283
  * <p>The name of the provisioning artifact. You must provide the name or ID, but not both.</p>
6521
7284
  */
6522
7285
  ProvisioningArtifactName?: string;
6523
7286
  /**
7287
+ * @public
6524
7288
  * <p>The path identifier. This value is optional if the product
6525
7289
  * has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.</p>
6526
7290
  */
6527
7291
  PathId?: string;
6528
7292
  /**
7293
+ * @public
6529
7294
  * <p>The name of the path. You must provide the name or ID, but not both.</p>
6530
7295
  */
6531
7296
  PathName?: string;
6532
7297
  /**
7298
+ * @public
6533
7299
  * <p>The new parameters.</p>
6534
7300
  */
6535
7301
  ProvisioningParameters?: UpdateProvisioningParameter[];
6536
7302
  /**
7303
+ * @public
6537
7304
  * <p>An object that contains information about the provisioning preferences for a stack set.</p>
6538
7305
  */
6539
7306
  ProvisioningPreferences?: UpdateProvisioningPreferences;
6540
7307
  /**
7308
+ * @public
6541
7309
  * <p>One or more tags. Requires the product to have <code>RESOURCE_UPDATE</code> constraint with <code>TagUpdatesOnProvisionedProduct</code> set to <code>ALLOWED</code> to allow tag updates.</p>
6542
7310
  */
6543
7311
  Tags?: Tag[];
6544
7312
  /**
7313
+ * @public
6545
7314
  * <p>The idempotency token that uniquely identifies the provisioning update request.</p>
6546
7315
  */
6547
7316
  UpdateToken?: string;
@@ -6551,6 +7320,7 @@ export interface UpdateProvisionedProductInput {
6551
7320
  */
6552
7321
  export interface UpdateProvisionedProductOutput {
6553
7322
  /**
7323
+ * @public
6554
7324
  * <p>Information about the result of the request.</p>
6555
7325
  */
6556
7326
  RecordDetail?: RecordDetail;
@@ -6572,6 +7342,7 @@ export type PropertyKey = (typeof PropertyKey)[keyof typeof PropertyKey];
6572
7342
  */
6573
7343
  export interface UpdateProvisionedProductPropertiesInput {
6574
7344
  /**
7345
+ * @public
6575
7346
  * <p>The language code.</p>
6576
7347
  * <ul>
6577
7348
  * <li>
@@ -6586,10 +7357,12 @@ export interface UpdateProvisionedProductPropertiesInput {
6586
7357
  */
6587
7358
  AcceptLanguage?: string;
6588
7359
  /**
7360
+ * @public
6589
7361
  * <p>The identifier of the provisioned product.</p>
6590
7362
  */
6591
7363
  ProvisionedProductId: string | undefined;
6592
7364
  /**
7365
+ * @public
6593
7366
  * <p>A map that contains the provisioned product properties to be updated.</p>
6594
7367
  * <p>The <code>LAUNCH_ROLE</code> key accepts role ARNs. This key allows an
6595
7368
  * administrator to call <code>UpdateProvisionedProductProperties</code> to update the launch
@@ -6613,6 +7386,7 @@ export interface UpdateProvisionedProductPropertiesInput {
6613
7386
  */
6614
7387
  ProvisionedProductProperties: Record<string, string> | undefined;
6615
7388
  /**
7389
+ * @public
6616
7390
  * <p>The idempotency token that uniquely identifies the provisioning product update request.</p>
6617
7391
  */
6618
7392
  IdempotencyToken?: string;
@@ -6622,18 +7396,22 @@ export interface UpdateProvisionedProductPropertiesInput {
6622
7396
  */
6623
7397
  export interface UpdateProvisionedProductPropertiesOutput {
6624
7398
  /**
7399
+ * @public
6625
7400
  * <p>The provisioned product identifier.</p>
6626
7401
  */
6627
7402
  ProvisionedProductId?: string;
6628
7403
  /**
7404
+ * @public
6629
7405
  * <p>A map that contains the properties updated.</p>
6630
7406
  */
6631
7407
  ProvisionedProductProperties?: Record<string, string>;
6632
7408
  /**
7409
+ * @public
6633
7410
  * <p>The identifier of the record.</p>
6634
7411
  */
6635
7412
  RecordId?: string;
6636
7413
  /**
7414
+ * @public
6637
7415
  * <p>The status of the request.</p>
6638
7416
  */
6639
7417
  Status?: RecordStatus | string;
@@ -6643,6 +7421,7 @@ export interface UpdateProvisionedProductPropertiesOutput {
6643
7421
  */
6644
7422
  export interface UpdateProvisioningArtifactInput {
6645
7423
  /**
7424
+ * @public
6646
7425
  * <p>The language code.</p>
6647
7426
  * <ul>
6648
7427
  * <li>
@@ -6657,27 +7436,33 @@ export interface UpdateProvisioningArtifactInput {
6657
7436
  */
6658
7437
  AcceptLanguage?: string;
6659
7438
  /**
7439
+ * @public
6660
7440
  * <p>The product identifier.</p>
6661
7441
  */
6662
7442
  ProductId: string | undefined;
6663
7443
  /**
7444
+ * @public
6664
7445
  * <p>The identifier of the provisioning artifact.</p>
6665
7446
  */
6666
7447
  ProvisioningArtifactId: string | undefined;
6667
7448
  /**
7449
+ * @public
6668
7450
  * <p>The updated name of the provisioning artifact.</p>
6669
7451
  */
6670
7452
  Name?: string;
6671
7453
  /**
7454
+ * @public
6672
7455
  * <p>The updated description of the provisioning artifact.</p>
6673
7456
  */
6674
7457
  Description?: string;
6675
7458
  /**
7459
+ * @public
6676
7460
  * <p>Indicates whether the product version is active.</p>
6677
7461
  * <p>Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.</p>
6678
7462
  */
6679
7463
  Active?: boolean;
6680
7464
  /**
7465
+ * @public
6681
7466
  * <p>Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.</p>
6682
7467
  * <p>The <code>DEFAULT</code> value indicates that the product version is active.</p>
6683
7468
  * <p>The administrator can set the guidance to <code>DEPRECATED</code> to inform
@@ -6691,14 +7476,17 @@ export interface UpdateProvisioningArtifactInput {
6691
7476
  */
6692
7477
  export interface UpdateProvisioningArtifactOutput {
6693
7478
  /**
7479
+ * @public
6694
7480
  * <p>Information about the provisioning artifact.</p>
6695
7481
  */
6696
7482
  ProvisioningArtifactDetail?: ProvisioningArtifactDetail;
6697
7483
  /**
7484
+ * @public
6698
7485
  * <p>The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.</p>
6699
7486
  */
6700
7487
  Info?: Record<string, string>;
6701
7488
  /**
7489
+ * @public
6702
7490
  * <p>The status of the current request.</p>
6703
7491
  */
6704
7492
  Status?: Status | string;
@@ -6708,22 +7496,27 @@ export interface UpdateProvisioningArtifactOutput {
6708
7496
  */
6709
7497
  export interface UpdateServiceActionInput {
6710
7498
  /**
7499
+ * @public
6711
7500
  * <p>The self-service action identifier.</p>
6712
7501
  */
6713
7502
  Id: string | undefined;
6714
7503
  /**
7504
+ * @public
6715
7505
  * <p>The self-service action name.</p>
6716
7506
  */
6717
7507
  Name?: string;
6718
7508
  /**
7509
+ * @public
6719
7510
  * <p>A map that defines the self-service action.</p>
6720
7511
  */
6721
7512
  Definition?: Record<string, string>;
6722
7513
  /**
7514
+ * @public
6723
7515
  * <p>The self-service action description.</p>
6724
7516
  */
6725
7517
  Description?: string;
6726
7518
  /**
7519
+ * @public
6727
7520
  * <p>The language code.</p>
6728
7521
  * <ul>
6729
7522
  * <li>
@@ -6743,6 +7536,7 @@ export interface UpdateServiceActionInput {
6743
7536
  */
6744
7537
  export interface UpdateServiceActionOutput {
6745
7538
  /**
7539
+ * @public
6746
7540
  * <p>Detailed information about the self-service action.</p>
6747
7541
  */
6748
7542
  ServiceActionDetail?: ServiceActionDetail;
@@ -6752,14 +7546,17 @@ export interface UpdateServiceActionOutput {
6752
7546
  */
6753
7547
  export interface UpdateTagOptionInput {
6754
7548
  /**
7549
+ * @public
6755
7550
  * <p>The TagOption identifier.</p>
6756
7551
  */
6757
7552
  Id: string | undefined;
6758
7553
  /**
7554
+ * @public
6759
7555
  * <p>The updated value.</p>
6760
7556
  */
6761
7557
  Value?: string;
6762
7558
  /**
7559
+ * @public
6763
7560
  * <p>The updated active state.</p>
6764
7561
  */
6765
7562
  Active?: boolean;
@@ -6769,6 +7566,7 @@ export interface UpdateTagOptionInput {
6769
7566
  */
6770
7567
  export interface UpdateTagOptionOutput {
6771
7568
  /**
7569
+ * @public
6772
7570
  * <p>Information about the TagOption.</p>
6773
7571
  */
6774
7572
  TagOptionDetail?: TagOptionDetail;