AWS.Tools.SecurityToken.dll-Help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
<helpItems schema="maml">
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Use-STSRoleWithSAML</name>
      <description>
        <para>Calls the AWS Security Token Service AssumeRoleWithSAML API operation.</para>
      </description>
      <verb>Use</verb>
      <noun>STSRoleWithSAML</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>.
The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.
The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. The duration can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.
The temporary security credentials created by <code>AssumeRoleWithSAML</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs.
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by the intersection of both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This means that both policies must grant the permission for the action to be allowed. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>.
Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy.
Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.
<important><para> Calling <code>AssumeRoleWithSAML</code> can result in an entry in your AWS CloudTrail logs. The entry includes the value in the <code>NameID</code> element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (<code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code>). </para></important>
For more information, see the following resources:
 - <a href="http://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>.
 - <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the <i>IAM User Guide</i>.
 - <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring a Relying Party and Claims</a> in the <i>IAM User Guide</i>.
 - <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the <i>IAM User Guide</i>. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Use-STSRoleWithSAML</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>RoleArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the role that the caller is assuming. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
          <name>PrincipalArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
          <name>SAMLAssertion</name>
          <description>
            <para>The base-64 encoded SAML authentication response provided by the IdP.
For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Adding Claims</a> in the <i>Using IAM</i> guide. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4">
          <name>Policy</name>
          <description>
            <para>An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5">
          <name>DurationInSeconds</name>
          <description>
            <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value. The actual expiration time is whichever value is shorter.
This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Region</name>
          <description>
            <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5">
        <name>DurationInSeconds</name>
        <description>
          <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value. The actual expiration time is whichever value is shorter.
This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4">
        <name>Policy</name>
        <description>
          <para>An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i><b>and</b></i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
        <name>PrincipalArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Region</name>
        <description>
          <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>RoleArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the role that the caller is assuming. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
        <name>SAMLAssertion</name>
        <description>
          <para>The base-64 encoded SAML authentication response provided by the IdP.
For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Adding Claims</a> in the <i>Using IAM</i> guide. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns an Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Use-STSRoleWithSAML.html&amp;tocid=Use-STSRoleWithSAML</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Use-STSWebIdentityRole</name>
      <description>
        <para>Calls the AWS Security Token Service AssumeRoleWithWebIdentity API operation.</para>
      </description>
      <verb>Use</verb>
      <noun>STSWebIdentityRole</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para> Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Login with Amazon, Facebook, or Google. <c>AssumeRoleWithWebIdentity</c> is an API call that does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application or by deploying server-based proxy services that use long-term AWS credentials. For more information, see Creating a Mobile Application with Third-Party Sign-In in <i>AWS Security Token Service</i> .
 The temporary security credentials consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. The credentials are valid for the duration that you specified when calling <c>AssumeRoleWithWebIdentity</c> , which can be from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the temporary security credentials are valid for 1 hour.
 The temporary security credentials that are returned from the <c>AssumeRoleWithWebIdentity</c> response have the permissions that are associated with the access policy of the role being assumed and any policies that are associated with the AWS resource being accessed. You can further restrict the permissions of the temporary security credentials by passing a policy in the request. The resulting permissions are an intersection of both policies. The role's access policy and the policy that you passed are evaluated when calls to AWS service APIs are made using the temporary security credentials.
Before your application can call <c>AssumeRoleWithWebIdentity</c> , you must have an identity token from an identity provider and create a role that the application can assume. Typically, to get an identity token, you need to register your application with the identity provider and get a unique application ID from that provider. Also, when you create the role that the application assumes, you must specify the registered identity provider as a principal (establish trust with the identity provider). For more information, see Creating Temporary Security Credentials for Mobile Apps Using Third-Party Identity Providers. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Use-STSWebIdentityRole</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>RoleArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the role that the caller is assuming.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>20 - 2048</description></item></list> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
          <name>RoleSessionName</name>
          <description>
            <para>An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the <c>AssumedRoleUser</c> response element.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>2 - 32</description></item><item><term>Pattern</term><description>[\w+=,.@-]*</description></item></list> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
          <name>WebIdentityToken</name>
          <description>
            <para>The OAuth 2.0 access token or OpenID Connect id token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an <c>AssumeRoleWithWebIdentity</c> call.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4">
          <name>ProviderId</name>
          <description>
            <para>Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect id tokens, such as <c>accounts.google.com</c>. This is the fully-qualified host component of the domain name of the identity provider. Do not include URL schemes and port numbers. Currently, <c>www.amazon.com</c> and <c>graph.facebook.com</c> are supported.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5">
          <name>Policy</name>
          <description>
            <para>A supplemental policy that is associated with the temporary security credentials from the <c>AssumeRoleWithWebIdentity</c> call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>1 - 2048</description></item><item><term>Pattern</term><description>[\u0009\u000A\u000D\u0020-\u00FF]+</description></item></list> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Duration</name>
          <description>
            <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
