ram.d.ts
43.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class RAM extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: RAM.Types.ClientConfiguration)
config: Config & RAM.Types.ClientConfiguration;
/**
* Accepts an invitation to a resource share from another AWS account.
*/
acceptResourceShareInvitation(params: RAM.Types.AcceptResourceShareInvitationRequest, callback?: (err: AWSError, data: RAM.Types.AcceptResourceShareInvitationResponse) => void): Request<RAM.Types.AcceptResourceShareInvitationResponse, AWSError>;
/**
* Accepts an invitation to a resource share from another AWS account.
*/
acceptResourceShareInvitation(callback?: (err: AWSError, data: RAM.Types.AcceptResourceShareInvitationResponse) => void): Request<RAM.Types.AcceptResourceShareInvitationResponse, AWSError>;
/**
* Associates the specified resource share with the specified principals and resources.
*/
associateResourceShare(params: RAM.Types.AssociateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.AssociateResourceShareResponse) => void): Request<RAM.Types.AssociateResourceShareResponse, AWSError>;
/**
* Associates the specified resource share with the specified principals and resources.
*/
associateResourceShare(callback?: (err: AWSError, data: RAM.Types.AssociateResourceShareResponse) => void): Request<RAM.Types.AssociateResourceShareResponse, AWSError>;
/**
* Associates a permission with a resource share.
*/
associateResourceSharePermission(params: RAM.Types.AssociateResourceSharePermissionRequest, callback?: (err: AWSError, data: RAM.Types.AssociateResourceSharePermissionResponse) => void): Request<RAM.Types.AssociateResourceSharePermissionResponse, AWSError>;
/**
* Associates a permission with a resource share.
*/
associateResourceSharePermission(callback?: (err: AWSError, data: RAM.Types.AssociateResourceSharePermissionResponse) => void): Request<RAM.Types.AssociateResourceSharePermissionResponse, AWSError>;
/**
* Creates a resource share.
*/
createResourceShare(params: RAM.Types.CreateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.CreateResourceShareResponse) => void): Request<RAM.Types.CreateResourceShareResponse, AWSError>;
/**
* Creates a resource share.
*/
createResourceShare(callback?: (err: AWSError, data: RAM.Types.CreateResourceShareResponse) => void): Request<RAM.Types.CreateResourceShareResponse, AWSError>;
/**
* Deletes the specified resource share.
*/
deleteResourceShare(params: RAM.Types.DeleteResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.DeleteResourceShareResponse) => void): Request<RAM.Types.DeleteResourceShareResponse, AWSError>;
/**
* Deletes the specified resource share.
*/
deleteResourceShare(callback?: (err: AWSError, data: RAM.Types.DeleteResourceShareResponse) => void): Request<RAM.Types.DeleteResourceShareResponse, AWSError>;
/**
* Disassociates the specified principals or resources from the specified resource share.
*/
disassociateResourceShare(params: RAM.Types.DisassociateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.DisassociateResourceShareResponse) => void): Request<RAM.Types.DisassociateResourceShareResponse, AWSError>;
/**
* Disassociates the specified principals or resources from the specified resource share.
*/
disassociateResourceShare(callback?: (err: AWSError, data: RAM.Types.DisassociateResourceShareResponse) => void): Request<RAM.Types.DisassociateResourceShareResponse, AWSError>;
/**
* Disassociates an AWS RAM permission from a resource share.
*/
disassociateResourceSharePermission(params: RAM.Types.DisassociateResourceSharePermissionRequest, callback?: (err: AWSError, data: RAM.Types.DisassociateResourceSharePermissionResponse) => void): Request<RAM.Types.DisassociateResourceSharePermissionResponse, AWSError>;
/**
* Disassociates an AWS RAM permission from a resource share.
*/
disassociateResourceSharePermission(callback?: (err: AWSError, data: RAM.Types.DisassociateResourceSharePermissionResponse) => void): Request<RAM.Types.DisassociateResourceSharePermissionResponse, AWSError>;
/**
* Enables resource sharing within your AWS Organization. The caller must be the master account for the AWS Organization.
*/
enableSharingWithAwsOrganization(params: RAM.Types.EnableSharingWithAwsOrganizationRequest, callback?: (err: AWSError, data: RAM.Types.EnableSharingWithAwsOrganizationResponse) => void): Request<RAM.Types.EnableSharingWithAwsOrganizationResponse, AWSError>;
/**
* Enables resource sharing within your AWS Organization. The caller must be the master account for the AWS Organization.
*/
enableSharingWithAwsOrganization(callback?: (err: AWSError, data: RAM.Types.EnableSharingWithAwsOrganizationResponse) => void): Request<RAM.Types.EnableSharingWithAwsOrganizationResponse, AWSError>;
/**
* Gets the contents of an AWS RAM permission in JSON format.
*/
getPermission(params: RAM.Types.GetPermissionRequest, callback?: (err: AWSError, data: RAM.Types.GetPermissionResponse) => void): Request<RAM.Types.GetPermissionResponse, AWSError>;
/**
* Gets the contents of an AWS RAM permission in JSON format.
*/
getPermission(callback?: (err: AWSError, data: RAM.Types.GetPermissionResponse) => void): Request<RAM.Types.GetPermissionResponse, AWSError>;
/**
* Gets the policies for the specified resources that you own and have shared.
*/
getResourcePolicies(params: RAM.Types.GetResourcePoliciesRequest, callback?: (err: AWSError, data: RAM.Types.GetResourcePoliciesResponse) => void): Request<RAM.Types.GetResourcePoliciesResponse, AWSError>;
/**
* Gets the policies for the specified resources that you own and have shared.
*/
getResourcePolicies(callback?: (err: AWSError, data: RAM.Types.GetResourcePoliciesResponse) => void): Request<RAM.Types.GetResourcePoliciesResponse, AWSError>;
/**
* Gets the resources or principals for the resource shares that you own.
*/
getResourceShareAssociations(params: RAM.Types.GetResourceShareAssociationsRequest, callback?: (err: AWSError, data: RAM.Types.GetResourceShareAssociationsResponse) => void): Request<RAM.Types.GetResourceShareAssociationsResponse, AWSError>;
/**
* Gets the resources or principals for the resource shares that you own.
*/
getResourceShareAssociations(callback?: (err: AWSError, data: RAM.Types.GetResourceShareAssociationsResponse) => void): Request<RAM.Types.GetResourceShareAssociationsResponse, AWSError>;
/**
* Gets the invitations for resource sharing that you've received.
*/
getResourceShareInvitations(params: RAM.Types.GetResourceShareInvitationsRequest, callback?: (err: AWSError, data: RAM.Types.GetResourceShareInvitationsResponse) => void): Request<RAM.Types.GetResourceShareInvitationsResponse, AWSError>;
/**
* Gets the invitations for resource sharing that you've received.
*/
getResourceShareInvitations(callback?: (err: AWSError, data: RAM.Types.GetResourceShareInvitationsResponse) => void): Request<RAM.Types.GetResourceShareInvitationsResponse, AWSError>;
/**
* Gets the resource shares that you own or the resource shares that are shared with you.
*/
getResourceShares(params: RAM.Types.GetResourceSharesRequest, callback?: (err: AWSError, data: RAM.Types.GetResourceSharesResponse) => void): Request<RAM.Types.GetResourceSharesResponse, AWSError>;
/**
* Gets the resource shares that you own or the resource shares that are shared with you.
*/
getResourceShares(callback?: (err: AWSError, data: RAM.Types.GetResourceSharesResponse) => void): Request<RAM.Types.GetResourceSharesResponse, AWSError>;
/**
* Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
*/
listPendingInvitationResources(params: RAM.Types.ListPendingInvitationResourcesRequest, callback?: (err: AWSError, data: RAM.Types.ListPendingInvitationResourcesResponse) => void): Request<RAM.Types.ListPendingInvitationResourcesResponse, AWSError>;
/**
* Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
*/
listPendingInvitationResources(callback?: (err: AWSError, data: RAM.Types.ListPendingInvitationResourcesResponse) => void): Request<RAM.Types.ListPendingInvitationResourcesResponse, AWSError>;
/**
* Lists the AWS RAM permissions.
*/
listPermissions(params: RAM.Types.ListPermissionsRequest, callback?: (err: AWSError, data: RAM.Types.ListPermissionsResponse) => void): Request<RAM.Types.ListPermissionsResponse, AWSError>;
/**
* Lists the AWS RAM permissions.
*/
listPermissions(callback?: (err: AWSError, data: RAM.Types.ListPermissionsResponse) => void): Request<RAM.Types.ListPermissionsResponse, AWSError>;
/**
* Lists the principals that you have shared resources with or that have shared resources with you.
*/
listPrincipals(params: RAM.Types.ListPrincipalsRequest, callback?: (err: AWSError, data: RAM.Types.ListPrincipalsResponse) => void): Request<RAM.Types.ListPrincipalsResponse, AWSError>;
/**
* Lists the principals that you have shared resources with or that have shared resources with you.
*/
listPrincipals(callback?: (err: AWSError, data: RAM.Types.ListPrincipalsResponse) => void): Request<RAM.Types.ListPrincipalsResponse, AWSError>;
/**
* Lists the AWS RAM permissions that are associated with a resource share.
*/
listResourceSharePermissions(params: RAM.Types.ListResourceSharePermissionsRequest, callback?: (err: AWSError, data: RAM.Types.ListResourceSharePermissionsResponse) => void): Request<RAM.Types.ListResourceSharePermissionsResponse, AWSError>;
/**
* Lists the AWS RAM permissions that are associated with a resource share.
*/
listResourceSharePermissions(callback?: (err: AWSError, data: RAM.Types.ListResourceSharePermissionsResponse) => void): Request<RAM.Types.ListResourceSharePermissionsResponse, AWSError>;
/**
* Lists the shareable resource types supported by AWS RAM.
*/
listResourceTypes(params: RAM.Types.ListResourceTypesRequest, callback?: (err: AWSError, data: RAM.Types.ListResourceTypesResponse) => void): Request<RAM.Types.ListResourceTypesResponse, AWSError>;
/**
* Lists the shareable resource types supported by AWS RAM.
*/
listResourceTypes(callback?: (err: AWSError, data: RAM.Types.ListResourceTypesResponse) => void): Request<RAM.Types.ListResourceTypesResponse, AWSError>;
/**
* Lists the resources that you added to a resource shares or the resources that are shared with you.
*/
listResources(params: RAM.Types.ListResourcesRequest, callback?: (err: AWSError, data: RAM.Types.ListResourcesResponse) => void): Request<RAM.Types.ListResourcesResponse, AWSError>;
/**
* Lists the resources that you added to a resource shares or the resources that are shared with you.
*/
listResources(callback?: (err: AWSError, data: RAM.Types.ListResourcesResponse) => void): Request<RAM.Types.ListResourcesResponse, AWSError>;
/**
* Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM. Use this API action to promote the resource share. When you promote the resource share, it becomes: Visible to all principals that it is shared with. Modifiable in AWS RAM.
*/
promoteResourceShareCreatedFromPolicy(params: RAM.Types.PromoteResourceShareCreatedFromPolicyRequest, callback?: (err: AWSError, data: RAM.Types.PromoteResourceShareCreatedFromPolicyResponse) => void): Request<RAM.Types.PromoteResourceShareCreatedFromPolicyResponse, AWSError>;
/**
* Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM. Use this API action to promote the resource share. When you promote the resource share, it becomes: Visible to all principals that it is shared with. Modifiable in AWS RAM.
*/
promoteResourceShareCreatedFromPolicy(callback?: (err: AWSError, data: RAM.Types.PromoteResourceShareCreatedFromPolicyResponse) => void): Request<RAM.Types.PromoteResourceShareCreatedFromPolicyResponse, AWSError>;
/**
* Rejects an invitation to a resource share from another AWS account.
*/
rejectResourceShareInvitation(params: RAM.Types.RejectResourceShareInvitationRequest, callback?: (err: AWSError, data: RAM.Types.RejectResourceShareInvitationResponse) => void): Request<RAM.Types.RejectResourceShareInvitationResponse, AWSError>;
/**
* Rejects an invitation to a resource share from another AWS account.
*/
rejectResourceShareInvitation(callback?: (err: AWSError, data: RAM.Types.RejectResourceShareInvitationResponse) => void): Request<RAM.Types.RejectResourceShareInvitationResponse, AWSError>;
/**
* Adds the specified tags to the specified resource share that you own.
*/
tagResource(params: RAM.Types.TagResourceRequest, callback?: (err: AWSError, data: RAM.Types.TagResourceResponse) => void): Request<RAM.Types.TagResourceResponse, AWSError>;
/**
* Adds the specified tags to the specified resource share that you own.
*/
tagResource(callback?: (err: AWSError, data: RAM.Types.TagResourceResponse) => void): Request<RAM.Types.TagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource share that you own.
*/
untagResource(params: RAM.Types.UntagResourceRequest, callback?: (err: AWSError, data: RAM.Types.UntagResourceResponse) => void): Request<RAM.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from the specified resource share that you own.
*/
untagResource(callback?: (err: AWSError, data: RAM.Types.UntagResourceResponse) => void): Request<RAM.Types.UntagResourceResponse, AWSError>;
/**
* Updates the specified resource share that you own.
*/
updateResourceShare(params: RAM.Types.UpdateResourceShareRequest, callback?: (err: AWSError, data: RAM.Types.UpdateResourceShareResponse) => void): Request<RAM.Types.UpdateResourceShareResponse, AWSError>;
/**
* Updates the specified resource share that you own.
*/
updateResourceShare(callback?: (err: AWSError, data: RAM.Types.UpdateResourceShareResponse) => void): Request<RAM.Types.UpdateResourceShareResponse, AWSError>;
}
declare namespace RAM {
export interface AcceptResourceShareInvitationRequest {
/**
* The Amazon Resource Name (ARN) of the invitation.
*/
resourceShareInvitationArn: String;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface AcceptResourceShareInvitationResponse {
/**
* Information about the invitation.
*/
resourceShareInvitation?: ResourceShareInvitation;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface AssociateResourceSharePermissionRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* The ARN of the AWS RAM permission to associate with the resource share.
*/
permissionArn: String;
/**
* Indicates whether the permission should replace the permissions that are currently associated with the resource share. Use true to replace the current permissions. Use false to add the permission to the current permission.
*/
replace?: Boolean;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface AssociateResourceSharePermissionResponse {
/**
* Indicates whether the request succeeded.
*/
returnValue?: Boolean;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface AssociateResourceShareRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* The Amazon Resource Names (ARN) of the resources.
*/
resourceArns?: ResourceArnList;
/**
* The principals.
*/
principals?: PrincipalArnOrIdList;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface AssociateResourceShareResponse {
/**
* Information about the associations.
*/
resourceShareAssociations?: ResourceShareAssociationList;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export type Boolean = boolean;
export interface CreateResourceShareRequest {
/**
* The name of the resource share.
*/
name: String;
/**
* The Amazon Resource Names (ARN) of the resources to associate with the resource share.
*/
resourceArns?: ResourceArnList;
/**
* The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.
*/
principals?: PrincipalArnOrIdList;
/**
* One or more tags.
*/
tags?: TagList;
/**
* Indicates whether principals outside your AWS organization can be associated with a resource share.
*/
allowExternalPrincipals?: Boolean;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
/**
* The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type.
*/
permissionArns?: PermissionArnList;
}
export interface CreateResourceShareResponse {
/**
* Information about the resource share.
*/
resourceShare?: ResourceShare;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export type DateTime = Date;
export interface DeleteResourceShareRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface DeleteResourceShareResponse {
/**
* Indicates whether the request succeeded.
*/
returnValue?: Boolean;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface DisassociateResourceSharePermissionRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* The ARN of the permission to disassociate from the resource share.
*/
permissionArn: String;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface DisassociateResourceSharePermissionResponse {
/**
* Indicates whether the request succeeded.
*/
returnValue?: Boolean;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface DisassociateResourceShareRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* The Amazon Resource Names (ARNs) of the resources.
*/
resourceArns?: ResourceArnList;
/**
* The principals.
*/
principals?: PrincipalArnOrIdList;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface DisassociateResourceShareResponse {
/**
* Information about the associations.
*/
resourceShareAssociations?: ResourceShareAssociationList;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface EnableSharingWithAwsOrganizationRequest {
}
export interface EnableSharingWithAwsOrganizationResponse {
/**
* Indicates whether the request succeeded.
*/
returnValue?: Boolean;
}
export interface GetPermissionRequest {
/**
* The ARN of the permission.
*/
permissionArn: String;
/**
* The identifier for the version of the permission.
*/
permissionVersion?: Integer;
}
export interface GetPermissionResponse {
/**
* Information about the permission.
*/
permission?: ResourceSharePermissionDetail;
}
export interface GetResourcePoliciesRequest {
/**
* The Amazon Resource Names (ARN) of the resources.
*/
resourceArns: ResourceArnList;
/**
* The principal.
*/
principal?: String;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface GetResourcePoliciesResponse {
/**
* A key policy document, in JSON format.
*/
policies?: PolicyList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface GetResourceShareAssociationsRequest {
/**
* The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.
*/
associationType: ResourceShareAssociationType;
/**
* The Amazon Resource Names (ARN) of the resource shares.
*/
resourceShareArns?: ResourceShareArnList;
/**
* The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL.
*/
resourceArn?: String;
/**
* The principal. You cannot specify this parameter if the association type is RESOURCE.
*/
principal?: String;
/**
* The association status.
*/
associationStatus?: ResourceShareAssociationStatus;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface GetResourceShareAssociationsResponse {
/**
* Information about the associations.
*/
resourceShareAssociations?: ResourceShareAssociationList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface GetResourceShareInvitationsRequest {
/**
* The Amazon Resource Names (ARN) of the invitations.
*/
resourceShareInvitationArns?: ResourceShareInvitationArnList;
/**
* The Amazon Resource Names (ARN) of the resource shares.
*/
resourceShareArns?: ResourceShareArnList;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface GetResourceShareInvitationsResponse {
/**
* Information about the invitations.
*/
resourceShareInvitations?: ResourceShareInvitationList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface GetResourceSharesRequest {
/**
* The Amazon Resource Names (ARN) of the resource shares.
*/
resourceShareArns?: ResourceShareArnList;
/**
* The status of the resource share.
*/
resourceShareStatus?: ResourceShareStatus;
/**
* The type of owner.
*/
resourceOwner: ResourceOwner;
/**
* The name of the resource share.
*/
name?: String;
/**
* One or more tag filters.
*/
tagFilters?: TagFilters;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface GetResourceSharesResponse {
/**
* Information about the resource shares.
*/
resourceShares?: ResourceShareList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export type Integer = number;
export interface ListPendingInvitationResourcesRequest {
/**
* The Amazon Resource Name (ARN) of the invitation.
*/
resourceShareInvitationArn: String;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface ListPendingInvitationResourcesResponse {
/**
* Information about the resources included the resource share.
*/
resources?: ResourceList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface ListPermissionsRequest {
/**
* Specifies the resource type for which to list permissions. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet.
*/
resourceType?: String;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface ListPermissionsResponse {
/**
* Information about the permissions.
*/
permissions?: ResourceSharePermissionList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface ListPrincipalsRequest {
/**
* The type of owner.
*/
resourceOwner: ResourceOwner;
/**
* The Amazon Resource Name (ARN) of the resource.
*/
resourceArn?: String;
/**
* The principals.
*/
principals?: PrincipalArnOrIdList;
/**
* The resource type. Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule
*/
resourceType?: String;
/**
* The Amazon Resource Names (ARN) of the resource shares.
*/
resourceShareArns?: ResourceShareArnList;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface ListPrincipalsResponse {
/**
* The principals.
*/
principals?: PrincipalList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface ListResourceSharePermissionsRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface ListResourceSharePermissionsResponse {
/**
* The permissions associated with the resource share.
*/
permissions?: ResourceSharePermissionList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface ListResourceTypesRequest {
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface ListResourceTypesResponse {
/**
* The shareable resource types supported by AWS RAM.
*/
resourceTypes?: ServiceNameAndResourceTypeList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export interface ListResourcesRequest {
/**
* The type of owner.
*/
resourceOwner: ResourceOwner;
/**
* The principal.
*/
principal?: String;
/**
* The resource type. Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule
*/
resourceType?: String;
/**
* The Amazon Resource Names (ARN) of the resources.
*/
resourceArns?: ResourceArnList;
/**
* The Amazon Resource Names (ARN) of the resource shares.
*/
resourceShareArns?: ResourceShareArnList;
/**
* The token for the next page of results.
*/
nextToken?: String;
/**
* The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
maxResults?: MaxResults;
}
export interface ListResourcesResponse {
/**
* Information about the resources.
*/
resources?: ResourceList;
/**
* The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: String;
}
export type MaxResults = number;
export type PermissionArnList = String[];
export type Policy = string;
export type PolicyList = Policy[];
export interface Principal {
/**
* The ID of the principal.
*/
id?: String;
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn?: String;
/**
* The time when the principal was associated with the resource share.
*/
creationTime?: DateTime;
/**
* The time when the association was last updated.
*/
lastUpdatedTime?: DateTime;
/**
* Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.
*/
external?: Boolean;
}
export type PrincipalArnOrIdList = String[];
export type PrincipalList = Principal[];
export interface PromoteResourceShareCreatedFromPolicyRequest {
/**
* The ARN of the resource share to promote.
*/
resourceShareArn: String;
}
export interface PromoteResourceShareCreatedFromPolicyResponse {
/**
* Indicates whether the request succeeded.
*/
returnValue?: Boolean;
}
export interface RejectResourceShareInvitationRequest {
/**
* The Amazon Resource Name (ARN) of the invitation.
*/
resourceShareInvitationArn: String;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface RejectResourceShareInvitationResponse {
/**
* Information about the invitation.
*/
resourceShareInvitation?: ResourceShareInvitation;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface Resource {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
arn?: String;
/**
* The resource type.
*/
type?: String;
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn?: String;
/**
* The ARN of the resource group. This value is returned only if the resource is a resource group.
*/
resourceGroupArn?: String;
/**
* The status of the resource.
*/
status?: ResourceStatus;
/**
* A message about the status of the resource.
*/
statusMessage?: String;
/**
* The time when the resource was associated with the resource share.
*/
creationTime?: DateTime;
/**
* The time when the association was last updated.
*/
lastUpdatedTime?: DateTime;
}
export type ResourceArnList = String[];
export type ResourceList = Resource[];
export type ResourceOwner = "SELF"|"OTHER-ACCOUNTS"|string;
export interface ResourceShare {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn?: String;
/**
* The name of the resource share.
*/
name?: String;
/**
* The ID of the AWS account that owns the resource share.
*/
owningAccountId?: String;
/**
* Indicates whether principals outside your AWS organization can be associated with a resource share.
*/
allowExternalPrincipals?: Boolean;
/**
* The status of the resource share.
*/
status?: ResourceShareStatus;
/**
* A message about the status of the resource share.
*/
statusMessage?: String;
/**
* The tags for the resource share.
*/
tags?: TagList;
/**
* The time when the resource share was created.
*/
creationTime?: DateTime;
/**
* The time when the resource share was last updated.
*/
lastUpdatedTime?: DateTime;
/**
* Indicates how the resource share was created. Possible values include: CREATED_FROM_POLICY - Indicates that the resource share was created from an AWS Identity and Access Management (AWS IAM) policy attached to a resource. These resource shares are visible only to the AWS account that created it. They cannot be modified in AWS RAM. PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy. STANDARD - Indicates that the resource share was created in AWS RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in AWS RAM.
*/
featureSet?: ResourceShareFeatureSet;
}
export type ResourceShareArnList = String[];
export interface ResourceShareAssociation {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn?: String;
/**
* The name of the resource share.
*/
resourceShareName?: String;
/**
* The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.
*/
associatedEntity?: String;
/**
* The association type.
*/
associationType?: ResourceShareAssociationType;
/**
* The status of the association.
*/
status?: ResourceShareAssociationStatus;
/**
* A message about the status of the association.
*/
statusMessage?: String;
/**
* The time when the association was created.
*/
creationTime?: DateTime;
/**
* The time when the association was last updated.
*/
lastUpdatedTime?: DateTime;
/**
* Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.
*/
external?: Boolean;
}
export type ResourceShareAssociationList = ResourceShareAssociation[];
export type ResourceShareAssociationStatus = "ASSOCIATING"|"ASSOCIATED"|"FAILED"|"DISASSOCIATING"|"DISASSOCIATED"|string;
export type ResourceShareAssociationType = "PRINCIPAL"|"RESOURCE"|string;
export type ResourceShareFeatureSet = "CREATED_FROM_POLICY"|"PROMOTING_TO_STANDARD"|"STANDARD"|string;
export interface ResourceShareInvitation {
/**
* The Amazon Resource Name (ARN) of the invitation.
*/
resourceShareInvitationArn?: String;
/**
* The name of the resource share.
*/
resourceShareName?: String;
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn?: String;
/**
* The ID of the AWS account that sent the invitation.
*/
senderAccountId?: String;
/**
* The ID of the AWS account that received the invitation.
*/
receiverAccountId?: String;
/**
* The date and time when the invitation was sent.
*/
invitationTimestamp?: DateTime;
/**
* The status of the invitation.
*/
status?: ResourceShareInvitationStatus;
/**
* To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
*/
resourceShareAssociations?: ResourceShareAssociationList;
}
export type ResourceShareInvitationArnList = String[];
export type ResourceShareInvitationList = ResourceShareInvitation[];
export type ResourceShareInvitationStatus = "PENDING"|"ACCEPTED"|"REJECTED"|"EXPIRED"|string;
export type ResourceShareList = ResourceShare[];
export interface ResourceSharePermissionDetail {
/**
* The ARN of the permission.
*/
arn?: String;
/**
* The identifier for the version of the permission.
*/
version?: String;
/**
* The identifier for the version of the permission that is set as the default version.
*/
defaultVersion?: Boolean;
/**
* The name of the permission.
*/
name?: String;
/**
* The resource type to which the permission applies.
*/
resourceType?: String;
/**
* The permission's effect and actions in JSON format. The effect indicates whether the actions are allowed or denied. The actions list the API actions to which the principal is granted or denied access.
*/
permission?: String;
/**
* The date and time when the permission was created.
*/
creationTime?: DateTime;
/**
* The date and time when the permission was last updated.
*/
lastUpdatedTime?: DateTime;
}
export type ResourceSharePermissionList = ResourceSharePermissionSummary[];
export interface ResourceSharePermissionSummary {
/**
* The ARN of the permission.
*/
arn?: String;
/**
* The identifier for the version of the permission.
*/
version?: String;
/**
* The identifier for the version of the permission that is set as the default version.
*/
defaultVersion?: Boolean;
/**
* The name of the permission.
*/
name?: String;
/**
* The type of resource to which the permission applies.
*/
resourceType?: String;
/**
* The current status of the permission.
*/
status?: String;
/**
* The date and time when the permission was created.
*/
creationTime?: DateTime;
/**
* The date and time when the permission was last updated.
*/
lastUpdatedTime?: DateTime;
}
export type ResourceShareStatus = "PENDING"|"ACTIVE"|"FAILED"|"DELETING"|"DELETED"|string;
export type ResourceStatus = "AVAILABLE"|"ZONAL_RESOURCE_INACCESSIBLE"|"LIMIT_EXCEEDED"|"UNAVAILABLE"|"PENDING"|string;
export interface ServiceNameAndResourceType {
/**
* The shareable resource types.
*/
resourceType?: String;
/**
* The name of the AWS services to which the resources belong.
*/
serviceName?: String;
}
export type ServiceNameAndResourceTypeList = ServiceNameAndResourceType[];
export type String = string;
export interface Tag {
/**
* The key of the tag.
*/
key?: TagKey;
/**
* The value of the tag.
*/
value?: TagValue;
}
export interface TagFilter {
/**
* The tag key.
*/
tagKey?: TagKey;
/**
* The tag values.
*/
tagValues?: TagValueList;
}
export type TagFilters = TagFilter[];
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* One or more tags.
*/
tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type TagValueList = TagValue[];
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* The tag keys of the tags to remove.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateResourceShareRequest {
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
resourceShareArn: String;
/**
* The name of the resource share.
*/
name?: String;
/**
* Indicates whether principals outside your AWS organization can be associated with a resource share.
*/
allowExternalPrincipals?: Boolean;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
export interface UpdateResourceShareResponse {
/**
* Information about the resource share.
*/
resourceShare?: ResourceShare;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
clientToken?: String;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-01-04"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the RAM client.
*/
export import Types = RAM;
}
export = RAM;