-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Copy pathiam-2010-05-08.normal.json
10550 lines (10550 loc) · 623 KB
/
iam-2010-05-08.normal.json
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
{
"version": "2.0",
"metadata": {
"apiVersion": "2010-05-08",
"endpointPrefix": "iam",
"globalEndpoint": "iam.amazonaws.com",
"protocol": "query",
"protocols": [
"query"
],
"serviceAbbreviation": "IAM",
"serviceFullName": "AWS Identity and Access Management",
"serviceId": "IAM",
"signatureVersion": "v4",
"uid": "iam-2010-05-08",
"xmlNamespace": "https://iam.amazonaws.com/doc/2010-05-08/",
"auth": [
"aws.auth#sigv4"
]
},
"operations": {
"AddClientIDToOpenIDConnectProvider": {
"name": "AddClientIDToOpenIDConnectProvider",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AddClientIDToOpenIDConnectProviderRequest"
},
"errors": [
{
"shape": "InvalidInputException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.</p> <p>This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.</p>"
},
"AddRoleToInstanceProfile": {
"name": "AddRoleToInstanceProfile",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AddRoleToInstanceProfileRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "UnmodifiableEntityException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of <a href=\"https://en.wikipedia.org/wiki/Eventual_consistency\">eventual consistency</a>. To force the change, you must <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html\">disassociate the instance profile</a> and then <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html\">associate the instance profile</a>, or you can stop your instance and then restart it.</p> <note> <p>The caller of this operation must be granted the <code>PassRole</code> permission on the IAM role by a permissions policy.</p> </note> <p> For more information about roles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM roles</a> in the <i>IAM User Guide</i>. For more information about instance profiles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html\">Using instance profiles</a> in the <i>IAM User Guide</i>.</p>"
},
"AddUserToGroup": {
"name": "AddUserToGroup",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AddUserToGroupRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Adds the specified user to the specified group.</p>"
},
"AttachGroupPolicy": {
"name": "AttachGroupPolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AttachGroupPolicyRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "PolicyNotAttachableException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Attaches the specified managed policy to the specified IAM group.</p> <p>You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutGroupPolicy.html\"> <code>PutGroupPolicy</code> </a>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html\">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about policies, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p>"
},
"AttachRolePolicy": {
"name": "AttachRolePolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AttachRolePolicyRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "UnmodifiableEntityException"
},
{
"shape": "PolicyNotAttachableException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.</p> <note> <p>You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html\"> <code>CreateRole</code> </a>. You can update a role's trust policy using <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html\"> <code>UpdateAssumerolePolicy</code> </a>.</p> </note> <p>Use this operation to attach a <i>managed</i> policy to a role. To embed an inline policy in a role, use <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutRolePolicy.html\"> <code>PutRolePolicy</code> </a>. For more information about policies, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html\">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p>"
},
"AttachUserPolicy": {
"name": "AttachUserPolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "AttachUserPolicyRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "PolicyNotAttachableException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Attaches the specified managed policy to the specified user.</p> <p>You use this operation to attach a <i>managed</i> policy to a user. To embed an inline policy in a user, use <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_PutUserPolicy.html\"> <code>PutUserPolicy</code> </a>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html\">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about policies, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p>"
},
"ChangePassword": {
"name": "ChangePassword",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "ChangePasswordRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "InvalidUserTypeException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "EntityTemporarilyUnmodifiableException"
},
{
"shape": "PasswordPolicyViolationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the <b>My Security Credentials</b> page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.</p> <p>Use <a>UpdateLoginProfile</a> to use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing passwords</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateAccessKey": {
"name": "CreateAccessKey",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateAccessKeyRequest"
},
"output": {
"shape": "CreateAccessKeyResponse",
"resultWrapper": "CreateAccessKeyResult"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p> Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is <code>Active</code>.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.</p> <p> For information about quotas on the number of keys you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.</p> </important>"
},
"CreateAccountAlias": {
"name": "CreateAccountAlias",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateAccountAliasRequest"
},
"errors": [
{
"shape": "ConcurrentModificationException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see <a href=\"https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html\">Creating, deleting, and listing an Amazon Web Services account alias</a> in the <i>Amazon Web Services Sign-In User Guide</i>.</p>"
},
"CreateGroup": {
"name": "CreateGroup",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateGroupRequest"
},
"output": {
"shape": "CreateGroupResponse",
"resultWrapper": "CreateGroupResult"
},
"errors": [
{
"shape": "LimitExceededException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates a new group.</p> <p> For information about the number of groups you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateInstanceProfile": {
"name": "CreateInstanceProfile",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateInstanceProfileRequest"
},
"output": {
"shape": "CreateInstanceProfileResponse",
"resultWrapper": "CreateInstanceProfileResult"
},
"errors": [
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p> Creates a new instance profile. For information about instance profiles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html\">Using roles for applications on Amazon EC2</a> in the <i>IAM User Guide</i>, and <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#ec2-instance-profile\">Instance profiles</a> in the <i>Amazon EC2 User Guide</i>.</p> <p> For information about the number of instance profiles you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM object quotas</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateLoginProfile": {
"name": "CreateLoginProfile",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateLoginProfileRequest"
},
"output": {
"shape": "CreateLoginProfileResponse",
"resultWrapper": "CreateLoginProfileResult"
},
"errors": [
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "PasswordPolicyViolationException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates a password for the specified IAM user. A password allows an IAM user to access Amazon Web Services services through the Amazon Web Services Management Console.</p> <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to create a password for any IAM user. Use <a>ChangePassword</a> to update your own existing password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <p>For more information about managing passwords, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing passwords</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateOpenIDConnectProvider": {
"name": "CreateOpenIDConnectProvider",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateOpenIDConnectProviderRequest"
},
"output": {
"shape": "CreateOpenIDConnectProviderResponse",
"resultWrapper": "CreateOpenIDConnectProviderResult"
},
"errors": [
{
"shape": "InvalidInputException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
},
{
"shape": "OpenIdIdpCommunicationErrorException"
}
],
"documentation": "<p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href=\"http://openid.net/connect/\">OpenID Connect (OIDC)</a>.</p> <p>The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider.</p> <p>If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html\">Creating a role for web identity or OpenID connect federation</a> in the <i>IAM User Guide</i>.</p> <p>When you create the IAM OIDC provider, you specify the following:</p> <ul> <li> <p>The URL of the OIDC identity provider (IdP) to trust</p> </li> <li> <p>A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider</p> </li> <li> <p>A list of tags that are attached to the specified IAM OIDC provider</p> </li> <li> <p>A list of thumbprints of one or more server certificates that the IdP uses</p> </li> </ul> <p>You get all of this information from the OIDC IdP you want to use to access Amazon Web Services.</p> <note> <p>Amazon Web Services secures communication with OIDC identity providers (IdPs) using our library of trusted root certificate authorities (CAs) to verify the JSON Web Key Set (JWKS) endpoint's TLS certificate. If your OIDC IdP relies on a certificate that is not signed by one of these trusted CAs, only then we secure communication using the thumbprints set in the IdP's configuration.</p> </note> <note> <p>The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged users.</p> </note>"
},
"CreatePolicy": {
"name": "CreatePolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreatePolicyRequest"
},
"output": {
"shape": "CreatePolicyResponse",
"resultWrapper": "CreatePolicyResult"
},
"errors": [
{
"shape": "InvalidInputException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "MalformedPolicyDocumentException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates a new managed policy for your Amazon Web Services account.</p> <p>This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p> <p>As a best practice, you can validate your IAM policies. To learn more, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html\">Validating IAM policies</a> in the <i>IAM User Guide</i>.</p> <p>For more information about managed policies in general, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p>"
},
"CreatePolicyVersion": {
"name": "CreatePolicyVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreatePolicyVersionRequest"
},
"output": {
"shape": "CreatePolicyVersionResponse",
"resultWrapper": "CreatePolicyVersionResult"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "MalformedPolicyDocumentException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version.</p> <p>Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.</p> <p>For more information about managed policy versions, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateRole": {
"name": "CreateRole",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateRoleRequest"
},
"output": {
"shape": "CreateRoleResponse",
"resultWrapper": "CreateRoleResult"
},
"errors": [
{
"shape": "LimitExceededException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "MalformedPolicyDocumentException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates a new role for your Amazon Web Services account.</p> <p> For more information about roles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM roles</a> in the <i>IAM User Guide</i>. For information about quotas for role names and the number of roles you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateSAMLProvider": {
"name": "CreateSAMLProvider",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateSAMLProviderRequest"
},
"output": {
"shape": "CreateSAMLProviderResponse",
"resultWrapper": "CreateSAMLProviderResult"
},
"errors": [
{
"shape": "InvalidInputException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.</p> <p>The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the Amazon Web Services Management Console or one that supports API access to Amazon Web Services.</p> <p>When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.</p> <note> <p> This operation requires <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p> </note> <p> For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html\">Enabling SAML 2.0 federated users to access the Amazon Web Services Management Console</a> and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html\">About SAML 2.0-based federation</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateServiceLinkedRole": {
"name": "CreateServiceLinkedRole",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateServiceLinkedRoleRequest"
},
"output": {
"shape": "CreateServiceLinkedRoleResponse",
"resultWrapper": "CreateServiceLinkedRoleResult"
},
"errors": [
{
"shape": "InvalidInputException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates an IAM role that is linked to a specific Amazon Web Services service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your Amazon Web Services resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html\">Using service-linked roles</a> in the <i>IAM User Guide</i>. </p> <p>To attach a policy to this service-linked role, you must make the request using the Amazon Web Services service that depends on this role.</p>"
},
"CreateServiceSpecificCredential": {
"name": "CreateServiceSpecificCredential",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateServiceSpecificCredentialRequest"
},
"output": {
"shape": "CreateServiceSpecificCredentialResponse",
"resultWrapper": "CreateServiceSpecificCredentialResult"
},
"errors": [
{
"shape": "LimitExceededException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "ServiceNotSupportedException"
}
],
"documentation": "<p>Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service. </p> <p>You can have a maximum of two sets of service-specific credentials for each supported service per user.</p> <p>You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).</p> <p>You can reset the password to a new service-generated value by calling <a>ResetServiceSpecificCredential</a>.</p> <p>For more information about service-specific credentials, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html\">Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateUser": {
"name": "CreateUser",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateUserRequest"
},
"output": {
"shape": "CreateUserResponse",
"resultWrapper": "CreateUserResult"
},
"errors": [
{
"shape": "LimitExceededException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates a new IAM user for your Amazon Web Services account.</p> <p> For information about quotas for the number of IAM users you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p>"
},
"CreateVirtualMFADevice": {
"name": "CreateVirtualMFADevice",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "CreateVirtualMFADeviceRequest"
},
"output": {
"shape": "CreateVirtualMFADeviceResponse",
"resultWrapper": "CreateVirtualMFADeviceResult"
},
"errors": [
{
"shape": "LimitExceededException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "EntityAlreadyExistsException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Creates a new virtual MFA device for the Amazon Web Services account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Using a virtual MFA device</a> in the <i>IAM User Guide</i>.</p> <p>For information about the maximum number of MFA devices you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your Amazon Web Services access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.</p> </important>"
},
"DeactivateMFADevice": {
"name": "DeactivateMFADevice",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeactivateMFADeviceRequest"
},
"errors": [
{
"shape": "EntityTemporarilyUnmodifiableException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
},
{
"shape": "ConcurrentModificationException"
}
],
"documentation": "<p>Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.</p> <p>For more information about creating and working with virtual MFA devices, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Enabling a virtual multi-factor authentication (MFA) device</a> in the <i>IAM User Guide</i>.</p>"
},
"DeleteAccessKey": {
"name": "DeleteAccessKey",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteAccessKeyRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the access key pair associated with the specified IAM user.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.</p>"
},
"DeleteAccountAlias": {
"name": "DeleteAccountAlias",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteAccountAliasRequest"
},
"errors": [
{
"shape": "ConcurrentModificationException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p> Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see <a href=\"https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html\">Creating, deleting, and listing an Amazon Web Services account alias</a> in the <i>Amazon Web Services Sign-In User Guide</i>.</p>"
},
"DeleteAccountPasswordPolicy": {
"name": "DeleteAccountPasswordPolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the password policy for the Amazon Web Services account. There are no parameters.</p>"
},
"DeleteGroup": {
"name": "DeleteGroup",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteGroupRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "DeleteConflictException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the specified IAM group. The group must not contain any users or have any attached policies.</p>"
},
"DeleteGroupPolicy": {
"name": "DeleteGroupPolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteGroupPolicyRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the specified inline policy that is embedded in the specified IAM group.</p> <p>A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p>"
},
"DeleteInstanceProfile": {
"name": "DeleteInstanceProfile",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteInstanceProfileRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "DeleteConflictException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the specified instance profile. The instance profile must not have an associated role.</p> <important> <p>Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.</p> </important> <p>For more information about instance profiles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html\">Using instance profiles</a> in the <i>IAM User Guide</i>.</p>"
},
"DeleteLoginProfile": {
"name": "DeleteLoginProfile",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteLoginProfileRequest"
},
"errors": [
{
"shape": "EntityTemporarilyUnmodifiableException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the password for the specified IAM user, For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html\">Managing passwords for IAM users</a>.</p> <p>You can use the CLI, the Amazon Web Services API, or the <b>Users</b> page in the IAM console to delete a password for any IAM user. You can use <a>ChangePassword</a> to update, but not delete, your own password in the <b>My Security Credentials</b> page in the Amazon Web Services Management Console.</p> <important> <p>Deleting a user's password does not prevent a user from accessing Amazon Web Services through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see <a>UpdateAccessKey</a> and <a>DeleteAccessKey</a>.</p> </important>"
},
"DeleteOpenIDConnectProvider": {
"name": "DeleteOpenIDConnectProvider",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteOpenIDConnectProviderRequest"
},
"errors": [
{
"shape": "InvalidInputException"
},
{
"shape": "NoSuchEntityException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes an OpenID Connect identity provider (IdP) resource object in IAM.</p> <p>Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.</p> <p>This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.</p>"
},
"DeletePolicy": {
"name": "DeletePolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeletePolicyRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "DeleteConflictException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the specified managed policy.</p> <p>Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:</p> <ul> <li> <p>Detach the policy from all users, groups, and roles that the policy is attached to, using <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a>. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>.</p> </li> <li> <p>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.</p> </li> <li> <p>Delete the policy (this automatically deletes the policy's default version) using this operation.</p> </li> </ul> <p>For information about managed policies, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p>"
},
"DeletePolicyVersion": {
"name": "DeletePolicyVersion",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeletePolicyVersionRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "InvalidInputException"
},
{
"shape": "DeleteConflictException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the specified version from the specified managed policy.</p> <p>You cannot delete the default version from a policy using this operation. To delete the default version from a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>.</p> <p>For information about versions for managed policies, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for managed policies</a> in the <i>IAM User Guide</i>.</p>"
},
"DeleteRole": {
"name": "DeleteRole",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteRoleRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "DeleteConflictException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "UnmodifiableEntityException"
},
{
"shape": "ConcurrentModificationException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_delete.html#roles-managingrole-deleting-cli\">Deleting an IAM role</a>. Before attempting to delete a role, remove the following attached items: </p> <ul> <li> <p>Inline policies (<a>DeleteRolePolicy</a>)</p> </li> <li> <p>Attached managed policies (<a>DetachRolePolicy</a>)</p> </li> <li> <p>Instance profile (<a>RemoveRoleFromInstanceProfile</a>)</p> </li> <li> <p>Optional – Delete instance profile after detaching from role for resource clean up (<a>DeleteInstanceProfile</a>)</p> </li> </ul> <important> <p>Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.</p> </important>"
},
"DeleteRolePermissionsBoundary": {
"name": "DeleteRolePermissionsBoundary",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteRolePermissionsBoundaryRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "UnmodifiableEntityException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the permissions boundary for the specified IAM role. </p> <p>You cannot set the boundary for a service-linked role.</p> <important> <p>Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.</p> </important>"
},
"DeleteRolePolicy": {
"name": "DeleteRolePolicy",
"http": {
"method": "POST",
"requestUri": "/"
},
"input": {
"shape": "DeleteRolePolicyRequest"
},
"errors": [
{
"shape": "NoSuchEntityException"
},
{
"shape": "LimitExceededException"
},
{
"shape": "UnmodifiableEntityException"
},
{
"shape": "ServiceFailureException"
}
],
"documentation": "<p>Deletes the specified inline policy that is embedded in the specified IAM role.</p> <p>A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed policies and inline policies</a> in the <i>IAM User Guide</i>.</p>"
},
"DeleteSAMLProvider": {
"name": "DeleteSAMLProvider",
"http": {
"method": "POST",