@aws-sdk/client-ram 3.378.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,10 +5,12 @@ import { RAMServiceException as __BaseException } from "./RAMServiceException";
5
5
  */
6
6
  export interface AcceptResourceShareInvitationRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the invitation that you want to accept.</p>
9
10
  */
10
11
  resourceShareInvitationArn: string | undefined;
11
12
  /**
13
+ * @public
12
14
  * <p>Specifies a unique, case-sensitive identifier that you provide to
13
15
  * ensure the idempotency of the request. This lets you safely retry the request without
14
16
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -56,14 +58,17 @@ export type ResourceShareAssociationStatus = (typeof ResourceShareAssociationSta
56
58
  */
57
59
  export interface ResourceShareAssociation {
58
60
  /**
61
+ * @public
59
62
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share.</p>
60
63
  */
61
64
  resourceShareArn?: string;
62
65
  /**
66
+ * @public
63
67
  * <p>The name of the resource share.</p>
64
68
  */
65
69
  resourceShareName?: string;
66
70
  /**
71
+ * @public
67
72
  * <p>The associated entity. This can be either of the following:</p>
68
73
  * <ul>
69
74
  * <li>
@@ -93,26 +98,32 @@ export interface ResourceShareAssociation {
93
98
  */
94
99
  associatedEntity?: string;
95
100
  /**
101
+ * @public
96
102
  * <p>The type of entity included in this association.</p>
97
103
  */
98
104
  associationType?: ResourceShareAssociationType | string;
99
105
  /**
106
+ * @public
100
107
  * <p>The current status of the association.</p>
101
108
  */
102
109
  status?: ResourceShareAssociationStatus | string;
103
110
  /**
111
+ * @public
104
112
  * <p>A message about the status of the association.</p>
105
113
  */
106
114
  statusMessage?: string;
107
115
  /**
116
+ * @public
108
117
  * <p>The date and time when the association was created.</p>
109
118
  */
110
119
  creationTime?: Date;
111
120
  /**
121
+ * @public
112
122
  * <p>The date and time when the association was last updated.</p>
113
123
  */
114
124
  lastUpdatedTime?: Date;
115
125
  /**
126
+ * @public
116
127
  * <p>Indicates whether the principal belongs to the same organization in Organizations as the
117
128
  * Amazon Web Services account that owns the resource share.</p>
118
129
  */
@@ -138,40 +149,49 @@ export type ResourceShareInvitationStatus = (typeof ResourceShareInvitationStatu
138
149
  */
139
150
  export interface ResourceShareInvitation {
140
151
  /**
152
+ * @public
141
153
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the invitation.</p>
142
154
  */
143
155
  resourceShareInvitationArn?: string;
144
156
  /**
157
+ * @public
145
158
  * <p>The name of the resource share.</p>
146
159
  */
147
160
  resourceShareName?: string;
148
161
  /**
162
+ * @public
149
163
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share</p>
150
164
  */
151
165
  resourceShareArn?: string;
152
166
  /**
167
+ * @public
153
168
  * <p>The ID of the Amazon Web Services account that sent the invitation.</p>
154
169
  */
155
170
  senderAccountId?: string;
156
171
  /**
172
+ * @public
157
173
  * <p>The ID of the Amazon Web Services account that received the invitation.</p>
158
174
  */
159
175
  receiverAccountId?: string;
160
176
  /**
177
+ * @public
161
178
  * <p>The date and time when the invitation was sent.</p>
162
179
  */
163
180
  invitationTimestamp?: Date;
164
181
  /**
182
+ * @public
165
183
  * <p>The current status of the invitation.</p>
166
184
  */
167
185
  status?: ResourceShareInvitationStatus | string;
168
186
  /**
187
+ * @public
169
188
  * @deprecated
170
189
  *
171
190
  * <p>To view the resources associated with a pending resource share invitation, use <a>ListPendingInvitationResources</a>.</p>
172
191
  */
173
192
  resourceShareAssociations?: ResourceShareAssociation[];
174
193
  /**
194
+ * @public
175
195
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the IAM user or role that received the invitation.</p>
176
196
  */
177
197
  receiverArn?: string;
@@ -181,10 +201,12 @@ export interface ResourceShareInvitation {
181
201
  */
182
202
  export interface AcceptResourceShareInvitationResponse {
183
203
  /**
204
+ * @public
184
205
  * <p>An object that contains information about the specified invitation.</p>
185
206
  */
186
207
  resourceShareInvitation?: ResourceShareInvitation;
187
208
  /**
209
+ * @public
188
210
  * <p>The idempotency identifier associated with this request. If you
189
211
  * want to repeat the same operation in an idempotent manner then you must include this
190
212
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -323,16 +345,19 @@ export declare class ServiceUnavailableException extends __BaseException {
323
345
  */
324
346
  export interface AssociateResourceShareRequest {
325
347
  /**
348
+ * @public
326
349
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share that you want to add principals or resources
327
350
  * to.</p>
328
351
  */
329
352
  resourceShareArn: string | undefined;
330
353
  /**
354
+ * @public
331
355
  * <p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resources that you want to share. This can be
332
356
  * <code>null</code> if you want to add only principals.</p>
333
357
  */
334
358
  resourceArns?: string[];
335
359
  /**
360
+ * @public
336
361
  * <p>Specifies a list of principals to whom you want to the resource share. This can be
337
362
  * <code>null</code> if you want to add only resources.</p>
338
363
  * <p>What the principals can do with the resources in the share is determined by the RAM
@@ -372,6 +397,7 @@ export interface AssociateResourceShareRequest {
372
397
  */
373
398
  principals?: string[];
374
399
  /**
400
+ * @public
375
401
  * <p>Specifies a unique, case-sensitive identifier that you provide to
376
402
  * ensure the idempotency of the request. This lets you safely retry the request without
377
403
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -386,6 +412,7 @@ export interface AssociateResourceShareRequest {
386
412
  */
387
413
  clientToken?: string;
388
414
  /**
415
+ * @public
389
416
  * <p>Specifies from which source accounts the service principal
390
417
  * has access to the resources in this resource share.</p>
391
418
  */
@@ -396,10 +423,12 @@ export interface AssociateResourceShareRequest {
396
423
  */
397
424
  export interface AssociateResourceShareResponse {
398
425
  /**
426
+ * @public
399
427
  * <p>An array of objects that contain information about the associations.</p>
400
428
  */
401
429
  resourceShareAssociations?: ResourceShareAssociation[];
402
430
  /**
431
+ * @public
403
432
  * <p>The idempotency identifier associated with this request. If you
404
433
  * want to repeat the same operation in an idempotent manner then you must include this
405
434
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -476,17 +505,20 @@ export declare class UnknownResourceException extends __BaseException {
476
505
  */
477
506
  export interface AssociateResourceSharePermissionRequest {
478
507
  /**
508
+ * @public
479
509
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share to which you want to add or replace
480
510
  * permissions.</p>
481
511
  */
482
512
  resourceShareArn: string | undefined;
483
513
  /**
514
+ * @public
484
515
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the RAM permission to associate with the resource share.
485
516
  * To find the ARN for a permission, use either the <a>ListPermissions</a> operation or go to the <a href="https://console.aws.amazon.com/ram/home#Permissions:">Permissions library</a> page in the RAM console and
486
517
  * then choose the name of the permission. The ARN is displayed on the detail page.</p>
487
518
  */
488
519
  permissionArn: string | undefined;
489
520
  /**
521
+ * @public
490
522
  * <p>Specifies whether the specified permission should replace the existing permission
491
523
  * associated with the resource share. Use <code>true</code> to replace the current permissions. Use
492
524
  * <code>false</code> to add the permission to a resource share that currently doesn't
@@ -500,6 +532,7 @@ export interface AssociateResourceSharePermissionRequest {
500
532
  */
501
533
  replace?: boolean;
502
534
  /**
535
+ * @public
503
536
  * <p>Specifies a unique, case-sensitive identifier that you provide to
504
537
  * ensure the idempotency of the request. This lets you safely retry the request without
505
538
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -514,6 +547,7 @@ export interface AssociateResourceSharePermissionRequest {
514
547
  */
515
548
  clientToken?: string;
516
549
  /**
550
+ * @public
517
551
  * <p>Specifies the version of the RAM permission to associate with the resource share. You can
518
552
  * specify <i>only</i> the version that is currently set as the default
519
553
  * version for the permission. If you also set the <code>replace</code> pararameter to
@@ -532,11 +566,13 @@ export interface AssociateResourceSharePermissionRequest {
532
566
  */
533
567
  export interface AssociateResourceSharePermissionResponse {
534
568
  /**
569
+ * @public
535
570
  * <p>A return value of <code>true</code> indicates that the request succeeded.
536
571
  * A value of <code>false</code> indicates that the request failed.</p>
537
572
  */
538
573
  returnValue?: boolean;
539
574
  /**
575
+ * @public
540
576
  * <p>The idempotency identifier associated with this request. If you
541
577
  * want to repeat the same operation in an idempotent manner then you must include this
542
578
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -555,11 +591,13 @@ export interface AssociateResourceSharePermissionResponse {
555
591
  */
556
592
  export interface Tag {
557
593
  /**
594
+ * @public
558
595
  * <p>The key, or name, attached to the tag. Every tag must have a key. Key names are case
559
596
  * sensitive.</p>
560
597
  */
561
598
  key?: string;
562
599
  /**
600
+ * @public
563
601
  * <p>The string value attached to the tag. The value can be an empty string. Key values are
564
602
  * case sensitive.</p>
565
603
  */
@@ -570,11 +608,13 @@ export interface Tag {
570
608
  */
571
609
  export interface CreatePermissionRequest {
572
610
  /**
611
+ * @public
573
612
  * <p>Specifies the name of the customer managed permission. The name must be unique within the
574
613
  * Amazon Web Services Region.</p>
575
614
  */
576
615
  name: string | undefined;
577
616
  /**
617
+ * @public
578
618
  * <p>Specifies the name of the resource type that this customer managed permission applies to.</p>
579
619
  * <p>The format is
580
620
  * <code>
@@ -586,6 +626,7 @@ export interface CreatePermissionRequest {
586
626
  */
587
627
  resourceType: string | undefined;
588
628
  /**
629
+ * @public
589
630
  * <p>A string in JSON format string that contains the following elements of a
590
631
  * resource-based policy:</p>
591
632
  * <ul>
@@ -621,6 +662,7 @@ export interface CreatePermissionRequest {
621
662
  */
622
663
  policyTemplate: string | undefined;
623
664
  /**
665
+ * @public
624
666
  * <p>Specifies a unique, case-sensitive identifier that you provide to
625
667
  * ensure the idempotency of the request. This lets you safely retry the request without
626
668
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -635,6 +677,7 @@ export interface CreatePermissionRequest {
635
677
  */
636
678
  clientToken?: string;
637
679
  /**
680
+ * @public
638
681
  * <p>Specifies a list of one or more tag key and value pairs to attach to the
639
682
  * permission.</p>
640
683
  */
@@ -671,23 +714,28 @@ export type PermissionType = (typeof PermissionType)[keyof typeof PermissionType
671
714
  */
672
715
  export interface ResourceSharePermissionSummary {
673
716
  /**
717
+ * @public
674
718
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the permission you want information about.</p>
675
719
  */
676
720
  arn?: string;
677
721
  /**
722
+ * @public
678
723
  * <p>The version of the permission associated with this resource share.</p>
679
724
  */
680
725
  version?: string;
681
726
  /**
727
+ * @public
682
728
  * <p>Specifies whether the version of the managed permission used by this resource share is the default version for
683
729
  * this managed permission.</p>
684
730
  */
685
731
  defaultVersion?: boolean;
686
732
  /**
733
+ * @public
687
734
  * <p>The name of this managed permission.</p>
688
735
  */
689
736
  name?: string;
690
737
  /**
738
+ * @public
691
739
  * <p>The type of resource to which this permission applies. This takes the form of:
692
740
  * <code>service-code</code>:<code>resource-code</code>, and is case-insensitive. For
693
741
  * example, an Amazon EC2 Subnet would be represented by the string
@@ -695,23 +743,28 @@ export interface ResourceSharePermissionSummary {
695
743
  */
696
744
  resourceType?: string;
697
745
  /**
746
+ * @public
698
747
  * <p>The current status of the permission.</p>
699
748
  */
700
749
  status?: string;
701
750
  /**
751
+ * @public
702
752
  * <p>The date and time when the permission was created.</p>
703
753
  */
704
754
  creationTime?: Date;
705
755
  /**
756
+ * @public
706
757
  * <p>The date and time when the permission was last updated.</p>
707
758
  */
708
759
  lastUpdatedTime?: Date;
709
760
  /**
761
+ * @public
710
762
  * <p>Specifies whether the managed permission associated with this resource share is the default managed permission for all
711
763
  * resources of this resource type.</p>
712
764
  */
713
765
  isResourceTypeDefault?: boolean;
714
766
  /**
767
+ * @public
715
768
  * <p>The type of managed permission. This can be one of the following values:</p>
716
769
  * <ul>
717
770
  * <li>
@@ -729,6 +782,7 @@ export interface ResourceSharePermissionSummary {
729
782
  */
730
783
  permissionType?: PermissionType | string;
731
784
  /**
785
+ * @public
732
786
  * <p>Indicates what features are available for this resource share. This parameter can have one of
733
787
  * the following values:</p>
734
788
  * <ul>
@@ -761,6 +815,7 @@ export interface ResourceSharePermissionSummary {
761
815
  */
762
816
  featureSet?: PermissionFeatureSet | string;
763
817
  /**
818
+ * @public
764
819
  * <p>A list of the tag key value pairs currently attached to the permission.</p>
765
820
  */
766
821
  tags?: Tag[];
@@ -770,10 +825,12 @@ export interface ResourceSharePermissionSummary {
770
825
  */
771
826
  export interface CreatePermissionResponse {
772
827
  /**
828
+ * @public
773
829
  * <p>A structure with information about this customer managed permission.</p>
774
830
  */
775
831
  permission?: ResourceSharePermissionSummary;
776
832
  /**
833
+ * @public
777
834
  * <p>The idempotency identifier associated with this request. If you
778
835
  * want to repeat the same operation in an idempotent manner then you must include this
779
836
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -837,10 +894,12 @@ export declare class PermissionLimitExceededException extends __BaseException {
837
894
  */
838
895
  export interface CreatePermissionVersionRequest {
839
896
  /**
897
+ * @public
840
898
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the customer managed permission you're creating a new version for.</p>
841
899
  */
842
900
  permissionArn: string | undefined;
843
901
  /**
902
+ * @public
844
903
  * <p>A string in JSON format string that contains the following elements of a
845
904
  * resource-based policy:</p>
846
905
  * <ul>
@@ -876,6 +935,7 @@ export interface CreatePermissionVersionRequest {
876
935
  */
877
936
  policyTemplate: string | undefined;
878
937
  /**
938
+ * @public
879
939
  * <p>Specifies a unique, case-sensitive identifier that you provide to
880
940
  * ensure the idempotency of the request. This lets you safely retry the request without
881
941
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -910,46 +970,56 @@ export type PermissionStatus = (typeof PermissionStatus)[keyof typeof Permission
910
970
  */
911
971
  export interface ResourceSharePermissionDetail {
912
972
  /**
973
+ * @public
913
974
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of this RAM managed permission.</p>
914
975
  */
915
976
  arn?: string;
916
977
  /**
978
+ * @public
917
979
  * <p>The version of the permission described in this response.</p>
918
980
  */
919
981
  version?: string;
920
982
  /**
983
+ * @public
921
984
  * <p>Specifies whether the version of the permission represented in this response is the
922
985
  * default version for this permission.</p>
923
986
  */
924
987
  defaultVersion?: boolean;
925
988
  /**
989
+ * @public
926
990
  * <p>The name of this permission.</p>
927
991
  */
928
992
  name?: string;
929
993
  /**
994
+ * @public
930
995
  * <p>The resource type to which this permission applies.</p>
931
996
  */
932
997
  resourceType?: string;
933
998
  /**
999
+ * @public
934
1000
  * <p>The permission's effect and actions in JSON format. The <code>effect</code> indicates
935
1001
  * whether the specified actions are allowed or denied. The <code>actions</code> list the
936
1002
  * operations to which the principal is granted or denied access.</p>
937
1003
  */
938
1004
  permission?: string;
939
1005
  /**
1006
+ * @public
940
1007
  * <p>The date and time when the permission was created.</p>
941
1008
  */
942
1009
  creationTime?: Date;
943
1010
  /**
1011
+ * @public
944
1012
  * <p>The date and time when the permission was last updated.</p>
945
1013
  */
946
1014
  lastUpdatedTime?: Date;
947
1015
  /**
1016
+ * @public
948
1017
  * <p>Specifies whether the version of the permission represented in this response is the
949
1018
  * default version for all resources of this resource type.</p>
950
1019
  */
951
1020
  isResourceTypeDefault?: boolean;
952
1021
  /**
1022
+ * @public
953
1023
  * <p>The type of managed permission. This can be one of the following values:</p>
954
1024
  * <ul>
955
1025
  * <li>
@@ -967,6 +1037,7 @@ export interface ResourceSharePermissionDetail {
967
1037
  */
968
1038
  permissionType?: PermissionType | string;
969
1039
  /**
1040
+ * @public
970
1041
  * <p>Indicates what features are available for this resource share. This parameter can have one of
971
1042
  * the following values:</p>
972
1043
  * <ul>
@@ -999,6 +1070,7 @@ export interface ResourceSharePermissionDetail {
999
1070
  */
1000
1071
  featureSet?: PermissionFeatureSet | string;
1001
1072
  /**
1073
+ * @public
1002
1074
  * <p>The current status of the association between the permission and the resource share.
1003
1075
  * The following are the possible values:</p>
1004
1076
  * <ul>
@@ -1025,6 +1097,7 @@ export interface ResourceSharePermissionDetail {
1025
1097
  */
1026
1098
  status?: PermissionStatus | string;
1027
1099
  /**
1100
+ * @public
1028
1101
  * <p>The tag key and value pairs attached to the resource share.</p>
1029
1102
  */
1030
1103
  tags?: Tag[];
@@ -1034,10 +1107,12 @@ export interface ResourceSharePermissionDetail {
1034
1107
  */
1035
1108
  export interface CreatePermissionVersionResponse {
1036
1109
  /**
1110
+ * @public
1037
1111
  * <p>Information about a RAM managed permission.</p>
1038
1112
  */
1039
1113
  permission?: ResourceSharePermissionDetail;
1040
1114
  /**
1115
+ * @public
1041
1116
  * <p>The idempotency identifier associated with this request. If you
1042
1117
  * want to repeat the same operation in an idempotent manner then you must include this
1043
1118
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -1064,15 +1139,18 @@ export declare class PermissionVersionsLimitExceededException extends __BaseExce
1064
1139
  */
1065
1140
  export interface CreateResourceShareRequest {
1066
1141
  /**
1142
+ * @public
1067
1143
  * <p>Specifies the name of the resource share.</p>
1068
1144
  */
1069
1145
  name: string | undefined;
1070
1146
  /**
1147
+ * @public
1071
1148
  * <p>Specifies a list of one or more ARNs of the resources to associate with the
1072
1149
  * resource share.</p>
1073
1150
  */
1074
1151
  resourceArns?: string[];
1075
1152
  /**
1153
+ * @public
1076
1154
  * <p>Specifies a list of one or more principals to associate with the resource share.</p>
1077
1155
  * <p>You can include the following values:</p>
1078
1156
  * <ul>
@@ -1109,11 +1187,13 @@ export interface CreateResourceShareRequest {
1109
1187
  */
1110
1188
  principals?: string[];
1111
1189
  /**
1190
+ * @public
1112
1191
  * <p>Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to
1113
1192
  * the resources associated with the resource share.</p>
1114
1193
  */
1115
1194
  tags?: Tag[];
1116
1195
  /**
1196
+ * @public
1117
1197
  * <p>Specifies whether principals outside your organization in Organizations can be associated
1118
1198
  * with a resource share. A value of <code>true</code> lets you share with individual Amazon Web Services accounts
1119
1199
  * that are <i>not</i> in your organization. A value of <code>false</code>
@@ -1122,6 +1202,7 @@ export interface CreateResourceShareRequest {
1122
1202
  */
1123
1203
  allowExternalPrincipals?: boolean;
1124
1204
  /**
1205
+ * @public
1125
1206
  * <p>Specifies a unique, case-sensitive identifier that you provide to
1126
1207
  * ensure the idempotency of the request. This lets you safely retry the request without
1127
1208
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -1136,6 +1217,7 @@ export interface CreateResourceShareRequest {
1136
1217
  */
1137
1218
  clientToken?: string;
1138
1219
  /**
1220
+ * @public
1139
1221
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the RAM permission to associate with the resource share. If you do
1140
1222
  * not specify an ARN for the permission, RAM automatically attaches the default version
1141
1223
  * of the permission for each resource type. You can associate only one permission with
@@ -1143,6 +1225,7 @@ export interface CreateResourceShareRequest {
1143
1225
  */
1144
1226
  permissionArns?: string[];
1145
1227
  /**
1228
+ * @public
1146
1229
  * <p>Specifies from which source accounts the service principal
1147
1230
  * has access to the resources in this resource share.</p>
1148
1231
  */
@@ -1182,18 +1265,22 @@ export type ResourceShareStatus = (typeof ResourceShareStatus)[keyof typeof Reso
1182
1265
  */
1183
1266
  export interface ResourceShare {
1184
1267
  /**
1268
+ * @public
1185
1269
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share</p>
1186
1270
  */
1187
1271
  resourceShareArn?: string;
1188
1272
  /**
1273
+ * @public
1189
1274
  * <p>The name of the resource share.</p>
1190
1275
  */
1191
1276
  name?: string;
1192
1277
  /**
1278
+ * @public
1193
1279
  * <p>The ID of the Amazon Web Services account that owns the resource share.</p>
1194
1280
  */
1195
1281
  owningAccountId?: string;
1196
1282
  /**
1283
+ * @public
1197
1284
  * <p>Indicates whether principals outside your organization in Organizations can be associated
1198
1285
  * with a resource share.</p>
1199
1286
  * <ul>
@@ -1212,26 +1299,32 @@ export interface ResourceShare {
1212
1299
  */
1213
1300
  allowExternalPrincipals?: boolean;
1214
1301
  /**
1302
+ * @public
1215
1303
  * <p>The current status of the resource share.</p>
1216
1304
  */
1217
1305
  status?: ResourceShareStatus | string;
1218
1306
  /**
1307
+ * @public
1219
1308
  * <p>A message about the status of the resource share.</p>
1220
1309
  */
1221
1310
  statusMessage?: string;
1222
1311
  /**
1312
+ * @public
1223
1313
  * <p>The tag key and value pairs attached to the resource share.</p>
1224
1314
  */
1225
1315
  tags?: Tag[];
1226
1316
  /**
1317
+ * @public
1227
1318
  * <p>The date and time when the resource share was created.</p>
1228
1319
  */
1229
1320
  creationTime?: Date;
1230
1321
  /**
1322
+ * @public
1231
1323
  * <p>The date and time when the resource share was last updated.</p>
1232
1324
  */
1233
1325
  lastUpdatedTime?: Date;
1234
1326
  /**
1327
+ * @public
1235
1328
  * <p>Indicates what features are available for this resource share. This parameter can have one of
1236
1329
  * the following values:</p>
1237
1330
  * <ul>
@@ -1269,10 +1362,12 @@ export interface ResourceShare {
1269
1362
  */
1270
1363
  export interface CreateResourceShareResponse {
1271
1364
  /**
1365
+ * @public
1272
1366
  * <p>An object with information about the new resource share.</p>
1273
1367
  */
1274
1368
  resourceShare?: ResourceShare;
1275
1369
  /**
1370
+ * @public
1276
1371
  * <p>The idempotency identifier associated with this request. If you
1277
1372
  * want to repeat the same operation in an idempotent manner then you must include this
1278
1373
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -1311,10 +1406,12 @@ export declare class TagPolicyViolationException extends __BaseException {
1311
1406
  */
1312
1407
  export interface DeletePermissionRequest {
1313
1408
  /**
1409
+ * @public
1314
1410
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the customer managed permission that you want to delete.</p>
1315
1411
  */
1316
1412
  permissionArn: string | undefined;
1317
1413
  /**
1414
+ * @public
1318
1415
  * <p>Specifies a unique, case-sensitive identifier that you provide to
1319
1416
  * ensure the idempotency of the request. This lets you safely retry the request without
1320
1417
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -1334,10 +1431,12 @@ export interface DeletePermissionRequest {
1334
1431
  */
1335
1432
  export interface DeletePermissionResponse {
1336
1433
  /**
1434
+ * @public
1337
1435
  * <p>A boolean that indicates whether the delete operations succeeded.</p>
1338
1436
  */
1339
1437
  returnValue?: boolean;
1340
1438
  /**
1439
+ * @public
1341
1440
  * <p>The idempotency identifier associated with this request. If you
1342
1441
  * want to repeat the same operation in an idempotent manner then you must include this
1343
1442
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -1345,6 +1444,7 @@ export interface DeletePermissionResponse {
1345
1444
  */
1346
1445
  clientToken?: string;
1347
1446
  /**
1447
+ * @public
1348
1448
  * <p>This operation is performed asynchronously, and this response parameter indicates the
1349
1449
  * current status.</p>
1350
1450
  */
@@ -1355,10 +1455,12 @@ export interface DeletePermissionResponse {
1355
1455
  */
1356
1456
  export interface DeletePermissionVersionRequest {
1357
1457
  /**
1458
+ * @public
1358
1459
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the permission with the version you want to delete.</p>
1359
1460
  */
1360
1461
  permissionArn: string | undefined;
1361
1462
  /**
1463
+ * @public
1362
1464
  * <p>Specifies the version number to delete.</p>
1363
1465
  * <p>You can't delete the default version for a customer managed permission.</p>
1364
1466
  * <p>You can't delete a version if it's the only version of the permission. You must either
@@ -1370,6 +1472,7 @@ export interface DeletePermissionVersionRequest {
1370
1472
  */
1371
1473
  permissionVersion: number | undefined;
1372
1474
  /**
1475
+ * @public
1373
1476
  * <p>Specifies a unique, case-sensitive identifier that you provide to
1374
1477
  * ensure the idempotency of the request. This lets you safely retry the request without
1375
1478
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -1389,10 +1492,12 @@ export interface DeletePermissionVersionRequest {
1389
1492
  */
1390
1493
  export interface DeletePermissionVersionResponse {
1391
1494
  /**
1495
+ * @public
1392
1496
  * <p>A boolean value that indicates whether the operation is successful.</p>
1393
1497
  */
1394
1498
  returnValue?: boolean;
1395
1499
  /**
1500
+ * @public
1396
1501
  * <p>The idempotency identifier associated with this request. If you
1397
1502
  * want to repeat the same operation in an idempotent manner then you must include this
1398
1503
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -1400,6 +1505,7 @@ export interface DeletePermissionVersionResponse {
1400
1505
  */
1401
1506
  clientToken?: string;
1402
1507
  /**
1508
+ * @public
1403
1509
  * <p>This operation is performed asynchronously, and this response parameter indicates the
1404
1510
  * current status.</p>
1405
1511
  */
@@ -1410,10 +1516,12 @@ export interface DeletePermissionVersionResponse {
1410
1516
  */
1411
1517
  export interface DeleteResourceShareRequest {
1412
1518
  /**
1519
+ * @public
1413
1520
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share to delete.</p>
1414
1521
  */
1415
1522
  resourceShareArn: string | undefined;
1416
1523
  /**
1524
+ * @public
1417
1525
  * <p>Specifies a unique, case-sensitive identifier that you provide to
1418
1526
  * ensure the idempotency of the request. This lets you safely retry the request without
1419
1527
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -1433,11 +1541,13 @@ export interface DeleteResourceShareRequest {
1433
1541
  */
1434
1542
  export interface DeleteResourceShareResponse {
1435
1543
  /**
1544
+ * @public
1436
1545
  * <p>A return value of <code>true</code> indicates that the request succeeded.
1437
1546
  * A value of <code>false</code> indicates that the request failed.</p>
1438
1547
  */
1439
1548
  returnValue?: boolean;
1440
1549
  /**
1550
+ * @public
1441
1551
  * <p>The idempotency identifier associated with this request. If you
1442
1552
  * want to repeat the same operation in an idempotent manner then you must include this
1443
1553
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -1450,17 +1560,20 @@ export interface DeleteResourceShareResponse {
1450
1560
  */
1451
1561
  export interface DisassociateResourceShareRequest {
1452
1562
  /**
1563
+ * @public
1453
1564
  * <p>Specifies <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share that you want to remove resources or principals
1454
1565
  * from.</p>
1455
1566
  */
1456
1567
  resourceShareArn: string | undefined;
1457
1568
  /**
1569
+ * @public
1458
1570
  * <p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> for one or more resources that you want to remove from
1459
1571
  * the resource share. After the operation runs, these resources are no longer shared with principals
1460
1572
  * associated with the resource share.</p>
1461
1573
  */
1462
1574
  resourceArns?: string[];
1463
1575
  /**
1576
+ * @public
1464
1577
  * <p>Specifies a list of one or more principals that no longer are to have access to the
1465
1578
  * resources in this resource share.</p>
1466
1579
  * <p>You can include the following values:</p>
@@ -1498,6 +1611,7 @@ export interface DisassociateResourceShareRequest {
1498
1611
  */
1499
1612
  principals?: string[];
1500
1613
  /**
1614
+ * @public
1501
1615
  * <p>Specifies a unique, case-sensitive identifier that you provide to
1502
1616
  * ensure the idempotency of the request. This lets you safely retry the request without
1503
1617
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -1512,6 +1626,7 @@ export interface DisassociateResourceShareRequest {
1512
1626
  */
1513
1627
  clientToken?: string;
1514
1628
  /**
1629
+ * @public
1515
1630
  * <p>Specifies from which source accounts the
1516
1631
  * service principal no longer has access to the resources in this resource share.</p>
1517
1632
  */
@@ -1522,11 +1637,13 @@ export interface DisassociateResourceShareRequest {
1522
1637
  */
1523
1638
  export interface DisassociateResourceShareResponse {
1524
1639
  /**
1640
+ * @public
1525
1641
  * <p>An array of objects with information about the updated associations for this
1526
1642
  * resource share.</p>
1527
1643
  */
1528
1644
  resourceShareAssociations?: ResourceShareAssociation[];
1529
1645
  /**
1646
+ * @public
1530
1647
  * <p>The idempotency identifier associated with this request. If you
1531
1648
  * want to repeat the same operation in an idempotent manner then you must include this
1532
1649
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -1539,15 +1656,18 @@ export interface DisassociateResourceShareResponse {
1539
1656
  */
1540
1657
  export interface DisassociateResourceSharePermissionRequest {
1541
1658
  /**
1659
+ * @public
1542
1660
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share that you want to remove the managed permission from.</p>
1543
1661
  */
1544
1662
  resourceShareArn: string | undefined;
1545
1663
  /**
1664
+ * @public
1546
1665
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the managed permission to disassociate from the resource share. Changes to permissions take
1547
1666
  * effect immediately.</p>
1548
1667
  */
1549
1668
  permissionArn: string | undefined;
1550
1669
  /**
1670
+ * @public
1551
1671
  * <p>Specifies a unique, case-sensitive identifier that you provide to
1552
1672
  * ensure the idempotency of the request. This lets you safely retry the request without
1553
1673
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -1567,11 +1687,13 @@ export interface DisassociateResourceSharePermissionRequest {
1567
1687
  */
1568
1688
  export interface DisassociateResourceSharePermissionResponse {
1569
1689
  /**
1690
+ * @public
1570
1691
  * <p>A return value of <code>true</code> indicates that the request succeeded.
1571
1692
  * A value of <code>false</code> indicates that the request failed.</p>
1572
1693
  */
1573
1694
  returnValue?: boolean;
1574
1695
  /**
1696
+ * @public
1575
1697
  * <p>The idempotency identifier associated with this request. If you
1576
1698
  * want to repeat the same operation in an idempotent manner then you must include this
1577
1699
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -1589,6 +1711,7 @@ export interface EnableSharingWithAwsOrganizationRequest {
1589
1711
  */
1590
1712
  export interface EnableSharingWithAwsOrganizationResponse {
1591
1713
  /**
1714
+ * @public
1592
1715
  * <p>A return value of <code>true</code> indicates that the request succeeded.
1593
1716
  * A value of <code>false</code> indicates that the request failed.</p>
1594
1717
  */
@@ -1599,12 +1722,14 @@ export interface EnableSharingWithAwsOrganizationResponse {
1599
1722
  */
1600
1723
  export interface GetPermissionRequest {
1601
1724
  /**
1725
+ * @public
1602
1726
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the permission whose contents you want to retrieve.
1603
1727
  * To find the ARN for a permission, use either the <a>ListPermissions</a> operation or go to the <a href="https://console.aws.amazon.com/ram/home#Permissions:">Permissions library</a> page in the RAM console and
1604
1728
  * then choose the name of the permission. The ARN is displayed on the detail page.</p>
1605
1729
  */
1606
1730
  permissionArn: string | undefined;
1607
1731
  /**
1732
+ * @public
1608
1733
  * <p>Specifies the version number of the RAM permission to retrieve. If you don't specify
1609
1734
  * this parameter, the operation retrieves the default version.</p>
1610
1735
  * <p>To see the list of available versions, use <a>ListPermissionVersions</a>.</p>
@@ -1616,6 +1741,7 @@ export interface GetPermissionRequest {
1616
1741
  */
1617
1742
  export interface GetPermissionResponse {
1618
1743
  /**
1744
+ * @public
1619
1745
  * <p>An object with details about the permission.</p>
1620
1746
  */
1621
1747
  permission?: ResourceSharePermissionDetail;
@@ -1625,14 +1751,17 @@ export interface GetPermissionResponse {
1625
1751
  */
1626
1752
  export interface GetResourcePoliciesRequest {
1627
1753
  /**
1754
+ * @public
1628
1755
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resources whose policies you want to retrieve.</p>
1629
1756
  */
1630
1757
  resourceArns: string[] | undefined;
1631
1758
  /**
1759
+ * @public
1632
1760
  * <p>Specifies the principal.</p>
1633
1761
  */
1634
1762
  principal?: string;
1635
1763
  /**
1764
+ * @public
1636
1765
  * <p>Specifies that you want to receive the next page of results. Valid
1637
1766
  * only if you received a <code>NextToken</code> response in the previous request. If you
1638
1767
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1641,6 +1770,7 @@ export interface GetResourcePoliciesRequest {
1641
1770
  */
1642
1771
  nextToken?: string;
1643
1772
  /**
1773
+ * @public
1644
1774
  * <p>Specifies the total number of results that you want included on each page
1645
1775
  * of the response. If you do not include this parameter, it defaults to a value that is
1646
1776
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1658,10 +1788,12 @@ export interface GetResourcePoliciesRequest {
1658
1788
  */
1659
1789
  export interface GetResourcePoliciesResponse {
1660
1790
  /**
1791
+ * @public
1661
1792
  * <p>An array of resource policy documents in JSON format.</p>
1662
1793
  */
1663
1794
  policies?: string[];
1664
1795
  /**
1796
+ * @public
1665
1797
  * <p>If present, this value indicates that more output is available than
1666
1798
  * is included in the current response. Use this value in the <code>NextToken</code>
1667
1799
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1701,6 +1833,7 @@ export declare class ResourceArnNotFoundException extends __BaseException {
1701
1833
  */
1702
1834
  export interface GetResourceShareAssociationsRequest {
1703
1835
  /**
1836
+ * @public
1704
1837
  * <p>Specifies whether you want to retrieve the associations that involve a specified
1705
1838
  * resource or principal.</p>
1706
1839
  * <ul>
@@ -1718,17 +1851,20 @@ export interface GetResourceShareAssociationsRequest {
1718
1851
  */
1719
1852
  associationType: ResourceShareAssociationType | string | undefined;
1720
1853
  /**
1854
+ * @public
1721
1855
  * <p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resource share whose associations you want to
1722
1856
  * retrieve.</p>
1723
1857
  */
1724
1858
  resourceShareArns?: string[];
1725
1859
  /**
1860
+ * @public
1726
1861
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a resource whose resource shares you want to retrieve.</p>
1727
1862
  * <p>You cannot specify this parameter if the association type is
1728
1863
  * <code>PRINCIPAL</code>.</p>
1729
1864
  */
1730
1865
  resourceArn?: string;
1731
1866
  /**
1867
+ * @public
1732
1868
  * <p>Specifies the ID of the principal whose resource shares you want to retrieve. This can be an
1733
1869
  * Amazon Web Services account ID, an organization ID, an organizational unit ID, or the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an
1734
1870
  * individual IAM role or user.</p>
@@ -1737,10 +1873,12 @@ export interface GetResourceShareAssociationsRequest {
1737
1873
  */
1738
1874
  principal?: string;
1739
1875
  /**
1876
+ * @public
1740
1877
  * <p>Specifies that you want to retrieve only associations that have this status.</p>
1741
1878
  */
1742
1879
  associationStatus?: ResourceShareAssociationStatus | string;
1743
1880
  /**
1881
+ * @public
1744
1882
  * <p>Specifies that you want to receive the next page of results. Valid
1745
1883
  * only if you received a <code>NextToken</code> response in the previous request. If you
1746
1884
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1749,6 +1887,7 @@ export interface GetResourceShareAssociationsRequest {
1749
1887
  */
1750
1888
  nextToken?: string;
1751
1889
  /**
1890
+ * @public
1752
1891
  * <p>Specifies the total number of results that you want included on each page
1753
1892
  * of the response. If you do not include this parameter, it defaults to a value that is
1754
1893
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1766,10 +1905,12 @@ export interface GetResourceShareAssociationsRequest {
1766
1905
  */
1767
1906
  export interface GetResourceShareAssociationsResponse {
1768
1907
  /**
1908
+ * @public
1769
1909
  * <p>An array of objects that contain the details about the associations.</p>
1770
1910
  */
1771
1911
  resourceShareAssociations?: ResourceShareAssociation[];
1772
1912
  /**
1913
+ * @public
1773
1914
  * <p>If present, this value indicates that more output is available than
1774
1915
  * is included in the current response. Use this value in the <code>NextToken</code>
1775
1916
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1783,16 +1924,19 @@ export interface GetResourceShareAssociationsResponse {
1783
1924
  */
1784
1925
  export interface GetResourceShareInvitationsRequest {
1785
1926
  /**
1927
+ * @public
1786
1928
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resource share invitations you want information about.</p>
1787
1929
  */
1788
1930
  resourceShareInvitationArns?: string[];
1789
1931
  /**
1932
+ * @public
1790
1933
  * <p>Specifies that you want details about invitations only for the resource shares described by this
1791
1934
  * list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
1792
1935
  * </p>
1793
1936
  */
1794
1937
  resourceShareArns?: string[];
1795
1938
  /**
1939
+ * @public
1796
1940
  * <p>Specifies that you want to receive the next page of results. Valid
1797
1941
  * only if you received a <code>NextToken</code> response in the previous request. If you
1798
1942
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1801,6 +1945,7 @@ export interface GetResourceShareInvitationsRequest {
1801
1945
  */
1802
1946
  nextToken?: string;
1803
1947
  /**
1948
+ * @public
1804
1949
  * <p>Specifies the total number of results that you want included on each page
1805
1950
  * of the response. If you do not include this parameter, it defaults to a value that is
1806
1951
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1818,10 +1963,12 @@ export interface GetResourceShareInvitationsRequest {
1818
1963
  */
1819
1964
  export interface GetResourceShareInvitationsResponse {
1820
1965
  /**
1966
+ * @public
1821
1967
  * <p>An array of objects that contain the details about the invitations.</p>
1822
1968
  */
1823
1969
  resourceShareInvitations?: ResourceShareInvitation[];
1824
1970
  /**
1971
+ * @public
1825
1972
  * <p>If present, this value indicates that more output is available than
1826
1973
  * is included in the current response. Use this value in the <code>NextToken</code>
1827
1974
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1862,10 +2009,12 @@ export type ResourceOwner = (typeof ResourceOwner)[keyof typeof ResourceOwner];
1862
2009
  */
1863
2010
  export interface TagFilter {
1864
2011
  /**
2012
+ * @public
1865
2013
  * <p>The tag key. This must have a valid string value and can't be empty.</p>
1866
2014
  */
1867
2015
  tagKey?: string;
1868
2016
  /**
2017
+ * @public
1869
2018
  * <p>A list of zero or more tag values. If no values are provided, then the filter matches
1870
2019
  * any tag with the specified key, regardless of its value.</p>
1871
2020
  */
@@ -1876,15 +2025,18 @@ export interface TagFilter {
1876
2025
  */
1877
2026
  export interface GetResourceSharesRequest {
1878
2027
  /**
2028
+ * @public
1879
2029
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of individual resource shares that you want information about.</p>
1880
2030
  */
1881
2031
  resourceShareArns?: string[];
1882
2032
  /**
2033
+ * @public
1883
2034
  * <p>Specifies that you want to retrieve details of only those resource shares that have this
1884
2035
  * status.</p>
1885
2036
  */
1886
2037
  resourceShareStatus?: ResourceShareStatus | string;
1887
2038
  /**
2039
+ * @public
1888
2040
  * <p>Specifies that you want to retrieve details of only those resource shares that match the
1889
2041
  * following:</p>
1890
2042
  * <ul>
@@ -1906,16 +2058,19 @@ export interface GetResourceSharesRequest {
1906
2058
  */
1907
2059
  resourceOwner: ResourceOwner | string | undefined;
1908
2060
  /**
2061
+ * @public
1909
2062
  * <p>Specifies the name of an individual resource share that you want to retrieve details
1910
2063
  * about.</p>
1911
2064
  */
1912
2065
  name?: string;
1913
2066
  /**
2067
+ * @public
1914
2068
  * <p>Specifies that you want to retrieve details of only those resource shares that match the
1915
2069
  * specified tag keys and values.</p>
1916
2070
  */
1917
2071
  tagFilters?: TagFilter[];
1918
2072
  /**
2073
+ * @public
1919
2074
  * <p>Specifies that you want to receive the next page of results. Valid
1920
2075
  * only if you received a <code>NextToken</code> response in the previous request. If you
1921
2076
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1924,6 +2079,7 @@ export interface GetResourceSharesRequest {
1924
2079
  */
1925
2080
  nextToken?: string;
1926
2081
  /**
2082
+ * @public
1927
2083
  * <p>Specifies the total number of results that you want included on each page
1928
2084
  * of the response. If you do not include this parameter, it defaults to a value that is
1929
2085
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1936,11 +2092,13 @@ export interface GetResourceSharesRequest {
1936
2092
  */
1937
2093
  maxResults?: number;
1938
2094
  /**
2095
+ * @public
1939
2096
  * <p>Specifies that you want to retrieve details of only those resource shares that use the managed permission with
1940
2097
  * this <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a>.</p>
1941
2098
  */
1942
2099
  permissionArn?: string;
1943
2100
  /**
2101
+ * @public
1944
2102
  * <p>Specifies that you want to retrieve details for only those resource shares that use the
1945
2103
  * specified version of the managed permission.</p>
1946
2104
  */
@@ -1951,10 +2109,12 @@ export interface GetResourceSharesRequest {
1951
2109
  */
1952
2110
  export interface GetResourceSharesResponse {
1953
2111
  /**
2112
+ * @public
1954
2113
  * <p>An array of objects that contain the information about the resource shares.</p>
1955
2114
  */
1956
2115
  resourceShares?: ResourceShare[];
1957
2116
  /**
2117
+ * @public
1958
2118
  * <p>If present, this value indicates that more output is available than
1959
2119
  * is included in the current response. Use this value in the <code>NextToken</code>
1960
2120
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1981,10 +2141,12 @@ export type ResourceRegionScopeFilter = (typeof ResourceRegionScopeFilter)[keyof
1981
2141
  */
1982
2142
  export interface ListPendingInvitationResourcesRequest {
1983
2143
  /**
2144
+ * @public
1984
2145
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the invitation. You can use <a>GetResourceShareInvitations</a> to find the ARN of the invitation.</p>
1985
2146
  */
1986
2147
  resourceShareInvitationArn: string | undefined;
1987
2148
  /**
2149
+ * @public
1988
2150
  * <p>Specifies that you want to receive the next page of results. Valid
1989
2151
  * only if you received a <code>NextToken</code> response in the previous request. If you
1990
2152
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1993,6 +2155,7 @@ export interface ListPendingInvitationResourcesRequest {
1993
2155
  */
1994
2156
  nextToken?: string;
1995
2157
  /**
2158
+ * @public
1996
2159
  * <p>Specifies the total number of results that you want included on each page
1997
2160
  * of the response. If you do not include this parameter, it defaults to a value that is
1998
2161
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2005,6 +2168,7 @@ export interface ListPendingInvitationResourcesRequest {
2005
2168
  */
2006
2169
  maxResults?: number;
2007
2170
  /**
2171
+ * @public
2008
2172
  * <p>Specifies that you want the results to include only
2009
2173
  * resources that have the specified scope.</p>
2010
2174
  * <ul>
@@ -2061,10 +2225,12 @@ export type ResourceStatus = (typeof ResourceStatus)[keyof typeof ResourceStatus
2061
2225
  */
2062
2226
  export interface Resource {
2063
2227
  /**
2228
+ * @public
2064
2229
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource.</p>
2065
2230
  */
2066
2231
  arn?: string;
2067
2232
  /**
2233
+ * @public
2068
2234
  * <p>The resource type. This takes the form of:
2069
2235
  * <code>service-code</code>:<code>resource-code</code>, and is case-insensitive. For
2070
2236
  * example, an Amazon EC2 Subnet would be represented by the string
@@ -2072,32 +2238,39 @@ export interface Resource {
2072
2238
  */
2073
2239
  type?: string;
2074
2240
  /**
2241
+ * @public
2075
2242
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share this resource is associated with.</p>
2076
2243
  */
2077
2244
  resourceShareArn?: string;
2078
2245
  /**
2246
+ * @public
2079
2247
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource group. This value is available only if the resource is
2080
2248
  * part of a resource group.</p>
2081
2249
  */
2082
2250
  resourceGroupArn?: string;
2083
2251
  /**
2252
+ * @public
2084
2253
  * <p>The current status of the resource.</p>
2085
2254
  */
2086
2255
  status?: ResourceStatus | string;
2087
2256
  /**
2257
+ * @public
2088
2258
  * <p>A message about the status of the resource.</p>
2089
2259
  */
2090
2260
  statusMessage?: string;
2091
2261
  /**
2262
+ * @public
2092
2263
  * <p>The date and time when the resource was associated with the resource share.</p>
2093
2264
  */
2094
2265
  creationTime?: Date;
2095
2266
  /**
2267
+ * @public
2096
2268
  * <p>The date an time when the association between the resource and the resource share was
2097
2269
  * last updated.</p>
2098
2270
  */
2099
2271
  lastUpdatedTime?: Date;
2100
2272
  /**
2273
+ * @public
2101
2274
  * <p>Specifies the scope of visibility of this resource:</p>
2102
2275
  * <ul>
2103
2276
  * <li>
@@ -2120,11 +2293,13 @@ export interface Resource {
2120
2293
  */
2121
2294
  export interface ListPendingInvitationResourcesResponse {
2122
2295
  /**
2296
+ * @public
2123
2297
  * <p>An array of objects that contain the information about the resources included the
2124
2298
  * specified resource share.</p>
2125
2299
  */
2126
2300
  resources?: Resource[];
2127
2301
  /**
2302
+ * @public
2128
2303
  * <p>If present, this value indicates that more output is available than
2129
2304
  * is included in the current response. Use this value in the <code>NextToken</code>
2130
2305
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2150,10 +2325,12 @@ export declare class MissingRequiredParameterException extends __BaseException {
2150
2325
  */
2151
2326
  export interface ListPermissionAssociationsRequest {
2152
2327
  /**
2328
+ * @public
2153
2329
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the managed permission.</p>
2154
2330
  */
2155
2331
  permissionArn?: string;
2156
2332
  /**
2333
+ * @public
2157
2334
  * <p>Specifies that you want to list only those associations with resource shares that use this
2158
2335
  * version of the managed permission. If you don't provide a value for this parameter, then the operation
2159
2336
  * returns information about associations with resource shares that use any version of the
@@ -2161,21 +2338,25 @@ export interface ListPermissionAssociationsRequest {
2161
2338
  */
2162
2339
  permissionVersion?: number;
2163
2340
  /**
2341
+ * @public
2164
2342
  * <p>Specifies that you want to list only those associations with resource shares that match this
2165
2343
  * status.</p>
2166
2344
  */
2167
2345
  associationStatus?: ResourceShareAssociationStatus | string;
2168
2346
  /**
2347
+ * @public
2169
2348
  * <p>Specifies that you want to list only those associations with resource shares that include at
2170
2349
  * least one resource of this resource type.</p>
2171
2350
  */
2172
2351
  resourceType?: string;
2173
2352
  /**
2353
+ * @public
2174
2354
  * <p>Specifies that you want to list only those associations with resource shares that have a
2175
2355
  * <code>featureSet</code> with this value.</p>
2176
2356
  */
2177
2357
  featureSet?: PermissionFeatureSet | string;
2178
2358
  /**
2359
+ * @public
2179
2360
  * <p>When <code>true</code>, specifies that you want to list only those associations with
2180
2361
  * resource shares that use the default version of the specified managed permission.</p>
2181
2362
  * <p>When <code>false</code> (the default value), lists associations with resource shares that use
@@ -2183,6 +2364,7 @@ export interface ListPermissionAssociationsRequest {
2183
2364
  */
2184
2365
  defaultVersion?: boolean;
2185
2366
  /**
2367
+ * @public
2186
2368
  * <p>Specifies that you want to receive the next page of results. Valid
2187
2369
  * only if you received a <code>NextToken</code> response in the previous request. If you
2188
2370
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2191,6 +2373,7 @@ export interface ListPermissionAssociationsRequest {
2191
2373
  */
2192
2374
  nextToken?: string;
2193
2375
  /**
2376
+ * @public
2194
2377
  * <p>Specifies the total number of results that you want included on each page
2195
2378
  * of the response. If you do not include this parameter, it defaults to a value that is
2196
2379
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2209,23 +2392,28 @@ export interface ListPermissionAssociationsRequest {
2209
2392
  */
2210
2393
  export interface AssociatedPermission {
2211
2394
  /**
2395
+ * @public
2212
2396
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the associated managed permission.</p>
2213
2397
  */
2214
2398
  arn?: string;
2215
2399
  /**
2400
+ * @public
2216
2401
  * <p>The version of the permission currently associated with the resource share.</p>
2217
2402
  */
2218
2403
  permissionVersion?: string;
2219
2404
  /**
2405
+ * @public
2220
2406
  * <p>Indicates whether the associated resource share is using the default version of the
2221
2407
  * permission.</p>
2222
2408
  */
2223
2409
  defaultVersion?: boolean;
2224
2410
  /**
2411
+ * @public
2225
2412
  * <p>The resource type to which this permission applies.</p>
2226
2413
  */
2227
2414
  resourceType?: string;
2228
2415
  /**
2416
+ * @public
2229
2417
  * <p>The current status of the association between the permission and the resource share.
2230
2418
  * The following are the possible values:</p>
2231
2419
  * <ul>
@@ -2252,6 +2440,7 @@ export interface AssociatedPermission {
2252
2440
  */
2253
2441
  status?: string;
2254
2442
  /**
2443
+ * @public
2255
2444
  * <p>Indicates what features are available for this resource share. This parameter can have one of
2256
2445
  * the following values:</p>
2257
2446
  * <ul>
@@ -2284,11 +2473,13 @@ export interface AssociatedPermission {
2284
2473
  */
2285
2474
  featureSet?: PermissionFeatureSet | string;
2286
2475
  /**
2476
+ * @public
2287
2477
  * <p>The date and time when the association between the permission and the resource share
2288
2478
  * was last updated.</p>
2289
2479
  */
2290
2480
  lastUpdatedTime?: Date;
2291
2481
  /**
2482
+ * @public
2292
2483
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a resource share associated with this permission.</p>
2293
2484
  */
2294
2485
  resourceShareArn?: string;
@@ -2298,10 +2489,12 @@ export interface AssociatedPermission {
2298
2489
  */
2299
2490
  export interface ListPermissionAssociationsResponse {
2300
2491
  /**
2492
+ * @public
2301
2493
  * <p>A structure with information about this customer managed permission.</p>
2302
2494
  */
2303
2495
  permissions?: AssociatedPermission[];
2304
2496
  /**
2497
+ * @public
2305
2498
  * <p>If present, this value indicates that more output is available than
2306
2499
  * is included in the current response. Use this value in the <code>NextToken</code>
2307
2500
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2328,6 +2521,7 @@ export type PermissionTypeFilter = (typeof PermissionTypeFilter)[keyof typeof Pe
2328
2521
  */
2329
2522
  export interface ListPermissionsRequest {
2330
2523
  /**
2524
+ * @public
2331
2525
  * <p>Specifies that you want to list only those permissions that apply to the specified
2332
2526
  * resource type. This parameter is not case sensitive.</p>
2333
2527
  * <p>For example, to list only permissions that apply to Amazon EC2 subnets, specify
@@ -2336,6 +2530,7 @@ export interface ListPermissionsRequest {
2336
2530
  */
2337
2531
  resourceType?: string;
2338
2532
  /**
2533
+ * @public
2339
2534
  * <p>Specifies that you want to receive the next page of results. Valid
2340
2535
  * only if you received a <code>NextToken</code> response in the previous request. If you
2341
2536
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2344,6 +2539,7 @@ export interface ListPermissionsRequest {
2344
2539
  */
2345
2540
  nextToken?: string;
2346
2541
  /**
2542
+ * @public
2347
2543
  * <p>Specifies the total number of results that you want included on each page
2348
2544
  * of the response. If you do not include this parameter, it defaults to a value that is
2349
2545
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2356,6 +2552,7 @@ export interface ListPermissionsRequest {
2356
2552
  */
2357
2553
  maxResults?: number;
2358
2554
  /**
2555
+ * @public
2359
2556
  * <p>Specifies that you want to list only permissions of this type:</p>
2360
2557
  * <ul>
2361
2558
  * <li>
@@ -2380,10 +2577,12 @@ export interface ListPermissionsRequest {
2380
2577
  */
2381
2578
  export interface ListPermissionsResponse {
2382
2579
  /**
2580
+ * @public
2383
2581
  * <p>An array of objects with information about the permissions.</p>
2384
2582
  */
2385
2583
  permissions?: ResourceSharePermissionSummary[];
2386
2584
  /**
2585
+ * @public
2387
2586
  * <p>If present, this value indicates that more output is available than
2388
2587
  * is included in the current response. Use this value in the <code>NextToken</code>
2389
2588
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2397,12 +2596,14 @@ export interface ListPermissionsResponse {
2397
2596
  */
2398
2597
  export interface ListPermissionVersionsRequest {
2399
2598
  /**
2599
+ * @public
2400
2600
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the RAM permission whose versions you want to list. You
2401
2601
  * can use the <code>permissionVersion</code> parameter on the <a>AssociateResourceSharePermission</a> operation to specify a non-default
2402
2602
  * version to attach.</p>
2403
2603
  */
2404
2604
  permissionArn: string | undefined;
2405
2605
  /**
2606
+ * @public
2406
2607
  * <p>Specifies that you want to receive the next page of results. Valid
2407
2608
  * only if you received a <code>NextToken</code> response in the previous request. If you
2408
2609
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2411,6 +2612,7 @@ export interface ListPermissionVersionsRequest {
2411
2612
  */
2412
2613
  nextToken?: string;
2413
2614
  /**
2615
+ * @public
2414
2616
  * <p>Specifies the total number of results that you want included on each page
2415
2617
  * of the response. If you do not include this parameter, it defaults to a value that is
2416
2618
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2428,10 +2630,12 @@ export interface ListPermissionVersionsRequest {
2428
2630
  */
2429
2631
  export interface ListPermissionVersionsResponse {
2430
2632
  /**
2633
+ * @public
2431
2634
  * <p>An array of objects that contain details for each of the available versions.</p>
2432
2635
  */
2433
2636
  permissions?: ResourceSharePermissionSummary[];
2434
2637
  /**
2638
+ * @public
2435
2639
  * <p>If present, this value indicates that more output is available than
2436
2640
  * is included in the current response. Use this value in the <code>NextToken</code>
2437
2641
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2445,6 +2649,7 @@ export interface ListPermissionVersionsResponse {
2445
2649
  */
2446
2650
  export interface ListPrincipalsRequest {
2447
2651
  /**
2652
+ * @public
2448
2653
  * <p>Specifies that you want to list information for only resource shares that match the
2449
2654
  * following:</p>
2450
2655
  * <ul>
@@ -2466,11 +2671,13 @@ export interface ListPrincipalsRequest {
2466
2671
  */
2467
2672
  resourceOwner: ResourceOwner | string | undefined;
2468
2673
  /**
2674
+ * @public
2469
2675
  * <p>Specifies that you want to list principal information for the resource share with the specified
2470
2676
  * <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a>.</p>
2471
2677
  */
2472
2678
  resourceArn?: string;
2473
2679
  /**
2680
+ * @public
2474
2681
  * <p>Specifies that you want to list information for only the listed principals.</p>
2475
2682
  * <p>You can include the following values:</p>
2476
2683
  * <ul>
@@ -2507,6 +2714,7 @@ export interface ListPrincipalsRequest {
2507
2714
  */
2508
2715
  principals?: string[];
2509
2716
  /**
2717
+ * @public
2510
2718
  * <p>Specifies that you want to list information for only principals associated with resource shares
2511
2719
  * that include the specified resource type.</p>
2512
2720
  * <p>For a list of valid values, query the <a>ListResourceTypes</a>
@@ -2514,11 +2722,13 @@ export interface ListPrincipalsRequest {
2514
2722
  */
2515
2723
  resourceType?: string;
2516
2724
  /**
2725
+ * @public
2517
2726
  * <p>Specifies that you want to list information for only principals associated with the
2518
2727
  * resource shares specified by a list the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
2519
2728
  */
2520
2729
  resourceShareArns?: string[];
2521
2730
  /**
2731
+ * @public
2522
2732
  * <p>Specifies that you want to receive the next page of results. Valid
2523
2733
  * only if you received a <code>NextToken</code> response in the previous request. If you
2524
2734
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2527,6 +2737,7 @@ export interface ListPrincipalsRequest {
2527
2737
  */
2528
2738
  nextToken?: string;
2529
2739
  /**
2740
+ * @public
2530
2741
  * <p>Specifies the total number of results that you want included on each page
2531
2742
  * of the response. If you do not include this parameter, it defaults to a value that is
2532
2743
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2545,23 +2756,28 @@ export interface ListPrincipalsRequest {
2545
2756
  */
2546
2757
  export interface Principal {
2547
2758
  /**
2759
+ * @public
2548
2760
  * <p>The ID of the principal that can be associated with a resource share.</p>
2549
2761
  */
2550
2762
  id?: string;
2551
2763
  /**
2764
+ * @public
2552
2765
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a resource share the principal is associated with.</p>
2553
2766
  */
2554
2767
  resourceShareArn?: string;
2555
2768
  /**
2769
+ * @public
2556
2770
  * <p>The date and time when the principal was associated with the resource share.</p>
2557
2771
  */
2558
2772
  creationTime?: Date;
2559
2773
  /**
2774
+ * @public
2560
2775
  * <p>The date and time when the association between the resource share and the principal
2561
2776
  * was last updated.</p>
2562
2777
  */
2563
2778
  lastUpdatedTime?: Date;
2564
2779
  /**
2780
+ * @public
2565
2781
  * <p>Indicates the relationship between the Amazon Web Services account the principal belongs to and the
2566
2782
  * account that owns the resource share:</p>
2567
2783
  * <ul>
@@ -2584,10 +2800,12 @@ export interface Principal {
2584
2800
  */
2585
2801
  export interface ListPrincipalsResponse {
2586
2802
  /**
2803
+ * @public
2587
2804
  * <p>An array of objects that contain the details about the principals.</p>
2588
2805
  */
2589
2806
  principals?: Principal[];
2590
2807
  /**
2808
+ * @public
2591
2809
  * <p>If present, this value indicates that more output is available than
2592
2810
  * is included in the current response. Use this value in the <code>NextToken</code>
2593
2811
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2614,16 +2832,19 @@ export type ReplacePermissionAssociationsWorkStatus = (typeof ReplacePermissionA
2614
2832
  */
2615
2833
  export interface ListReplacePermissionAssociationsWorkRequest {
2616
2834
  /**
2835
+ * @public
2617
2836
  * <p>A list of IDs. These values come from the <code>id</code>field of the
2618
2837
  * <code>replacePermissionAssociationsWork</code>structure returned by the <a>ReplacePermissionAssociations</a> operation. </p>
2619
2838
  */
2620
2839
  workIds?: string[];
2621
2840
  /**
2841
+ * @public
2622
2842
  * <p>Specifies that you want to see only the details about requests with a status that
2623
2843
  * matches this value.</p>
2624
2844
  */
2625
2845
  status?: ReplacePermissionAssociationsWorkStatus | string;
2626
2846
  /**
2847
+ * @public
2627
2848
  * <p>Specifies that you want to receive the next page of results. Valid
2628
2849
  * only if you received a <code>NextToken</code> response in the previous request. If you
2629
2850
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2632,6 +2853,7 @@ export interface ListReplacePermissionAssociationsWorkRequest {
2632
2853
  */
2633
2854
  nextToken?: string;
2634
2855
  /**
2856
+ * @public
2635
2857
  * <p>Specifies the total number of results that you want included on each page
2636
2858
  * of the response. If you do not include this parameter, it defaults to a value that is
2637
2859
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2651,29 +2873,35 @@ export interface ListReplacePermissionAssociationsWorkRequest {
2651
2873
  */
2652
2874
  export interface ReplacePermissionAssociationsWork {
2653
2875
  /**
2876
+ * @public
2654
2877
  * <p>The unique identifier for the background task associated with one <a>ReplacePermissionAssociations</a> request.</p>
2655
2878
  */
2656
2879
  id?: string;
2657
2880
  /**
2881
+ * @public
2658
2882
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the managed permission that this background task is replacing.</p>
2659
2883
  */
2660
2884
  fromPermissionArn?: string;
2661
2885
  /**
2886
+ * @public
2662
2887
  * <p>The version of the managed permission that this background task is replacing.</p>
2663
2888
  */
2664
2889
  fromPermissionVersion?: string;
2665
2890
  /**
2891
+ * @public
2666
2892
  * <p>The ARN of the managed permission that this background task is associating with the resource shares in place
2667
2893
  * of the managed permission and version specified in <code>fromPermissionArn</code> and
2668
2894
  * <code>fromPermissionVersion</code>.</p>
2669
2895
  */
2670
2896
  toPermissionArn?: string;
2671
2897
  /**
2898
+ * @public
2672
2899
  * <p>The version of the managed permission that this background task is associating with the resource shares. This
2673
2900
  * is always the version that is currently the default for this managed permission.</p>
2674
2901
  */
2675
2902
  toPermissionVersion?: string;
2676
2903
  /**
2904
+ * @public
2677
2905
  * <p>Specifies the current status of the background tasks for the specified ID. The output
2678
2906
  * is one of the following strings:</p>
2679
2907
  * <ul>
@@ -2696,15 +2924,18 @@ export interface ReplacePermissionAssociationsWork {
2696
2924
  */
2697
2925
  status?: ReplacePermissionAssociationsWorkStatus | string;
2698
2926
  /**
2927
+ * @public
2699
2928
  * <p>Specifies the reason for a <code>FAILED</code> status. This field is present only when
2700
2929
  * there <code>status</code> is <code>FAILED</code>.</p>
2701
2930
  */
2702
2931
  statusMessage?: string;
2703
2932
  /**
2933
+ * @public
2704
2934
  * <p>The date and time when this asynchronous background task was created.</p>
2705
2935
  */
2706
2936
  creationTime?: Date;
2707
2937
  /**
2938
+ * @public
2708
2939
  * <p>The date and time when the status of this background task was last updated.</p>
2709
2940
  */
2710
2941
  lastUpdatedTime?: Date;
@@ -2714,10 +2945,12 @@ export interface ReplacePermissionAssociationsWork {
2714
2945
  */
2715
2946
  export interface ListReplacePermissionAssociationsWorkResponse {
2716
2947
  /**
2948
+ * @public
2717
2949
  * <p>An array of data structures that provide details of the matching work IDs.</p>
2718
2950
  */
2719
2951
  replacePermissionAssociationsWorks?: ReplacePermissionAssociationsWork[];
2720
2952
  /**
2953
+ * @public
2721
2954
  * <p>If present, this value indicates that more output is available than
2722
2955
  * is included in the current response. Use this value in the <code>NextToken</code>
2723
2956
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2743,6 +2976,7 @@ export declare class InvalidResourceTypeException extends __BaseException {
2743
2976
  */
2744
2977
  export interface ListResourcesRequest {
2745
2978
  /**
2979
+ * @public
2746
2980
  * <p>Specifies that you want to list only the resource shares that match the following:</p>
2747
2981
  * <ul>
2748
2982
  * <li>
@@ -2763,27 +2997,32 @@ export interface ListResourcesRequest {
2763
2997
  */
2764
2998
  resourceOwner: ResourceOwner | string | undefined;
2765
2999
  /**
3000
+ * @public
2766
3001
  * <p>Specifies that you want to list only the resource shares that are associated with the specified
2767
3002
  * principal.</p>
2768
3003
  */
2769
3004
  principal?: string;
2770
3005
  /**
3006
+ * @public
2771
3007
  * <p>Specifies that you want to list only the resource shares that include resources of the specified
2772
3008
  * resource type.</p>
2773
3009
  * <p>For valid values, query the <a>ListResourceTypes</a> operation.</p>
2774
3010
  */
2775
3011
  resourceType?: string;
2776
3012
  /**
3013
+ * @public
2777
3014
  * <p>Specifies that you want to list only the resource shares that include resources with the
2778
3015
  * specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
2779
3016
  */
2780
3017
  resourceArns?: string[];
2781
3018
  /**
3019
+ * @public
2782
3020
  * <p>Specifies that you want to list only resources in the resource shares identified by the
2783
3021
  * specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>
2784
3022
  */
2785
3023
  resourceShareArns?: string[];
2786
3024
  /**
3025
+ * @public
2787
3026
  * <p>Specifies that you want to receive the next page of results. Valid
2788
3027
  * only if you received a <code>NextToken</code> response in the previous request. If you
2789
3028
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2792,6 +3031,7 @@ export interface ListResourcesRequest {
2792
3031
  */
2793
3032
  nextToken?: string;
2794
3033
  /**
3034
+ * @public
2795
3035
  * <p>Specifies the total number of results that you want included on each page
2796
3036
  * of the response. If you do not include this parameter, it defaults to a value that is
2797
3037
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2804,6 +3044,7 @@ export interface ListResourcesRequest {
2804
3044
  */
2805
3045
  maxResults?: number;
2806
3046
  /**
3047
+ * @public
2807
3048
  * <p>Specifies that you want the results to include only
2808
3049
  * resources that have the specified scope.</p>
2809
3050
  * <ul>
@@ -2832,10 +3073,12 @@ export interface ListResourcesRequest {
2832
3073
  */
2833
3074
  export interface ListResourcesResponse {
2834
3075
  /**
3076
+ * @public
2835
3077
  * <p>An array of objects that contain information about the resources.</p>
2836
3078
  */
2837
3079
  resources?: Resource[];
2838
3080
  /**
3081
+ * @public
2839
3082
  * <p>If present, this value indicates that more output is available than
2840
3083
  * is included in the current response. Use this value in the <code>NextToken</code>
2841
3084
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2849,11 +3092,13 @@ export interface ListResourcesResponse {
2849
3092
  */
2850
3093
  export interface ListResourceSharePermissionsRequest {
2851
3094
  /**
3095
+ * @public
2852
3096
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share for which you want to retrieve the associated
2853
3097
  * permissions.</p>
2854
3098
  */
2855
3099
  resourceShareArn: string | undefined;
2856
3100
  /**
3101
+ * @public
2857
3102
  * <p>Specifies that you want to receive the next page of results. Valid
2858
3103
  * only if you received a <code>NextToken</code> response in the previous request. If you
2859
3104
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2862,6 +3107,7 @@ export interface ListResourceSharePermissionsRequest {
2862
3107
  */
2863
3108
  nextToken?: string;
2864
3109
  /**
3110
+ * @public
2865
3111
  * <p>Specifies the total number of results that you want included on each page
2866
3112
  * of the response. If you do not include this parameter, it defaults to a value that is
2867
3113
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2879,10 +3125,12 @@ export interface ListResourceSharePermissionsRequest {
2879
3125
  */
2880
3126
  export interface ListResourceSharePermissionsResponse {
2881
3127
  /**
3128
+ * @public
2882
3129
  * <p>An array of objects that describe the permissions associated with the resource share.</p>
2883
3130
  */
2884
3131
  permissions?: ResourceSharePermissionSummary[];
2885
3132
  /**
3133
+ * @public
2886
3134
  * <p>If present, this value indicates that more output is available than
2887
3135
  * is included in the current response. Use this value in the <code>NextToken</code>
2888
3136
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2896,6 +3144,7 @@ export interface ListResourceSharePermissionsResponse {
2896
3144
  */
2897
3145
  export interface ListResourceTypesRequest {
2898
3146
  /**
3147
+ * @public
2899
3148
  * <p>Specifies that you want to receive the next page of results. Valid
2900
3149
  * only if you received a <code>NextToken</code> response in the previous request. If you
2901
3150
  * did, it indicates that more output is available. Set this parameter to the value
@@ -2904,6 +3153,7 @@ export interface ListResourceTypesRequest {
2904
3153
  */
2905
3154
  nextToken?: string;
2906
3155
  /**
3156
+ * @public
2907
3157
  * <p>Specifies the total number of results that you want included on each page
2908
3158
  * of the response. If you do not include this parameter, it defaults to a value that is
2909
3159
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -2916,6 +3166,7 @@ export interface ListResourceTypesRequest {
2916
3166
  */
2917
3167
  maxResults?: number;
2918
3168
  /**
3169
+ * @public
2919
3170
  * <p>Specifies that you want the results to include only
2920
3171
  * resources that have the specified scope.</p>
2921
3172
  * <ul>
@@ -2946,6 +3197,7 @@ export interface ListResourceTypesRequest {
2946
3197
  */
2947
3198
  export interface ServiceNameAndResourceType {
2948
3199
  /**
3200
+ * @public
2949
3201
  * <p>The type of the resource. This takes the form of:
2950
3202
  * <code>service-code</code>:<code>resource-code</code>, and is case-insensitive. For
2951
3203
  * example, an Amazon EC2 Subnet would be represented by the string
@@ -2953,10 +3205,12 @@ export interface ServiceNameAndResourceType {
2953
3205
  */
2954
3206
  resourceType?: string;
2955
3207
  /**
3208
+ * @public
2956
3209
  * <p>The name of the Amazon Web Services service to which resources of this type belong.</p>
2957
3210
  */
2958
3211
  serviceName?: string;
2959
3212
  /**
3213
+ * @public
2960
3214
  * <p>Specifies the scope of visibility of resources of this type:</p>
2961
3215
  * <ul>
2962
3216
  * <li>
@@ -2979,11 +3233,13 @@ export interface ServiceNameAndResourceType {
2979
3233
  */
2980
3234
  export interface ListResourceTypesResponse {
2981
3235
  /**
3236
+ * @public
2982
3237
  * <p>An array of objects that contain information about the resource types that can be
2983
3238
  * shared using RAM.</p>
2984
3239
  */
2985
3240
  resourceTypes?: ServiceNameAndResourceType[];
2986
3241
  /**
3242
+ * @public
2987
3243
  * <p>If present, this value indicates that more output is available than
2988
3244
  * is included in the current response. Use this value in the <code>NextToken</code>
2989
3245
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -2997,15 +3253,18 @@ export interface ListResourceTypesResponse {
2997
3253
  */
2998
3254
  export interface PromotePermissionCreatedFromPolicyRequest {
2999
3255
  /**
3256
+ * @public
3000
3257
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the <code>CREATED_FROM_POLICY</code> permission that you
3001
3258
  * want to promote. You can get this <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> by calling the <a>ListResourceSharePermissions</a> operation.</p>
3002
3259
  */
3003
3260
  permissionArn: string | undefined;
3004
3261
  /**
3262
+ * @public
3005
3263
  * <p>Specifies a name for the promoted customer managed permission.</p>
3006
3264
  */
3007
3265
  name: string | undefined;
3008
3266
  /**
3267
+ * @public
3009
3268
  * <p>Specifies a unique, case-sensitive identifier that you provide to
3010
3269
  * ensure the idempotency of the request. This lets you safely retry the request without
3011
3270
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -3025,10 +3284,12 @@ export interface PromotePermissionCreatedFromPolicyRequest {
3025
3284
  */
3026
3285
  export interface PromotePermissionCreatedFromPolicyResponse {
3027
3286
  /**
3287
+ * @public
3028
3288
  * <p>Information about an RAM permission.</p>
3029
3289
  */
3030
3290
  permission?: ResourceSharePermissionSummary;
3031
3291
  /**
3292
+ * @public
3032
3293
  * <p>The idempotency identifier associated with this request. If you
3033
3294
  * want to repeat the same operation in an idempotent manner then you must include this
3034
3295
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -3041,6 +3302,7 @@ export interface PromotePermissionCreatedFromPolicyResponse {
3041
3302
  */
3042
3303
  export interface PromoteResourceShareCreatedFromPolicyRequest {
3043
3304
  /**
3305
+ * @public
3044
3306
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share to promote.</p>
3045
3307
  */
3046
3308
  resourceShareArn: string | undefined;
@@ -3050,6 +3312,7 @@ export interface PromoteResourceShareCreatedFromPolicyRequest {
3050
3312
  */
3051
3313
  export interface PromoteResourceShareCreatedFromPolicyResponse {
3052
3314
  /**
3315
+ * @public
3053
3316
  * <p>A return value of <code>true</code> indicates that the request succeeded.
3054
3317
  * A value of <code>false</code> indicates that the request failed.</p>
3055
3318
  */
@@ -3073,10 +3336,12 @@ export declare class UnmatchedPolicyPermissionException extends __BaseException
3073
3336
  */
3074
3337
  export interface RejectResourceShareInvitationRequest {
3075
3338
  /**
3339
+ * @public
3076
3340
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the invitation that you want to reject.</p>
3077
3341
  */
3078
3342
  resourceShareInvitationArn: string | undefined;
3079
3343
  /**
3344
+ * @public
3080
3345
  * <p>Specifies a unique, case-sensitive identifier that you provide to
3081
3346
  * ensure the idempotency of the request. This lets you safely retry the request without
3082
3347
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -3096,10 +3361,12 @@ export interface RejectResourceShareInvitationRequest {
3096
3361
  */
3097
3362
  export interface RejectResourceShareInvitationResponse {
3098
3363
  /**
3364
+ * @public
3099
3365
  * <p>An object that contains the details about the rejected invitation.</p>
3100
3366
  */
3101
3367
  resourceShareInvitation?: ResourceShareInvitation;
3102
3368
  /**
3369
+ * @public
3103
3370
  * <p>The idempotency identifier associated with this request. If you
3104
3371
  * want to repeat the same operation in an idempotent manner then you must include this
3105
3372
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -3112,15 +3379,18 @@ export interface RejectResourceShareInvitationResponse {
3112
3379
  */
3113
3380
  export interface ReplacePermissionAssociationsRequest {
3114
3381
  /**
3382
+ * @public
3115
3383
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the managed permission that you want to replace.</p>
3116
3384
  */
3117
3385
  fromPermissionArn: string | undefined;
3118
3386
  /**
3387
+ * @public
3119
3388
  * <p>Specifies that you want to updated the permissions for only those resource shares that use the
3120
3389
  * specified version of the managed permission.</p>
3121
3390
  */
3122
3391
  fromPermissionVersion?: number;
3123
3392
  /**
3393
+ * @public
3124
3394
  * <p>Specifies the ARN of the managed permission that you want to associate with resource
3125
3395
  * shares in place of the one specified by <code>fromPerssionArn</code> and
3126
3396
  * <code>fromPermissionVersion</code>.</p>
@@ -3129,6 +3399,7 @@ export interface ReplacePermissionAssociationsRequest {
3129
3399
  */
3130
3400
  toPermissionArn: string | undefined;
3131
3401
  /**
3402
+ * @public
3132
3403
  * <p>Specifies a unique, case-sensitive identifier that you provide to
3133
3404
  * ensure the idempotency of the request. This lets you safely retry the request without
3134
3405
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -3148,12 +3419,14 @@ export interface ReplacePermissionAssociationsRequest {
3148
3419
  */
3149
3420
  export interface ReplacePermissionAssociationsResponse {
3150
3421
  /**
3422
+ * @public
3151
3423
  * <p>Specifies a data structure that you can use to track the asynchronous tasks that RAM
3152
3424
  * performs to complete this operation. You can use the <a>ListReplacePermissionAssociationsWork</a> operation and pass the
3153
3425
  * <code>id</code> value returned in this structure.</p>
3154
3426
  */
3155
3427
  replacePermissionAssociationsWork?: ReplacePermissionAssociationsWork;
3156
3428
  /**
3429
+ * @public
3157
3430
  * <p>The idempotency identifier associated with this request. If you
3158
3431
  * want to repeat the same operation in an idempotent manner then you must include this
3159
3432
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -3166,15 +3439,18 @@ export interface ReplacePermissionAssociationsResponse {
3166
3439
  */
3167
3440
  export interface SetDefaultPermissionVersionRequest {
3168
3441
  /**
3442
+ * @public
3169
3443
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the customer managed permission whose default version you want to change.</p>
3170
3444
  */
3171
3445
  permissionArn: string | undefined;
3172
3446
  /**
3447
+ * @public
3173
3448
  * <p>Specifies the version number that you want to designate as the default for customer managed permission. To
3174
3449
  * see a list of all available version numbers, use <a>ListPermissionVersions</a>.</p>
3175
3450
  */
3176
3451
  permissionVersion: number | undefined;
3177
3452
  /**
3453
+ * @public
3178
3454
  * <p>Specifies a unique, case-sensitive identifier that you provide to
3179
3455
  * ensure the idempotency of the request. This lets you safely retry the request without
3180
3456
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -3194,10 +3470,12 @@ export interface SetDefaultPermissionVersionRequest {
3194
3470
  */
3195
3471
  export interface SetDefaultPermissionVersionResponse {
3196
3472
  /**
3473
+ * @public
3197
3474
  * <p>A boolean value that indicates whether the operation was successful.</p>
3198
3475
  */
3199
3476
  returnValue?: boolean;
3200
3477
  /**
3478
+ * @public
3201
3479
  * <p>The idempotency identifier associated with this request. If you
3202
3480
  * want to repeat the same operation in an idempotent manner then you must include this
3203
3481
  * value in the <code>clientToken</code> request parameter of that later call. All other
@@ -3210,17 +3488,20 @@ export interface SetDefaultPermissionVersionResponse {
3210
3488
  */
3211
3489
  export interface TagResourceRequest {
3212
3490
  /**
3491
+ * @public
3213
3492
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share that you want to add tags to. You must specify
3214
3493
  * <i>either</i>
3215
3494
  * <code>resourceShareArn</code>, or <code>resourceArn</code>, but not both.</p>
3216
3495
  */
3217
3496
  resourceShareArn?: string;
3218
3497
  /**
3498
+ * @public
3219
3499
  * <p>A list of one or more tag key and value pairs. The tag key must be present and not be
3220
3500
  * an empty string. The tag value must be present but can be an empty string.</p>
3221
3501
  */
3222
3502
  tags: Tag[] | undefined;
3223
3503
  /**
3504
+ * @public
3224
3505
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the managed permission that you want to add tags to. You must specify
3225
3506
  * <i>either</i>
3226
3507
  * <code>resourceArn</code>, or <code>resourceShareArn</code>, but not both.</p>
@@ -3237,16 +3518,19 @@ export interface TagResourceResponse {
3237
3518
  */
3238
3519
  export interface UntagResourceRequest {
3239
3520
  /**
3521
+ * @public
3240
3522
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share that you want to remove tags from. The tags are
3241
3523
  * removed from the resource share, not the resources in the resource share. You must specify either
3242
3524
  * <code>resourceShareArn</code>, or <code>resourceArn</code>, but not both.</p>
3243
3525
  */
3244
3526
  resourceShareArn?: string;
3245
3527
  /**
3528
+ * @public
3246
3529
  * <p>Specifies a list of one or more tag keys that you want to remove.</p>
3247
3530
  */
3248
3531
  tagKeys: string[] | undefined;
3249
3532
  /**
3533
+ * @public
3250
3534
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the managed permission that you want to remove tags from. You must
3251
3535
  * specify either <code>resourceArn</code>, or <code>resourceShareArn</code>, but not
3252
3536
  * both.</p>
@@ -3263,19 +3547,23 @@ export interface UntagResourceResponse {
3263
3547
  */
3264
3548
  export interface UpdateResourceShareRequest {
3265
3549
  /**
3550
+ * @public
3266
3551
  * <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the resource share that you want to modify.</p>
3267
3552
  */
3268
3553
  resourceShareArn: string | undefined;
3269
3554
  /**
3555
+ * @public
3270
3556
  * <p>If specified, the new name that you want to attach to the resource share.</p>
3271
3557
  */
3272
3558
  name?: string;
3273
3559
  /**
3560
+ * @public
3274
3561
  * <p>Specifies whether principals outside your organization in Organizations can be associated
3275
3562
  * with a resource share.</p>
3276
3563
  */
3277
3564
  allowExternalPrincipals?: boolean;
3278
3565
  /**
3566
+ * @public
3279
3567
  * <p>Specifies a unique, case-sensitive identifier that you provide to
3280
3568
  * ensure the idempotency of the request. This lets you safely retry the request without
3281
3569
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -3295,10 +3583,12 @@ export interface UpdateResourceShareRequest {
3295
3583
  */
3296
3584
  export interface UpdateResourceShareResponse {
3297
3585
  /**
3586
+ * @public
3298
3587
  * <p>Information about the resource share.</p>
3299
3588
  */
3300
3589
  resourceShare?: ResourceShare;
3301
3590
  /**
3591
+ * @public
3302
3592
  * <p>The idempotency identifier associated with this request. If you
3303
3593
  * want to repeat the same operation in an idempotent manner then you must include this
3304
3594
  * value in the <code>clientToken</code> request parameter of that later call. All other