@aws-sdk/client-sts 3.378.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -8,6 +8,7 @@
8
8
  */
9
9
  export * from "./STSClient";
10
10
  export * from "./STS";
11
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
11
12
  export * from "./commands";
12
13
  export * from "./models";
13
14
  export * from "./defaultRoleAssumers";
@@ -7,11 +7,13 @@ import { STSServiceException as __BaseException } from "./STSServiceException";
7
7
  */
8
8
  export interface AssumedRoleUser {
9
9
  /**
10
+ * @public
10
11
  * <p>A unique identifier that contains the role ID and the role session name of the role that
11
12
  * is being assumed. The role ID is generated by Amazon Web Services when the role is created.</p>
12
13
  */
13
14
  AssumedRoleId: string | undefined;
14
15
  /**
16
+ * @public
15
17
  * <p>The ARN of the temporary security credentials that are returned from the <a>AssumeRole</a> action. For more information about ARNs and how to use them in
16
18
  * policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
17
19
  * <i>IAM User Guide</i>.</p>
@@ -25,6 +27,7 @@ export interface AssumedRoleUser {
25
27
  */
26
28
  export interface PolicyDescriptorType {
27
29
  /**
30
+ * @public
28
31
  * <p>The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy
29
32
  * for the role. 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 Amazon Web Services
30
33
  * Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
@@ -37,10 +40,12 @@ export interface PolicyDescriptorType {
37
40
  */
38
41
  export interface ProvidedContext {
39
42
  /**
43
+ * @public
40
44
  * <p>Reserved for future use.</p>
41
45
  */
42
46
  ProviderArn?: string;
43
47
  /**
48
+ * @public
44
49
  * <p>Reserved for future use.</p>
45
50
  */
46
51
  ContextAssertion?: string;
@@ -54,6 +59,7 @@ export interface ProvidedContext {
54
59
  */
55
60
  export interface Tag {
56
61
  /**
62
+ * @public
57
63
  * <p>The key for a session tag.</p>
58
64
  * <p>You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128
59
65
  * characters. For these and additional limits, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
@@ -61,6 +67,7 @@ export interface Tag {
61
67
  */
62
68
  Key: string | undefined;
63
69
  /**
70
+ * @public
64
71
  * <p>The value for a session tag.</p>
65
72
  * <p>You can pass up to 50 session tags. The plain text session tag values can’t exceed 256
66
73
  * characters. For these and additional limits, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
@@ -73,10 +80,12 @@ export interface Tag {
73
80
  */
74
81
  export interface AssumeRoleRequest {
75
82
  /**
83
+ * @public
76
84
  * <p>The Amazon Resource Name (ARN) of the role to assume.</p>
77
85
  */
78
86
  RoleArn: string | undefined;
79
87
  /**
88
+ * @public
80
89
  * <p>An identifier for the assumed role session.</p>
81
90
  * <p>Use the role session name to uniquely identify a session when the same role is assumed
82
91
  * by different principals or for different reasons. In cross-account scenarios, the role
@@ -90,6 +99,7 @@ export interface AssumeRoleRequest {
90
99
  */
91
100
  RoleSessionName: string | undefined;
92
101
  /**
102
+ * @public
93
103
  * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as
94
104
  * managed session policies. The policies must exist in the same account as the role.</p>
95
105
  * <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the
@@ -114,6 +124,7 @@ export interface AssumeRoleRequest {
114
124
  */
115
125
  PolicyArns?: PolicyDescriptorType[];
116
126
  /**
127
+ * @public
117
128
  * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
118
129
  * <p>This parameter is optional. Passing policies to this operation returns new
119
130
  * temporary credentials. The resulting session's permissions are the intersection of the
@@ -138,6 +149,7 @@ export interface AssumeRoleRequest {
138
149
  */
139
150
  Policy?: string;
140
151
  /**
152
+ * @public
141
153
  * <p>The duration, in seconds, of the role session. The value specified can range from 900
142
154
  * seconds (15 minutes) up to the maximum session duration set for the role. The maximum
143
155
  * session duration setting can have a value from 1 hour to 12 hours. If you specify a value
@@ -166,6 +178,7 @@ export interface AssumeRoleRequest {
166
178
  */
167
179
  DurationSeconds?: number;
168
180
  /**
181
+ * @public
169
182
  * <p>A list of session tags that you want to pass. Each session tag consists of a key name
170
183
  * and an associated value. For more information about session tags, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Tagging Amazon Web Services STS
171
184
  * Sessions</a> in the <i>IAM User Guide</i>.</p>
@@ -196,6 +209,7 @@ export interface AssumeRoleRequest {
196
209
  */
197
210
  Tags?: Tag[];
198
211
  /**
212
+ * @public
199
213
  * <p>A list of keys for session tags that you want to set as transitive. If you set a tag key
200
214
  * as transitive, the corresponding key and value passes to subsequent sessions in a role
201
215
  * chain. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining">Chaining Roles
@@ -207,6 +221,7 @@ export interface AssumeRoleRequest {
207
221
  */
208
222
  TransitiveTagKeys?: string[];
209
223
  /**
224
+ * @public
210
225
  * <p>A unique identifier that might be required when you assume a role in another account. If
211
226
  * the administrator of the account to which the role belongs provided you with an external
212
227
  * ID, then provide that value in the <code>ExternalId</code> parameter. This value can be any
@@ -223,6 +238,7 @@ export interface AssumeRoleRequest {
223
238
  */
224
239
  ExternalId?: string;
225
240
  /**
241
+ * @public
226
242
  * <p>The identification number of the MFA device that is associated with the user who is
227
243
  * making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role
228
244
  * being assumed includes a condition that requires MFA authentication. The value is either
@@ -235,6 +251,7 @@ export interface AssumeRoleRequest {
235
251
  */
236
252
  SerialNumber?: string;
237
253
  /**
254
+ * @public
238
255
  * <p>The value provided by the MFA device, if the trust policy of the role being assumed
239
256
  * requires MFA. (In other words, if the policy includes a condition that tests for MFA). If
240
257
  * the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or
@@ -244,6 +261,7 @@ export interface AssumeRoleRequest {
244
261
  */
245
262
  TokenCode?: string;
246
263
  /**
264
+ * @public
247
265
  * <p>The source identity specified by the principal that is calling the
248
266
  * <code>AssumeRole</code> operation.</p>
249
267
  * <p>You can require users to specify a source identity when they assume a role. You do this
@@ -261,6 +279,7 @@ export interface AssumeRoleRequest {
261
279
  */
262
280
  SourceIdentity?: string;
263
281
  /**
282
+ * @public
264
283
  * <p>Reserved for future use.</p>
265
284
  */
266
285
  ProvidedContexts?: ProvidedContext[];
@@ -271,19 +290,23 @@ export interface AssumeRoleRequest {
271
290
  */
272
291
  export interface Credentials {
273
292
  /**
293
+ * @public
274
294
  * <p>The access key ID that identifies the temporary security credentials.</p>
275
295
  */
276
296
  AccessKeyId: string | undefined;
277
297
  /**
298
+ * @public
278
299
  * <p>The secret access key that can be used to sign requests.</p>
279
300
  */
280
301
  SecretAccessKey: string | undefined;
281
302
  /**
303
+ * @public
282
304
  * <p>The token that users must pass to the service API to use the temporary
283
305
  * credentials.</p>
284
306
  */
285
307
  SessionToken: string | undefined;
286
308
  /**
309
+ * @public
287
310
  * <p>The date on which the current credentials expire.</p>
288
311
  */
289
312
  Expiration: Date | undefined;
@@ -295,6 +318,7 @@ export interface Credentials {
295
318
  */
296
319
  export interface AssumeRoleResponse {
297
320
  /**
321
+ * @public
298
322
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
299
323
  * and a security (or session) token.</p>
300
324
  * <note>
@@ -304,6 +328,7 @@ export interface AssumeRoleResponse {
304
328
  */
305
329
  Credentials?: Credentials;
306
330
  /**
331
+ * @public
307
332
  * <p>The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you
308
333
  * can use to refer to the resulting temporary security credentials. For example, you can
309
334
  * reference these credentials as a principal in a resource-based policy by using the ARN or
@@ -312,12 +337,14 @@ export interface AssumeRoleResponse {
312
337
  */
313
338
  AssumedRoleUser?: AssumedRoleUser;
314
339
  /**
340
+ * @public
315
341
  * <p>A percentage value that indicates the packed size of the session policies and session
316
342
  * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
317
343
  * which means the policies and tags exceeded the allowed space.</p>
318
344
  */
319
345
  PackedPolicySize?: number;
320
346
  /**
347
+ * @public
321
348
  * <p>The source identity specified by the principal that is calling the
322
349
  * <code>AssumeRole</code> operation.</p>
323
350
  * <p>You can require users to specify a source identity when they assume a role. You do this
@@ -401,21 +428,25 @@ export declare class RegionDisabledException extends __BaseException {
401
428
  */
402
429
  export interface AssumeRoleWithSAMLRequest {
403
430
  /**
431
+ * @public
404
432
  * <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
405
433
  */
406
434
  RoleArn: string | undefined;
407
435
  /**
436
+ * @public
408
437
  * <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
409
438
  * IdP.</p>
410
439
  */
411
440
  PrincipalArn: string | undefined;
412
441
  /**
442
+ * @public
413
443
  * <p>The base64 encoded SAML authentication response provided by the IdP.</p>
414
444
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and
415
445
  * Adding Claims</a> in the <i>IAM User Guide</i>. </p>
416
446
  */
417
447
  SAMLAssertion: string | undefined;
418
448
  /**
449
+ * @public
419
450
  * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as
420
451
  * managed session policies. The policies must exist in the same account as the role.</p>
421
452
  * <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the
@@ -440,6 +471,7 @@ export interface AssumeRoleWithSAMLRequest {
440
471
  */
441
472
  PolicyArns?: PolicyDescriptorType[];
442
473
  /**
474
+ * @public
443
475
  * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
444
476
  * <p>This parameter is optional. Passing policies to this operation returns new
445
477
  * temporary credentials. The resulting session's permissions are the intersection of the
@@ -464,6 +496,7 @@ export interface AssumeRoleWithSAMLRequest {
464
496
  */
465
497
  Policy?: string;
466
498
  /**
499
+ * @public
467
500
  * <p>The duration, in seconds, of the role session. Your role session lasts for the duration
468
501
  * that you specify for the <code>DurationSeconds</code> parameter, or until the time
469
502
  * specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value,
@@ -495,6 +528,7 @@ export interface AssumeRoleWithSAMLRequest {
495
528
  */
496
529
  export interface AssumeRoleWithSAMLResponse {
497
530
  /**
531
+ * @public
498
532
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
499
533
  * and a security (or session) token.</p>
500
534
  * <note>
@@ -504,22 +538,26 @@ export interface AssumeRoleWithSAMLResponse {
504
538
  */
505
539
  Credentials?: Credentials;
506
540
  /**
541
+ * @public
507
542
  * <p>The identifiers for the temporary security credentials that the operation
508
543
  * returns.</p>
509
544
  */
510
545
  AssumedRoleUser?: AssumedRoleUser;
511
546
  /**
547
+ * @public
512
548
  * <p>A percentage value that indicates the packed size of the session policies and session
513
549
  * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
514
550
  * which means the policies and tags exceeded the allowed space.</p>
515
551
  */
516
552
  PackedPolicySize?: number;
517
553
  /**
554
+ * @public
518
555
  * <p>The value of the <code>NameID</code> element in the <code>Subject</code> element of the
519
556
  * SAML assertion.</p>
520
557
  */
521
558
  Subject?: string;
522
559
  /**
560
+ * @public
523
561
  * <p> The format of the name ID, as defined by the <code>Format</code> attribute in the
524
562
  * <code>NameID</code> element of the SAML assertion. Typical examples of the format are
525
563
  * <code>transient</code> or <code>persistent</code>. </p>
@@ -531,15 +569,18 @@ export interface AssumeRoleWithSAMLResponse {
531
569
  */
532
570
  SubjectType?: string;
533
571
  /**
572
+ * @public
534
573
  * <p>The value of the <code>Issuer</code> element of the SAML assertion.</p>
535
574
  */
536
575
  Issuer?: string;
537
576
  /**
577
+ * @public
538
578
  * <p> The value of the <code>Recipient</code> attribute of the
539
579
  * <code>SubjectConfirmationData</code> element of the SAML assertion. </p>
540
580
  */
541
581
  Audience?: string;
542
582
  /**
583
+ * @public
543
584
  * <p>A hash value based on the concatenation of the following:</p>
544
585
  * <ul>
545
586
  * <li>
@@ -561,6 +602,7 @@ export interface AssumeRoleWithSAMLResponse {
561
602
  */
562
603
  NameQualifier?: string;
563
604
  /**
605
+ * @public
564
606
  * <p>The value in the <code>SourceIdentity</code> attribute in the SAML assertion. </p>
565
607
  * <p>You can require users to set a source identity value when they assume a role. You do
566
608
  * this by using the <code>sts:SourceIdentity</code> condition key in a role trust policy.
@@ -612,10 +654,12 @@ export declare class InvalidIdentityTokenException extends __BaseException {
612
654
  */
613
655
  export interface AssumeRoleWithWebIdentityRequest {
614
656
  /**
657
+ * @public
615
658
  * <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
616
659
  */
617
660
  RoleArn: string | undefined;
618
661
  /**
662
+ * @public
619
663
  * <p>An identifier for the assumed role session. Typically, you pass the name or identifier
620
664
  * that is associated with the user who is using your application. That way, the temporary
621
665
  * security credentials that your application will use are associated with that user. This
@@ -627,6 +671,7 @@ export interface AssumeRoleWithWebIdentityRequest {
627
671
  */
628
672
  RoleSessionName: string | undefined;
629
673
  /**
674
+ * @public
630
675
  * <p>The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity
631
676
  * provider. Your application must get this token by authenticating the user who is using your
632
677
  * application with a web identity provider before the application makes an
@@ -635,6 +680,7 @@ export interface AssumeRoleWithWebIdentityRequest {
635
680
  */
636
681
  WebIdentityToken: string | undefined;
637
682
  /**
683
+ * @public
638
684
  * <p>The fully qualified host component of the domain name of the OAuth 2.0 identity
639
685
  * provider. Do not specify this value for an OpenID Connect identity provider.</p>
640
686
  * <p>Currently <code>www.amazon.com</code> and <code>graph.facebook.com</code> are the only
@@ -644,6 +690,7 @@ export interface AssumeRoleWithWebIdentityRequest {
644
690
  */
645
691
  ProviderId?: string;
646
692
  /**
693
+ * @public
647
694
  * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as
648
695
  * managed session policies. The policies must exist in the same account as the role.</p>
649
696
  * <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the
@@ -668,6 +715,7 @@ export interface AssumeRoleWithWebIdentityRequest {
668
715
  */
669
716
  PolicyArns?: PolicyDescriptorType[];
670
717
  /**
718
+ * @public
671
719
  * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
672
720
  * <p>This parameter is optional. Passing policies to this operation returns new
673
721
  * temporary credentials. The resulting session's permissions are the intersection of the
@@ -692,6 +740,7 @@ export interface AssumeRoleWithWebIdentityRequest {
692
740
  */
693
741
  Policy?: string;
694
742
  /**
743
+ * @public
695
744
  * <p>The duration, in seconds, of the role session. The value can range from 900 seconds (15
696
745
  * minutes) up to the maximum session duration setting for the role. This setting can have a
697
746
  * value from 1 hour to 12 hours. If you specify a value higher than this setting, the
@@ -720,6 +769,7 @@ export interface AssumeRoleWithWebIdentityRequest {
720
769
  */
721
770
  export interface AssumeRoleWithWebIdentityResponse {
722
771
  /**
772
+ * @public
723
773
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
724
774
  * and a security token.</p>
725
775
  * <note>
@@ -729,6 +779,7 @@ export interface AssumeRoleWithWebIdentityResponse {
729
779
  */
730
780
  Credentials?: Credentials;
731
781
  /**
782
+ * @public
732
783
  * <p>The unique user identifier that is returned by the identity provider. This identifier is
733
784
  * associated with the <code>WebIdentityToken</code> that was submitted with the
734
785
  * <code>AssumeRoleWithWebIdentity</code> call. The identifier is typically unique to the
@@ -738,6 +789,7 @@ export interface AssumeRoleWithWebIdentityResponse {
738
789
  */
739
790
  SubjectFromWebIdentityToken?: string;
740
791
  /**
792
+ * @public
741
793
  * <p>The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you
742
794
  * can use to refer to the resulting temporary security credentials. For example, you can
743
795
  * reference these credentials as a principal in a resource-based policy by using the ARN or
@@ -746,12 +798,14 @@ export interface AssumeRoleWithWebIdentityResponse {
746
798
  */
747
799
  AssumedRoleUser?: AssumedRoleUser;
748
800
  /**
801
+ * @public
749
802
  * <p>A percentage value that indicates the packed size of the session policies and session
750
803
  * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
751
804
  * which means the policies and tags exceeded the allowed space.</p>
752
805
  */
753
806
  PackedPolicySize?: number;
754
807
  /**
808
+ * @public
755
809
  * <p> The issuing authority of the web identity token presented. For OpenID Connect ID
756
810
  * tokens, this contains the value of the <code>iss</code> field. For OAuth 2.0 access tokens,
757
811
  * this contains the value of the <code>ProviderId</code> parameter that was passed in the
@@ -759,12 +813,14 @@ export interface AssumeRoleWithWebIdentityResponse {
759
813
  */
760
814
  Provider?: string;
761
815
  /**
816
+ * @public
762
817
  * <p>The intended audience (also known as client ID) of the web identity token. This is
763
818
  * traditionally the client identifier issued to the application that requested the web
764
819
  * identity token.</p>
765
820
  */
766
821
  Audience?: string;
767
822
  /**
823
+ * @public
768
824
  * <p>The value of the source identity that is returned in the JSON web token (JWT) from the
769
825
  * identity provider.</p>
770
826
  * <p>You can require users to set a source identity value when they assume a role. You do
@@ -806,6 +862,7 @@ export declare class IDPCommunicationErrorException extends __BaseException {
806
862
  */
807
863
  export interface DecodeAuthorizationMessageRequest {
808
864
  /**
865
+ * @public
809
866
  * <p>The encoded message that was returned with the response.</p>
810
867
  */
811
868
  EncodedMessage: string | undefined;
@@ -817,6 +874,7 @@ export interface DecodeAuthorizationMessageRequest {
817
874
  */
818
875
  export interface DecodeAuthorizationMessageResponse {
819
876
  /**
877
+ * @public
820
878
  * <p>The API returns a response with the decoded message.</p>
821
879
  */
822
880
  DecodedMessage?: string;
@@ -840,6 +898,7 @@ export declare class InvalidAuthorizationMessageException extends __BaseExceptio
840
898
  */
841
899
  export interface GetAccessKeyInfoRequest {
842
900
  /**
901
+ * @public
843
902
  * <p>The identifier of an access key.</p>
844
903
  * <p>This parameter allows (through its regex pattern) a string of characters that can
845
904
  * consist of any upper- or lowercase letter or digit.</p>
@@ -851,6 +910,7 @@ export interface GetAccessKeyInfoRequest {
851
910
  */
852
911
  export interface GetAccessKeyInfoResponse {
853
912
  /**
913
+ * @public
854
914
  * <p>The number used to identify the Amazon Web Services account.</p>
855
915
  */
856
916
  Account?: string;
@@ -867,6 +927,7 @@ export interface GetCallerIdentityRequest {
867
927
  */
868
928
  export interface GetCallerIdentityResponse {
869
929
  /**
930
+ * @public
870
931
  * <p>The unique identifier of the calling entity. The exact value depends on the type of
871
932
  * entity that is making the call. The values returned are those listed in the <b>aws:userid</b> column in the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable">Principal
872
933
  * table</a> found on the <b>Policy Variables</b> reference
@@ -874,11 +935,13 @@ export interface GetCallerIdentityResponse {
874
935
  */
875
936
  UserId?: string;
876
937
  /**
938
+ * @public
877
939
  * <p>The Amazon Web Services account ID number of the account that owns or contains the calling
878
940
  * entity.</p>
879
941
  */
880
942
  Account?: string;
881
943
  /**
944
+ * @public
882
945
  * <p>The Amazon Web Services ARN associated with the calling entity.</p>
883
946
  */
884
947
  Arn?: string;
@@ -888,6 +951,7 @@ export interface GetCallerIdentityResponse {
888
951
  */
889
952
  export interface GetFederationTokenRequest {
890
953
  /**
954
+ * @public
891
955
  * <p>The name of the federated user. The name is used as an identifier for the temporary
892
956
  * security credentials (such as <code>Bob</code>). For example, you can reference the
893
957
  * federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.</p>
@@ -897,6 +961,7 @@ export interface GetFederationTokenRequest {
897
961
  */
898
962
  Name: string | undefined;
899
963
  /**
964
+ * @public
900
965
  * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
901
966
  * <p>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
902
967
  * this operation. You can pass a single JSON policy document to use as an inline session
@@ -930,6 +995,7 @@ export interface GetFederationTokenRequest {
930
995
  */
931
996
  Policy?: string;
932
997
  /**
998
+ * @public
933
999
  * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a
934
1000
  * managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.</p>
935
1001
  * <p>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
@@ -962,6 +1028,7 @@ export interface GetFederationTokenRequest {
962
1028
  */
963
1029
  PolicyArns?: PolicyDescriptorType[];
964
1030
  /**
1031
+ * @public
965
1032
  * <p>The duration, in seconds, that the session should last. Acceptable durations for
966
1033
  * federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with
967
1034
  * 43,200 seconds (12 hours) as the default. Sessions obtained using root user
@@ -971,6 +1038,7 @@ export interface GetFederationTokenRequest {
971
1038
  */
972
1039
  DurationSeconds?: number;
973
1040
  /**
1041
+ * @public
974
1042
  * <p>A list of session tags. Each session tag consists of a key name and an associated value.
975
1043
  * For more information about session tags, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Passing Session Tags in STS</a> in the
976
1044
  * <i>IAM User Guide</i>.</p>
@@ -1002,11 +1070,13 @@ export interface GetFederationTokenRequest {
1002
1070
  */
1003
1071
  export interface FederatedUser {
1004
1072
  /**
1073
+ * @public
1005
1074
  * <p>The string that identifies the federated user associated with the credentials, similar
1006
1075
  * to the unique ID of an IAM user.</p>
1007
1076
  */
1008
1077
  FederatedUserId: string | undefined;
1009
1078
  /**
1079
+ * @public
1010
1080
  * <p>The ARN that specifies the federated user that is associated with the credentials. For
1011
1081
  * more information about ARNs and how to use them in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
1012
1082
  * Identifiers</a> in the <i>IAM User Guide</i>. </p>
@@ -1020,6 +1090,7 @@ export interface FederatedUser {
1020
1090
  */
1021
1091
  export interface GetFederationTokenResponse {
1022
1092
  /**
1093
+ * @public
1023
1094
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
1024
1095
  * and a security (or session) token.</p>
1025
1096
  * <note>
@@ -1029,6 +1100,7 @@ export interface GetFederationTokenResponse {
1029
1100
  */
1030
1101
  Credentials?: Credentials;
1031
1102
  /**
1103
+ * @public
1032
1104
  * <p>Identifiers for the federated user associated with the credentials (such as
1033
1105
  * <code>arn:aws:sts::123456789012:federated-user/Bob</code> or
1034
1106
  * <code>123456789012:Bob</code>). You can use the federated user's ARN in your
@@ -1036,6 +1108,7 @@ export interface GetFederationTokenResponse {
1036
1108
  */
1037
1109
  FederatedUser?: FederatedUser;
1038
1110
  /**
1111
+ * @public
1039
1112
  * <p>A percentage value that indicates the packed size of the session policies and session
1040
1113
  * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
1041
1114
  * which means the policies and tags exceeded the allowed space.</p>
@@ -1047,6 +1120,7 @@ export interface GetFederationTokenResponse {
1047
1120
  */
1048
1121
  export interface GetSessionTokenRequest {
1049
1122
  /**
1123
+ * @public
1050
1124
  * <p>The duration, in seconds, that the credentials should remain valid. Acceptable durations
1051
1125
  * for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds
1052
1126
  * (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account
@@ -1055,6 +1129,7 @@ export interface GetSessionTokenRequest {
1055
1129
  */
1056
1130
  DurationSeconds?: number;
1057
1131
  /**
1132
+ * @public
1058
1133
  * <p>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
1059
1134
  * if the IAM user has a policy that requires MFA authentication. The value is
1060
1135
  * either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an
@@ -1066,6 +1141,7 @@ export interface GetSessionTokenRequest {
1066
1141
  */
1067
1142
  SerialNumber?: string;
1068
1143
  /**
1144
+ * @public
1069
1145
  * <p>The value provided by the MFA device, if MFA is required. If any policy requires the
1070
1146
  * IAM user to submit an MFA code, specify this value. If MFA authentication
1071
1147
  * is required, the user must provide a code when requesting a set of temporary security
@@ -1083,6 +1159,7 @@ export interface GetSessionTokenRequest {
1083
1159
  */
1084
1160
  export interface GetSessionTokenResponse {
1085
1161
  /**
1162
+ * @public
1086
1163
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
1087
1164
  * and a security (or session) token.</p>
1088
1165
  * <note>
@@ -1,5 +1,6 @@
1
1
  export * from "./STSClient";
2
2
  export * from "./STS";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./models";
5
6
  export * from "./defaultRoleAssumers";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sts",
3
3
  "description": "AWS SDK for JavaScript Sts Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -23,15 +23,15 @@
23
23
  "dependencies": {
24
24
  "@aws-crypto/sha256-browser": "3.0.0",
25
25
  "@aws-crypto/sha256-js": "3.0.0",
26
- "@aws-sdk/credential-provider-node": "3.378.0",
27
- "@aws-sdk/middleware-host-header": "3.378.0",
26
+ "@aws-sdk/credential-provider-node": "3.382.0",
27
+ "@aws-sdk/middleware-host-header": "3.379.1",
28
28
  "@aws-sdk/middleware-logger": "3.378.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
30
- "@aws-sdk/middleware-sdk-sts": "3.378.0",
31
- "@aws-sdk/middleware-signing": "3.378.0",
32
- "@aws-sdk/middleware-user-agent": "3.378.0",
30
+ "@aws-sdk/middleware-sdk-sts": "3.379.1",
31
+ "@aws-sdk/middleware-signing": "3.379.1",
32
+ "@aws-sdk/middleware-user-agent": "3.382.0",
33
33
  "@aws-sdk/types": "3.378.0",
34
- "@aws-sdk/util-endpoints": "3.378.0",
34
+ "@aws-sdk/util-endpoints": "3.382.0",
35
35
  "@aws-sdk/util-user-agent-browser": "3.378.0",
36
36
  "@aws-sdk/util-user-agent-node": "3.378.0",
37
37
  "@smithy/config-resolver": "^2.0.1",