<b>Constraints:</b><list type="definition"><item><term>Range</term><description>900 - 129600</description></item></list> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Region</name>
          <description>
            <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Duration</name>
        <description>
          <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
<b>Constraints:</b><list type="definition"><item><term>Range</term><description>900 - 129600</description></item></list> </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5">
        <name>Policy</name>
        <description>
          <para>A supplemental policy that is associated with the temporary security credentials from the <c>AssumeRoleWithWebIdentity</c> call. The resulting permissions of the temporary security credentials are an intersection of this policy and the access policy that is associated with the role. Use this policy to further restrict the permissions of the temporary security credentials.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>1 - 2048</description></item><item><term>Pattern</term><description>[\u0009\u000A\u000D\u0020-\u00FF]+</description></item></list> </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4">
        <name>ProviderId</name>
        <description>
          <para>Specify this value only for OAuth access tokens. Do not specify this value for OpenID Connect id tokens, such as <c>accounts.google.com</c>. This is the fully-qualified host component of the domain name of the identity provider. Do not include URL schemes and port numbers. Currently, <c>www.amazon.com</c> and <c>graph.facebook.com</c> are supported.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Region</name>
        <description>
          <para>The region to use. STS has a single endpoint irrespective of region, though STS in GovCloud and China (Beijing) has its own endpoint. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>RoleArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the role that the caller is assuming.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>20 - 2048</description></item></list> </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
        <name>RoleSessionName</name>
        <description>
          <para>An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the <c>AssumedRoleUser</c> response element.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>2 - 32</description></item><item><term>Pattern</term><description>[\w+=,.@-]*</description></item></list> </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
        <name>WebIdentityToken</name>
        <description>
          <para>The OAuth 2.0 access token or OpenID Connect id token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an <c>AssumeRoleWithWebIdentity</c> call.
<b>Constraints:</b><list type="definition"><item><term>Length</term><description>4 - 2048</description></item></list> </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.PowerShell.Common.AWSWebIdentityCredentials or Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns an Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse instance. The service response (type Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse) is added to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Use-STSWebIdentityRole.html&amp;tocid=Use-STSWebIdentityRole</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\&gt;Use-STSWebIdentityRole -DurationInSeconds 3600 -ProviderId "www.amazon.com" -RoleSessionName "app1" -RoleArn "arn:aws:iam::123456789012:role/FederatedWebIdentityRole" -WebIdentityToken "Atza...DVI0r1"</code><remarks><para>Description</para><para>-----------</para><para>Returns a temporary set of credentials, valid for one hour, for a user who has been authenticated with the Login with Amazon identity provider. The credentials assume the access policy associated with the role identified by the role ARN. Optionally, you can pass a JSON policy to the -Policy parameter that further refine the access permissions (you cannot grant more permissions than are available in the permissions associated with the role). The value supplied to the -WebIdentityToken is the unique user identifier that was returned by the identity provider. </para><para /><para /></remarks>
      </example>
    </examples>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Convert-STSAuthorizationMessage</name>
      <description>
        <para>Calls the AWS Security Token Service (STS) DecodeAuthorizationMessage API operation.</para>
      </description>
      <verb>Convert</verb>
      <noun>STSAuthorizationMessage</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.
For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure.
Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.
The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action.
The decoded message includes the following type of information:
 -
Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the <i>IAM User Guide</i>.
 -
The principal who made the request.
 -
