ssoadmin.d.ts
49.8 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
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 SSOAdmin extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: SSOAdmin.Types.ClientConfiguration)
config: Config & SSOAdmin.Types.ClientConfiguration;
/**
* Attaches an IAM managed policy ARN to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.
*/
attachManagedPolicyToPermissionSet(params: SSOAdmin.Types.AttachManagedPolicyToPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse, AWSError>;
/**
* Attaches an IAM managed policy ARN to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.
*/
attachManagedPolicyToPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.AttachManagedPolicyToPermissionSetResponse, AWSError>;
/**
* Assigns access to a principal for a specified AWS account using a specified permission set. The term principal here refers to a user or group that is defined in AWS SSO. As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy attached to the SSO-created IAM role. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you will need to call ProvisionPermissionSet to make these updates.
*/
createAccountAssignment(params: SSOAdmin.Types.CreateAccountAssignmentRequest, callback?: (err: AWSError, data: SSOAdmin.Types.CreateAccountAssignmentResponse) => void): Request<SSOAdmin.Types.CreateAccountAssignmentResponse, AWSError>;
/**
* Assigns access to a principal for a specified AWS account using a specified permission set. The term principal here refers to a user or group that is defined in AWS SSO. As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy attached to the SSO-created IAM role. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you will need to call ProvisionPermissionSet to make these updates.
*/
createAccountAssignment(callback?: (err: AWSError, data: SSOAdmin.Types.CreateAccountAssignmentResponse) => void): Request<SSOAdmin.Types.CreateAccountAssignmentResponse, AWSError>;
/**
* Creates a permission set within a specified SSO instance. To grant users and groups access to AWS account resources, use CreateAccountAssignment .
*/
createPermissionSet(params: SSOAdmin.Types.CreatePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.CreatePermissionSetResponse) => void): Request<SSOAdmin.Types.CreatePermissionSetResponse, AWSError>;
/**
* Creates a permission set within a specified SSO instance. To grant users and groups access to AWS account resources, use CreateAccountAssignment .
*/
createPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.CreatePermissionSetResponse) => void): Request<SSOAdmin.Types.CreatePermissionSetResponse, AWSError>;
/**
* Deletes a principal's access from a specified AWS account using a specified permission set.
*/
deleteAccountAssignment(params: SSOAdmin.Types.DeleteAccountAssignmentRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DeleteAccountAssignmentResponse) => void): Request<SSOAdmin.Types.DeleteAccountAssignmentResponse, AWSError>;
/**
* Deletes a principal's access from a specified AWS account using a specified permission set.
*/
deleteAccountAssignment(callback?: (err: AWSError, data: SSOAdmin.Types.DeleteAccountAssignmentResponse) => void): Request<SSOAdmin.Types.DeleteAccountAssignmentResponse, AWSError>;
/**
* Deletes the inline policy from a specified permission set.
*/
deleteInlinePolicyFromPermissionSet(params: SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse, AWSError>;
/**
* Deletes the inline policy from a specified permission set.
*/
deleteInlinePolicyFromPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DeleteInlinePolicyFromPermissionSetResponse, AWSError>;
/**
* Deletes the specified permission set.
*/
deletePermissionSet(params: SSOAdmin.Types.DeletePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DeletePermissionSetResponse) => void): Request<SSOAdmin.Types.DeletePermissionSetResponse, AWSError>;
/**
* Deletes the specified permission set.
*/
deletePermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DeletePermissionSetResponse) => void): Request<SSOAdmin.Types.DeletePermissionSetResponse, AWSError>;
/**
* Describes the status of the assignment creation request.
*/
describeAccountAssignmentCreationStatus(params: SSOAdmin.Types.DescribeAccountAssignmentCreationStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Describes the status of the assignment creation request.
*/
describeAccountAssignmentCreationStatus(callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Describes the status of the assignment deletion request.
*/
describeAccountAssignmentDeletionStatus(params: SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Describes the status of the assignment deletion request.
*/
describeAccountAssignmentDeletionStatus(callback?: (err: AWSError, data: SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.DescribeAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Gets the details of the permission set.
*/
describePermissionSet(params: SSOAdmin.Types.DescribePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetResponse, AWSError>;
/**
* Gets the details of the permission set.
*/
describePermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetResponse, AWSError>;
/**
* Describes the status for the given permission set provisioning request.
*/
describePermissionSetProvisioningStatus(params: SSOAdmin.Types.DescribePermissionSetProvisioningStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse, AWSError>;
/**
* Describes the status for the given permission set provisioning request.
*/
describePermissionSetProvisioningStatus(callback?: (err: AWSError, data: SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.DescribePermissionSetProvisioningStatusResponse, AWSError>;
/**
* Detaches the attached IAM managed policy ARN from the specified permission set.
*/
detachManagedPolicyFromPermissionSet(params: SSOAdmin.Types.DetachManagedPolicyFromPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse, AWSError>;
/**
* Detaches the attached IAM managed policy ARN from the specified permission set.
*/
detachManagedPolicyFromPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse) => void): Request<SSOAdmin.Types.DetachManagedPolicyFromPermissionSetResponse, AWSError>;
/**
* Obtains the inline policy assigned to the permission set.
*/
getInlinePolicyForPermissionSet(params: SSOAdmin.Types.GetInlinePolicyForPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse) => void): Request<SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse, AWSError>;
/**
* Obtains the inline policy assigned to the permission set.
*/
getInlinePolicyForPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse) => void): Request<SSOAdmin.Types.GetInlinePolicyForPermissionSetResponse, AWSError>;
/**
* Lists the status of the AWS account assignment creation requests for a specified SSO instance.
*/
listAccountAssignmentCreationStatus(params: SSOAdmin.Types.ListAccountAssignmentCreationStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Lists the status of the AWS account assignment creation requests for a specified SSO instance.
*/
listAccountAssignmentCreationStatus(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentCreationStatusResponse, AWSError>;
/**
* Lists the status of the AWS account assignment deletion requests for a specified SSO instance.
*/
listAccountAssignmentDeletionStatus(params: SSOAdmin.Types.ListAccountAssignmentDeletionStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Lists the status of the AWS account assignment deletion requests for a specified SSO instance.
*/
listAccountAssignmentDeletionStatus(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentDeletionStatusResponse, AWSError>;
/**
* Lists the assignee of the specified AWS account with the specified permission set.
*/
listAccountAssignments(params: SSOAdmin.Types.ListAccountAssignmentsRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentsResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentsResponse, AWSError>;
/**
* Lists the assignee of the specified AWS account with the specified permission set.
*/
listAccountAssignments(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountAssignmentsResponse) => void): Request<SSOAdmin.Types.ListAccountAssignmentsResponse, AWSError>;
/**
* Lists all the AWS accounts where the specified permission set is provisioned.
*/
listAccountsForProvisionedPermissionSet(params: SSOAdmin.Types.ListAccountsForProvisionedPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse) => void): Request<SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse, AWSError>;
/**
* Lists all the AWS accounts where the specified permission set is provisioned.
*/
listAccountsForProvisionedPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse) => void): Request<SSOAdmin.Types.ListAccountsForProvisionedPermissionSetResponse, AWSError>;
/**
* Lists the SSO instances that the caller has access to.
*/
listInstances(params: SSOAdmin.Types.ListInstancesRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListInstancesResponse) => void): Request<SSOAdmin.Types.ListInstancesResponse, AWSError>;
/**
* Lists the SSO instances that the caller has access to.
*/
listInstances(callback?: (err: AWSError, data: SSOAdmin.Types.ListInstancesResponse) => void): Request<SSOAdmin.Types.ListInstancesResponse, AWSError>;
/**
* Lists the IAM managed policy that is attached to a specified permission set.
*/
listManagedPoliciesInPermissionSet(params: SSOAdmin.Types.ListManagedPoliciesInPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse) => void): Request<SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse, AWSError>;
/**
* Lists the IAM managed policy that is attached to a specified permission set.
*/
listManagedPoliciesInPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse) => void): Request<SSOAdmin.Types.ListManagedPoliciesInPermissionSetResponse, AWSError>;
/**
* Lists the status of the permission set provisioning requests for a specified SSO instance.
*/
listPermissionSetProvisioningStatus(params: SSOAdmin.Types.ListPermissionSetProvisioningStatusRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse, AWSError>;
/**
* Lists the status of the permission set provisioning requests for a specified SSO instance.
*/
listPermissionSetProvisioningStatus(callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse) => void): Request<SSOAdmin.Types.ListPermissionSetProvisioningStatusResponse, AWSError>;
/**
* Lists the PermissionSets in an SSO instance.
*/
listPermissionSets(params: SSOAdmin.Types.ListPermissionSetsRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsResponse, AWSError>;
/**
* Lists the PermissionSets in an SSO instance.
*/
listPermissionSets(callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsResponse, AWSError>;
/**
* Lists all the permission sets that are provisioned to a specified AWS account.
*/
listPermissionSetsProvisionedToAccount(params: SSOAdmin.Types.ListPermissionSetsProvisionedToAccountRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse, AWSError>;
/**
* Lists all the permission sets that are provisioned to a specified AWS account.
*/
listPermissionSetsProvisionedToAccount(callback?: (err: AWSError, data: SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse) => void): Request<SSOAdmin.Types.ListPermissionSetsProvisionedToAccountResponse, AWSError>;
/**
* Lists the tags that are attached to a specified resource.
*/
listTagsForResource(params: SSOAdmin.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ListTagsForResourceResponse) => void): Request<SSOAdmin.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags that are attached to a specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: SSOAdmin.Types.ListTagsForResourceResponse) => void): Request<SSOAdmin.Types.ListTagsForResourceResponse, AWSError>;
/**
* The process by which a specified permission set is provisioned to the specified target.
*/
provisionPermissionSet(params: SSOAdmin.Types.ProvisionPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.ProvisionPermissionSetResponse) => void): Request<SSOAdmin.Types.ProvisionPermissionSetResponse, AWSError>;
/**
* The process by which a specified permission set is provisioned to the specified target.
*/
provisionPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.ProvisionPermissionSetResponse) => void): Request<SSOAdmin.Types.ProvisionPermissionSetResponse, AWSError>;
/**
* Attaches an IAM inline policy to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.
*/
putInlinePolicyToPermissionSet(params: SSOAdmin.Types.PutInlinePolicyToPermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse, AWSError>;
/**
* Attaches an IAM inline policy to a permission set. If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.
*/
putInlinePolicyToPermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse) => void): Request<SSOAdmin.Types.PutInlinePolicyToPermissionSetResponse, AWSError>;
/**
* Associates a set of tags with a specified resource.
*/
tagResource(params: SSOAdmin.Types.TagResourceRequest, callback?: (err: AWSError, data: SSOAdmin.Types.TagResourceResponse) => void): Request<SSOAdmin.Types.TagResourceResponse, AWSError>;
/**
* Associates a set of tags with a specified resource.
*/
tagResource(callback?: (err: AWSError, data: SSOAdmin.Types.TagResourceResponse) => void): Request<SSOAdmin.Types.TagResourceResponse, AWSError>;
/**
* Disassociates a set of tags from a specified resource.
*/
untagResource(params: SSOAdmin.Types.UntagResourceRequest, callback?: (err: AWSError, data: SSOAdmin.Types.UntagResourceResponse) => void): Request<SSOAdmin.Types.UntagResourceResponse, AWSError>;
/**
* Disassociates a set of tags from a specified resource.
*/
untagResource(callback?: (err: AWSError, data: SSOAdmin.Types.UntagResourceResponse) => void): Request<SSOAdmin.Types.UntagResourceResponse, AWSError>;
/**
* Updates an existing permission set.
*/
updatePermissionSet(params: SSOAdmin.Types.UpdatePermissionSetRequest, callback?: (err: AWSError, data: SSOAdmin.Types.UpdatePermissionSetResponse) => void): Request<SSOAdmin.Types.UpdatePermissionSetResponse, AWSError>;
/**
* Updates an existing permission set.
*/
updatePermissionSet(callback?: (err: AWSError, data: SSOAdmin.Types.UpdatePermissionSetResponse) => void): Request<SSOAdmin.Types.UpdatePermissionSetResponse, AWSError>;
}
declare namespace SSOAdmin {
export interface AccountAssignment {
/**
* The identifier of the AWS account.
*/
AccountId?: AccountId;
/**
* The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
PermissionSetArn?: PermissionSetArn;
/**
* The entity type for which the assignment will be created.
*/
PrincipalType?: PrincipalType;
/**
* An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.
*/
PrincipalId?: PrincipalId;
}
export type AccountAssignmentList = AccountAssignment[];
export interface AccountAssignmentOperationStatus {
/**
* The status of the permission set provisioning process.
*/
Status?: StatusValues;
/**
* The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
*/
RequestId?: UUId;
/**
* The message that contains an error or exception in case of an operation failure.
*/
FailureReason?: Reason;
/**
* TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
*/
TargetId?: TargetId;
/**
* The entity type for which the assignment will be created.
*/
TargetType?: TargetType;
/**
* The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
PermissionSetArn?: PermissionSetArn;
/**
* The entity type for which the assignment will be created.
*/
PrincipalType?: PrincipalType;
/**
* An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.
*/
PrincipalId?: PrincipalId;
/**
* The date that the permission set was created.
*/
CreatedDate?: _Date;
}
export type AccountAssignmentOperationStatusList = AccountAssignmentOperationStatusMetadata[];
export interface AccountAssignmentOperationStatusMetadata {
/**
* The status of the permission set provisioning process.
*/
Status?: StatusValues;
/**
* The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
*/
RequestId?: UUId;
/**
* The date that the permission set was created.
*/
CreatedDate?: _Date;
}
export type AccountId = string;
export type AccountList = AccountId[];
export interface AttachManagedPolicyToPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet that the managed policy should be attached to.
*/
PermissionSetArn: PermissionSetArn;
/**
* The IAM managed policy ARN to be attached to a permission set.
*/
ManagedPolicyArn: ManagedPolicyArn;
}
export interface AttachManagedPolicyToPermissionSetResponse {
}
export interface AttachedManagedPolicy {
/**
* The name of the IAM managed policy.
*/
Name?: Name;
/**
* The ARN of the IAM managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
Arn?: ManagedPolicyArn;
}
export type AttachedManagedPolicyList = AttachedManagedPolicy[];
export interface CreateAccountAssignmentRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
*/
TargetId: TargetId;
/**
* The entity type for which the assignment will be created.
*/
TargetType: TargetType;
/**
* The ARN of the permission set that the admin wants to grant the principal access to.
*/
PermissionSetArn: PermissionSetArn;
/**
* The entity type for which the assignment will be created.
*/
PrincipalType: PrincipalType;
/**
* An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.
*/
PrincipalId: PrincipalId;
}
export interface CreateAccountAssignmentResponse {
/**
* The status object for the account assignment creation operation.
*/
AccountAssignmentCreationStatus?: AccountAssignmentOperationStatus;
}
export interface CreatePermissionSetRequest {
/**
* The name of the PermissionSet.
*/
Name: PermissionSetName;
/**
* The description of the PermissionSet.
*/
Description?: PermissionSetDescription;
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The length of time that the application user sessions are valid in the ISO-8601 standard.
*/
SessionDuration?: Duration;
/**
* Used to redirect users within the application during the federation authentication process.
*/
RelayState?: RelayState;
/**
* The tags to attach to the new PermissionSet.
*/
Tags?: TagList;
}
export interface CreatePermissionSetResponse {
/**
* Defines the level of access on an AWS account.
*/
PermissionSet?: PermissionSet;
}
export type _Date = Date;
export interface DeleteAccountAssignmentRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
*/
TargetId: TargetId;
/**
* The entity type for which the assignment will be deleted.
*/
TargetType: TargetType;
/**
* The ARN of the permission set that will be used to remove access.
*/
PermissionSetArn: PermissionSetArn;
/**
* The entity type for which the assignment will be deleted.
*/
PrincipalType: PrincipalType;
/**
* An identifier for an object in AWS SSO, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO, see the AWS SSO Identity Store API Reference.
*/
PrincipalId: PrincipalId;
}
export interface DeleteAccountAssignmentResponse {
/**
* The status object for the account assignment deletion operation.
*/
AccountAssignmentDeletionStatus?: AccountAssignmentOperationStatus;
}
export interface DeleteInlinePolicyFromPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set that will be used to remove access.
*/
PermissionSetArn: PermissionSetArn;
}
export interface DeleteInlinePolicyFromPermissionSetResponse {
}
export interface DeletePermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set that should be deleted.
*/
PermissionSetArn: PermissionSetArn;
}
export interface DeletePermissionSetResponse {
}
export interface DescribeAccountAssignmentCreationStatusRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The identifier that is used to track the request operation progress.
*/
AccountAssignmentCreationRequestId: UUId;
}
export interface DescribeAccountAssignmentCreationStatusResponse {
/**
* The status object for the account assignment creation operation.
*/
AccountAssignmentCreationStatus?: AccountAssignmentOperationStatus;
}
export interface DescribeAccountAssignmentDeletionStatusRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The identifier that is used to track the request operation progress.
*/
AccountAssignmentDeletionRequestId: UUId;
}
export interface DescribeAccountAssignmentDeletionStatusResponse {
/**
* The status object for the account assignment deletion operation.
*/
AccountAssignmentDeletionStatus?: AccountAssignmentOperationStatus;
}
export interface DescribePermissionSetProvisioningStatusRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.
*/
ProvisionPermissionSetRequestId: UUId;
}
export interface DescribePermissionSetProvisioningStatusResponse {
/**
* The status object for the permission set provisioning operation.
*/
PermissionSetProvisioningStatus?: PermissionSetProvisioningStatus;
}
export interface DescribePermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set.
*/
PermissionSetArn: PermissionSetArn;
}
export interface DescribePermissionSetResponse {
/**
* Describes the level of access on an AWS account.
*/
PermissionSet?: PermissionSet;
}
export interface DetachManagedPolicyFromPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet from which the policy should be detached.
*/
PermissionSetArn: PermissionSetArn;
/**
* The IAM managed policy ARN to be attached to a permission set.
*/
ManagedPolicyArn: ManagedPolicyArn;
}
export interface DetachManagedPolicyFromPermissionSetResponse {
}
export type Duration = string;
export type GeneralArn = string;
export interface GetInlinePolicyForPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set.
*/
PermissionSetArn: PermissionSetArn;
}
export interface GetInlinePolicyForPermissionSetResponse {
/**
* The IAM inline policy that is attached to the permission set.
*/
InlinePolicy?: PermissionSetPolicyDocument;
}
export type Id = string;
export type InstanceArn = string;
export type InstanceList = InstanceMetadata[];
export interface InstanceMetadata {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn?: InstanceArn;
/**
* The identifier of the identity store that is connected to the SSO instance.
*/
IdentityStoreId?: Id;
}
export interface ListAccountAssignmentCreationStatusRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
/**
* Filters results based on the passed attribute value.
*/
Filter?: OperationStatusFilter;
}
export interface ListAccountAssignmentCreationStatusResponse {
/**
* The status object for the account assignment creation operation.
*/
AccountAssignmentsCreationStatus?: AccountAssignmentOperationStatusList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountAssignmentDeletionStatusRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
/**
* Filters results based on the passed attribute value.
*/
Filter?: OperationStatusFilter;
}
export interface ListAccountAssignmentDeletionStatusResponse {
/**
* The status object for the account assignment deletion operation.
*/
AccountAssignmentsDeletionStatus?: AccountAssignmentOperationStatusList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountAssignmentsRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The identifier of the AWS account from which to list the assignments.
*/
AccountId: TargetId;
/**
* The ARN of the permission set from which to list assignments.
*/
PermissionSetArn: PermissionSetArn;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountAssignmentsResponse {
/**
* The list of assignments that match the input AWS account and permission set.
*/
AccountAssignments?: AccountAssignmentList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountsForProvisionedPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet from which the associated AWS accounts will be listed.
*/
PermissionSetArn: PermissionSetArn;
/**
* The permission set provisioning status for an AWS account.
*/
ProvisioningStatus?: ProvisioningStatus;
/**
* The maximum number of results to display for the PermissionSet.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListAccountsForProvisionedPermissionSetResponse {
/**
* The list of AWS AccountIds.
*/
AccountIds?: AccountList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListInstancesRequest {
/**
* The maximum number of results to display for the instance.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListInstancesResponse {
/**
* Lists the SSO instances that the caller has access to.
*/
Instances?: InstanceList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListManagedPoliciesInPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the PermissionSet whose managed policies will be listed.
*/
PermissionSetArn: PermissionSetArn;
/**
* The maximum number of results to display for the PermissionSet.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListManagedPoliciesInPermissionSetResponse {
/**
* The array of the AttachedManagedPolicy data type object.
*/
AttachedManagedPolicies?: AttachedManagedPolicyList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListPermissionSetProvisioningStatusRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
/**
* Filters results based on the passed attribute value.
*/
Filter?: OperationStatusFilter;
}
export interface ListPermissionSetProvisioningStatusResponse {
/**
* The status object for the permission set provisioning operation.
*/
PermissionSetsProvisioningStatus?: PermissionSetProvisioningStatusList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListPermissionSetsProvisionedToAccountRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The identifier of the AWS account from which to list the assignments.
*/
AccountId: AccountId;
/**
* The status object for the permission set provisioning operation.
*/
ProvisioningStatus?: ProvisioningStatus;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListPermissionSetsProvisionedToAccountResponse {
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
/**
* Defines the level of access that an AWS account has.
*/
PermissionSets?: PermissionSetList;
}
export interface ListPermissionSetsRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
/**
* The maximum number of results to display for the assignment.
*/
MaxResults?: MaxResults;
}
export interface ListPermissionSetsResponse {
/**
* Defines the level of access on an AWS account.
*/
PermissionSets?: PermissionSetList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the resource with the tags to be listed.
*/
ResourceArn: GeneralArn;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export interface ListTagsForResourceResponse {
/**
* A set of key-value pairs that are used to manage the resource.
*/
Tags?: TagList;
/**
* The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
*/
NextToken?: Token;
}
export type ManagedPolicyArn = string;
export type MaxResults = number;
export type Name = string;
export interface OperationStatusFilter {
/**
* Filters the list operations result based on the status attribute.
*/
Status?: StatusValues;
}
export interface PermissionSet {
/**
* The name of the permission set.
*/
Name?: PermissionSetName;
/**
* The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
PermissionSetArn?: PermissionSetArn;
/**
* The description of the PermissionSet.
*/
Description?: PermissionSetDescription;
/**
* The date that the permission set was created.
*/
CreatedDate?: _Date;
/**
* The length of time that the application user sessions are valid for in the ISO-8601 standard.
*/
SessionDuration?: Duration;
/**
* Used to redirect users within the application during the federation authentication process.
*/
RelayState?: RelayState;
}
export type PermissionSetArn = string;
export type PermissionSetDescription = string;
export type PermissionSetList = PermissionSetArn[];
export type PermissionSetName = string;
export type PermissionSetPolicyDocument = string;
export interface PermissionSetProvisioningStatus {
/**
* The status of the permission set provisioning process.
*/
Status?: StatusValues;
/**
* The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
*/
RequestId?: UUId;
/**
* The identifier of the AWS account from which to list the assignments.
*/
AccountId?: AccountId;
/**
* The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
PermissionSetArn?: PermissionSetArn;
/**
* The message that contains an error or exception in case of an operation failure.
*/
FailureReason?: Reason;
/**
* The date that the permission set was created.
*/
CreatedDate?: _Date;
}
export type PermissionSetProvisioningStatusList = PermissionSetProvisioningStatusMetadata[];
export interface PermissionSetProvisioningStatusMetadata {
/**
* The status of the permission set provisioning process.
*/
Status?: StatusValues;
/**
* The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
*/
RequestId?: UUId;
/**
* The date that the permission set was created.
*/
CreatedDate?: _Date;
}
export type PrincipalId = string;
export type PrincipalType = "USER"|"GROUP"|string;
export interface ProvisionPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set.
*/
PermissionSetArn: PermissionSetArn;
/**
* TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
*/
TargetId?: TargetId;
/**
* The entity type for which the assignment will be created.
*/
TargetType: ProvisionTargetType;
}
export interface ProvisionPermissionSetResponse {
/**
* The status object for the permission set provisioning operation.
*/
PermissionSetProvisioningStatus?: PermissionSetProvisioningStatus;
}
export type ProvisionTargetType = "AWS_ACCOUNT"|"ALL_PROVISIONED_ACCOUNTS"|string;
export type ProvisioningStatus = "LATEST_PERMISSION_SET_PROVISIONED"|"LATEST_PERMISSION_SET_NOT_PROVISIONED"|string;
export interface PutInlinePolicyToPermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set.
*/
PermissionSetArn: PermissionSetArn;
/**
* The IAM inline policy to attach to a PermissionSet.
*/
InlinePolicy: PermissionSetPolicyDocument;
}
export interface PutInlinePolicyToPermissionSetResponse {
}
export type Reason = string;
export type RelayState = string;
export type StatusValues = "IN_PROGRESS"|"FAILED"|"SUCCEEDED"|string;
export interface Tag {
/**
* The key for the tag.
*/
Key?: TagKey;
/**
* The value of the tag.
*/
Value?: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the resource with the tags to be listed.
*/
ResourceArn: GeneralArn;
/**
* A set of key-value pairs that are used to manage the resource.
*/
Tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type TargetId = string;
export type TargetType = "AWS_ACCOUNT"|string;
export type Token = string;
export type UUId = string;
export interface UntagResourceRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the resource with the tags to be listed.
*/
ResourceArn: GeneralArn;
/**
* The keys of tags that are attached to the resource.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdatePermissionSetRequest {
/**
* The ARN of the SSO instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
*/
InstanceArn: InstanceArn;
/**
* The ARN of the permission set.
*/
PermissionSetArn: PermissionSetArn;
/**
* The description of the PermissionSet.
*/
Description?: PermissionSetDescription;
/**
* The length of time that the application user sessions are valid for in the ISO-8601 standard.
*/
SessionDuration?: Duration;
/**
* Used to redirect users within the application during the federation authentication process.
*/
RelayState?: RelayState;
}
export interface UpdatePermissionSetResponse {
}
/**
* 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 = "2020-07-20"|"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 SSOAdmin client.
*/
export import Types = SSOAdmin;
}
export = SSOAdmin;