The requested action.
 -
The requested resource.
 -
The values of condition keys in the context of the user's request. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Convert-STSAuthorizationMessage</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>EncodedMessage</name>
          <description>
            <para>The encoded message that was returned with the response. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. The default value is 'DecodedMessage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>Changes the cmdlet behavior to return the value passed to the EncodedMessage parameter. The -PassThru parameter is deprecated, use -Select '^EncodedMessage' instead. This parameter will be removed in a future version. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>EncodedMessage</name>
        <description>
          <para>The encoded message that was returned with the response. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>Changes the cmdlet behavior to return the value passed to the EncodedMessage parameter. The -PassThru parameter is deprecated, use -Select '^EncodedMessage' instead. This parameter will be removed in a future version. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. The default value is 'DecodedMessage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>System.String or Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a System.String object.
The service call response (type Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Convert-STSAuthorizationMessage.html&amp;tocid=Convert-STSAuthorizationMessage</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\&gt;Convert-STSAuthorizationMessage -EncodedMessage "...encoded message..."</code><remarks><para>Description</para><para>-----------</para><para>Decodes the additional information contained in the supplied encoded message content that was returned in response to a request. The additional information is encoded because details of the authorization status can constitute privileged information that the user who requested the action should not see.</para><para /><para /></remarks>
      </example>
    </examples>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-STSAccessKeyInfo</name>
      <description>
        <para>Calls the AWS Security Token Service (STS) GetAccessKeyInfo API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>STSAccessKeyInfo</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns the account identifier for the specified access key ID.
Access keys consist of two parts: an access key ID (for example, <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example, <code>wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY</code>). For more information about access keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">Managing Access Keys for IAM Users</a> in the <i>IAM User Guide</i>.
When you pass an access key ID to this operation, it returns the ID of the AWS account to which the keys belong. Access key IDs beginning with <code>AKIA</code> are long-term credentials for an IAM user or the AWS account root user. Access key IDs beginning with <code>ASIA</code> are temporary credentials that are created using STS operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html">credentials report</a> to learn which IAM user owns the keys. To learn who requested the temporary credentials for an <code>ASIA</code> access key, view the STS events in your <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">CloudTrail logs</a>.
This operation does not indicate the state of the access key. The key might be active, inactive, or deleted. Active keys might not have permissions to perform an operation. Providing a deleted access key might return an error that the key doesn't exist. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-STSAccessKeyInfo</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>IdOfAccessKey</name>
          <description>
            <para>The identifier of an access key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper- or lowercased letter or digit. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. The default value is 'Account'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetAccessKeyInfoResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetAccessKeyInfoResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>Changes the cmdlet behavior to return the value passed to the IdOfAccessKey parameter. The -PassThru parameter is deprecated, use -Select '^IdOfAccessKey' instead. This parameter will be removed in a future version. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>IdOfAccessKey</name>
        <description>
          <para>The identifier of an access key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper- or lowercased letter or digit. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>Changes the cmdlet behavior to return the value passed to the IdOfAccessKey parameter. The -PassThru parameter is deprecated, use -Select '^IdOfAccessKey' instead. This parameter will be removed in a future version. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. The default value is 'Account'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetAccessKeyInfoResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetAccessKeyInfoResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>System.String or Amazon.SecurityToken.Model.GetAccessKeyInfoResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a System.String object.
The service call response (type Amazon.SecurityToken.Model.GetAccessKeyInfoResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-STSAccessKeyInfo.html&amp;tocid=Get-STSAccessKeyInfo</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-STSCallerIdentity</name>
      <description>
        <para>Calls the AWS Security Token Service (STS) GetCallerIdentity API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>STSCallerIdentity</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns details about the IAM user or role whose credentials are used to call the operation.
No permissions are required to perform this operation. If an administrator adds a policy to your IAM user or role that explicitly denies access to the <code>sts:GetCallerIdentity</code> action, you can still perform this operation. Permissions are not required because the same information is returned when an IAM user or role is denied access. To view an example response, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_access-denied-delete-mfa">I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice</a>. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-STSCallerIdentity</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetCallerIdentityResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetCallerIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetCallerIdentityResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetCallerIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.SecurityToken.Model.GetCallerIdentityResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns an Amazon.SecurityToken.Model.GetCallerIdentityResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-STSCallerIdentity.html&amp;tocid=Get-STSCallerIdentity</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-STSFederationToken</name>
      <description>
        <para>Calls the AWS Security Token Service (STS) GetFederationToken API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>STSFederationToken</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the <code>GetFederationToken</code> operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of <code>GetFederationToken</code> with the other API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.
You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>.
You can also call <code>GetFederationToken</code> using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>IAM User Guide</i>.
The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour).
The temporary security credentials created by <code>GetFederationToken</code> can be used to make API calls to any AWS service with the following exceptions:
 -
You cannot use these credentials to call any IAM API operations.
 -
You cannot call any STS API operations except <code>GetCallerIdentity</code>.
<b>Permissions</b>
You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters.
Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-STSFederationToken</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>Name</name>
          <description>
            <para>The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
          <name>Policy</name>
          <description>
            <para>An IAM policy in JSON format that you want to use as an inline session policy.
You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.
The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
          <name>DurationInSeconds</name>
          <description>
            <para>The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PolicyArn</name>
          <description>
            <para>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.SecurityToken.Model.PolicyDescriptorType[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetFederationTokenResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetFederationTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
        <name>DurationInSeconds</name>
        <description>
          <para>The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>Name</name>
        <description>
          <para>The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
        <name>Policy</name>
        <description>
          <para>An IAM policy in JSON format that you want to use as an inline session policy.
You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.
The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PolicyArn</name>
        <description>
          <para>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.SecurityToken.Model.PolicyDescriptorType[]</parameterValue>
        <type>
          <name>Amazon.SecurityToken.Model.PolicyDescriptorType[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetFederationTokenResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetFederationTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.SecurityToken.Model.GetFederationTokenResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns an Amazon.SecurityToken.Model.GetFederationTokenResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-STSFederationToken.html&amp;tocid=Get-STSFederationToken</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\&gt;Get-STSFederationToken -Name "Bob" -Policy "...JSON policy..." -DurationInSeconds 3600</code><remarks><para>Description</para><para>-----------</para><para>Requests a federated token valid for one hour using "Bob" as the name of the federated user. This name can be used to reference the federated user name in a resource-based policy (such as an Amazon S3 bucket policy). The supplied IAM policy, in JSON format, is used to scope down the permissions that are available to the IAM user. The supplied policy cannot grant more permissions than those granted to the requesting user, with the final permissions for the federated user being the most restrictive set based on the intersection of the passed policy and the IAM user policy.</para><para /><para /></remarks>
      </example>
    </examples>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-STSSessionToken</name>
      <description>
        <para>Calls the AWS Security Token Service (STS) GetSessionToken API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>STSSessionToken</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS API operations like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to API operations that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.
The <code>GetSessionToken</code> operation must be called by using the long-term AWS security credentials of the AWS account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.
The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions:
 -
You cannot call any IAM API operations unless MFA authentication information is included in the request.
 -
You cannot call any STS API <i>except</i><code>AssumeRole</code> or <code>GetCallerIdentity</code>.
We recommend that you do not call <code>GetSessionToken</code> with AWS account root user credentials. Instead, follow our <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.
The credentials that are returned by <code>GetSessionToken</code> are based on permissions associated with the user whose credentials were used to call the operation. If <code>GetSessionToken</code> is called using AWS account root user credentials, the temporary credentials have root user permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user.
For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-STSSessionToken</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>DurationInSeconds</name>
          <description>
            <para>The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
          <name>SerialNumber</name>
          <description>
            <para>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
          <name>TokenCode</name>
          <description>
            <para>The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. The default value is 'Credentials'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetSessionTokenResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetSessionTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>Changes the cmdlet behavior to return the value passed to the DurationInSeconds parameter. The -PassThru parameter is deprecated, use -Select '^DurationInSeconds' instead. This parameter will be removed in a future version. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>DurationInSeconds</name>
        <description>
          <para>The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>Changes the cmdlet behavior to return the value passed to the DurationInSeconds parameter. The -PassThru parameter is deprecated, use -Select '^DurationInSeconds' instead. This parameter will be removed in a future version. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. The default value is 'Credentials'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.GetSessionTokenResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.GetSessionTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
        <name>SerialNumber</name>
        <description>
          <para>The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
        <name>TokenCode</name>
        <description>
          <para>The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.SecurityToken.Model.Credentials or Amazon.SecurityToken.Model.GetSessionTokenResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns an Amazon.SecurityToken.Model.Credentials object.
The service call response (type Amazon.SecurityToken.Model.GetSessionTokenResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-STSSessionToken.html&amp;tocid=Get-STSSessionToken</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>
PS C:\&gt;Get-STSSessionToken
 
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
    </code><remarks><para>Description</para><para>-----------</para><para>Returns an Amazon.RuntimeAWSCredentials instance containing temporary credentials valid for a set period of time. The credentials used to request temporary credentials are inferred from the current shell defaults. To specify other credentials, use the -ProfileName or -AccessKey/-SecretKey parameters.</para><para /><para /></remarks>
      </example>
      <example>
        <title>-------------------------- EXAMPLE 2 --------------------------</title><code>
PS C:\&gt;Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile
 
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
    </code><remarks><para>Description</para><para>-----------</para><para>Returns an Amazon.RuntimeAWSCredentials instance containing temporary credentials valid for one hour. The credentials used to make the request are obtained from the specified profile.</para><para /><para /></remarks>
      </example>
      <example>
        <title>-------------------------- EXAMPLE 3 --------------------------</title><code>
PS C:\&gt;Get-STSSessionToken -DurationInSeconds 3600 -ProfileName myprofile -SerialNumber YourMFADeviceSerialNumber -TokenCode 123456
 
AccessKeyId Expiration SecretAccessKey SessionToken
----------- ---------- --------------- ------------
EXAMPLEACCESSKEYID 2/16/2015 9:12:28 PM examplesecretaccesskey... SamPleTokeN.....
    </code><remarks><para>Description</para><para>-----------</para><para>Returns an Amazon.RuntimeAWSCredentials instance containing temporary credentials valid for one hour using the identification number of the MFA device associated with the account whose credentials are specified in the profile 'myprofilename' and the value provided by the device.</para><para /><para /></remarks>
      </example>
    </examples>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Use-STSRole</name>
      <description>
        <para>Calls the AWS Security Token Service (STS) AssumeRole API operation.</para>
      </description>
      <verb>Use</verb>
      <noun>STSRole</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>AssumeRole</code> within your account or for cross-account access. For a comparison of <code>AssumeRole</code> with other API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.
 <important><para> You cannot use AWS account root user credentials to call <code>AssumeRole</code>. You must use credentials for an IAM user or an IAM role to call <code>AssumeRole</code>. </para></important>
For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account. Then use temporary security credentials to access all the other accounts by assuming roles in those accounts. 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>.
By default, the temporary security credentials created by <code>AssumeRole</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the <i>IAM User Guide</i>.
The temporary security credentials created by <code>AssumeRole</code> can be used to make API calls to any AWS service with the following exception: You cannot call the AWS STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.
(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.
To assume a role from a different account, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.
A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call <code>AssumeRole</code> for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following:
 -
Attach a policy to the user (identical to the previous user in a different account).
 -
Add the user as a principal directly in the role's trust policy.
In this case, the trust policy acts as an IAM resource-based policy. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the <i>IAM User Guide</i>.
<b>Using MFA with AssumeRole</b>
(Optional) You can include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.
<code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code>
For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>IAM User Guide</i> guide.
To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA device produces. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Use-STSRole</name>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
          <name>RoleArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the role to assume. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
          <name>RoleSessionName</name>
          <description>
            <para>An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
          <name>Policy</name>
          <description>
            <para>An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.
The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4">
          <name>DurationInSeconds</name>
          <description>
            <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>.
By default, the value is set to <code>3600</code> seconds.
The <code>DurationSeconds</code> parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL that Enables Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5">
          <name>ExternalId</name>
          <description>
            <para>A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the <code>ExternalId</code> parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to Use an External ID When Granting Access to Your AWS Resources to a Third Party</a> in the <i>IAM User Guide</i>.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PolicyArn</name>
          <description>
            <para>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.SecurityToken.Model.PolicyDescriptorType[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>SerialNumber</name>
          <description>
            <para>The identification number of the MFA device that is associated with the user who is making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>).
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>TokenCode</name>
          <description>
            <para>The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or expired, the <code>AssumeRole</code> call returns an "access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Select</name>
          <description>
            <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.AssumeRoleResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.AssumeRoleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>PassThru</name>
          <description>
            <para>Changes the cmdlet behavior to return the value passed to the RoleArn parameter. The -PassThru parameter is deprecated, use -Select '^RoleArn' instead. This parameter will be removed in a future version. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4">
        <name>DurationInSeconds</name>
        <description>
          <para>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>.
By default, the value is set to <code>3600</code> seconds.
The <code>DurationSeconds</code> parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL that Enables Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5">
        <name>ExternalId</name>
        <description>
          <para>A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the <code>ExternalId</code> parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to Use an External ID When Granting Access to Your AWS Resources to a Third Party</a> in the <i>IAM User Guide</i>.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PassThru</name>
        <description>
          <para>Changes the cmdlet behavior to return the value passed to the RoleArn parameter. The -PassThru parameter is deprecated, use -Select '^RoleArn' instead. This parameter will be removed in a future version. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3">
        <name>Policy</name>
        <description>
          <para>An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.
The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>PolicyArn</name>
        <description>
          <para>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.
The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.SecurityToken.Model.PolicyDescriptorType[]</parameterValue>
        <type>
          <name>Amazon.SecurityToken.Model.PolicyDescriptorType[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">
        <name>RoleArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the role to assume. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2">
        <name>RoleSessionName</name>
        <description>
          <para>An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>Select</name>
        <description>
          <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityToken.Model.AssumeRoleResponse). Specifying the name of a property of type Amazon.SecurityToken.Model.AssumeRoleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>SerialNumber</name>
        <description>
          <para>The identification number of the MFA device that is associated with the user who is making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>).
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">
        <name>TokenCode</name>
        <description>
          <para>The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or expired, the <code>AssumeRole</code> call returns an "access denied" error.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.SecurityToken.Model.AssumeRoleResponse</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns an Amazon.SecurityToken.Model.AssumeRoleResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Use-STSRole.html&amp;tocid=Use-STSRole</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Service API Reference:</linkText>
        <uri>https://docs.aws.amazon.com/STS/latest/APIReference/</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>PS C:\&gt;Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -Policy "...JSON policy..." -DurationInSeconds 3600</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials (access key, secret key and session token) that can be used for one hour to access AWS resources that the requesting user might not normally have access to. The returned credentials have the permissions that are allowed by the access policy of the role being assumed and the policy that was supplied (you cannot use the supplied policy to grant permissions in excess of those defined by the access policy of the role being assumed).</para><para /><para /></remarks>
      </example>
      <example>
        <title>-------------------------- EXAMPLE 2 --------------------------</title><code>PS C:\&gt;Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials, valid for one hour, that have the same permissions that are defined in the access policy of the role being assumed.</para><para /><para /></remarks>
      </example>
      <example>
        <title>-------------------------- EXAMPLE 3 --------------------------</title><code>PS C:\&gt;Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -SerialNumber "GAHT12345678" -TokenCode "123456"</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials supplying the serial number and generated token from an MFA associated with the user credentials used to execute the cmdlet.</para><para /><para /></remarks>
      </example>
      <example>
        <title>-------------------------- EXAMPLE 4 --------------------------</title><code>PS C:\&gt;Use-STSRole -RoleSessionName "Bob" -RoleArn "arn:aws:iam::123456789012:role/demo" -DurationInSeconds 3600 -ExternalId "ABC123"</code><remarks><para>Description</para><para>-----------</para><para>Returns a set of temporary credentials that have assumed a role defined in a customer account. For each role that the third party can assume, the customer account must create a role using an identifier that must be passed in the -ExternalId parameter each time the role is assumed.</para><para /><para /></remarks>
      </example>
    </examples>
  </command>
</helpItems>