@aws-sdk/client-sts 3.39.0 → 3.43.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.
- package/CHANGELOG.md +44 -0
- package/dist-cjs/endpoints.js +146 -24
- package/dist-cjs/runtimeConfig.browser.js +6 -3
- package/dist-cjs/runtimeConfig.js +5 -3
- package/dist-es/endpoints.js +146 -24
- package/dist-es/runtimeConfig.browser.js +3 -2
- package/dist-es/runtimeConfig.js +3 -3
- package/dist-types/STS.d.ts +90 -137
- package/dist-types/STSClient.d.ts +8 -0
- package/dist-types/commands/AssumeRoleCommand.d.ts +24 -18
- package/dist-types/commands/AssumeRoleWithSAMLCommand.d.ts +14 -14
- package/dist-types/commands/AssumeRoleWithWebIdentityCommand.d.ts +5 -5
- package/dist-types/commands/DecodeAuthorizationMessageCommand.d.ts +3 -3
- package/dist-types/commands/GetAccessKeyInfoCommand.d.ts +18 -18
- package/dist-types/commands/GetCallerIdentityCommand.d.ts +9 -9
- package/dist-types/commands/GetFederationTokenCommand.d.ts +23 -76
- package/dist-types/commands/GetSessionTokenCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +63 -44
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/STSClient.d.ts +4 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
- package/package.json +23 -23
package/dist-types/STS.d.ts
CHANGED
|
@@ -18,20 +18,19 @@ import { STSClient } from "./STSClient";
|
|
|
18
18
|
export declare class STS extends STSClient {
|
|
19
19
|
/**
|
|
20
20
|
* <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* <i>IAM User Guide</i>.</p>
|
|
21
|
+
* resources that you might not normally have access to. These temporary credentials consist
|
|
22
|
+
* of an access key ID, a secret access key, and a security token. Typically, you use
|
|
23
|
+
* <code>AssumeRole</code> within your account or for cross-account access. For a
|
|
24
|
+
* comparison of <code>AssumeRole</code> with other API operations that produce temporary
|
|
25
|
+
* credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
|
|
26
|
+
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
27
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
29
28
|
* <p>
|
|
30
29
|
* <b>Permissions</b>
|
|
31
30
|
* </p>
|
|
32
31
|
* <p>The temporary security credentials created by <code>AssumeRole</code> can be used to
|
|
33
32
|
* make API calls to any Amazon Web Services service with the following exception: You cannot call the
|
|
34
|
-
* STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API
|
|
33
|
+
* Amazon Web Services STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API
|
|
35
34
|
* operations.</p>
|
|
36
35
|
* <p>(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
|
|
37
36
|
* this operation. You can pass a single JSON policy document to use as an inline session
|
|
@@ -45,28 +44,35 @@ export declare class STS extends STSClient {
|
|
|
45
44
|
* by the identity-based policy of the role that is being assumed. For more information, see
|
|
46
45
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
47
46
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
48
|
-
* <p>
|
|
47
|
+
* <p>When you create a role, you create two policies: A role trust policy that specifies
|
|
48
|
+
* <i>who</i> can assume the role and a permissions policy that specifies
|
|
49
|
+
* <i>what</i> can be done with the role. You specify the trusted principal
|
|
50
|
+
* who is allowed to assume the role in the role trust policy.</p>
|
|
51
|
+
* <p>To assume a role from a different account, your Amazon Web Services account must be trusted by the
|
|
49
52
|
* role. The trust relationship is defined in the role's trust policy when the role is
|
|
50
53
|
* created. That trust policy states which accounts are allowed to delegate that access to
|
|
51
54
|
* users in the account. </p>
|
|
52
55
|
* <p>A user who wants to access a role in a different account must also have permissions that
|
|
53
56
|
* are delegated from the user account administrator. The administrator must attach a policy
|
|
54
57
|
* that allows the user to call <code>AssumeRole</code> for the ARN of the role in the other
|
|
55
|
-
* account
|
|
58
|
+
* account.</p>
|
|
59
|
+
* <p>To allow a user to assume a role in the same account, you can do either of the
|
|
56
60
|
* following:</p>
|
|
57
61
|
* <ul>
|
|
58
62
|
* <li>
|
|
59
|
-
* <p>Attach a policy to the user
|
|
60
|
-
* account).</p>
|
|
63
|
+
* <p>Attach a policy to the user that allows the user to call
|
|
64
|
+
* <code>AssumeRole</code> (as long as the role's trust policy trusts the account).</p>
|
|
61
65
|
* </li>
|
|
62
66
|
* <li>
|
|
63
67
|
* <p>Add the user as a principal directly in the role's trust policy.</p>
|
|
64
68
|
* </li>
|
|
65
69
|
* </ul>
|
|
66
|
-
* <p>
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
+
* <p>You can do either because the role’s trust policy acts as an IAM resource-based
|
|
71
|
+
* policy. When a resource-based policy grants access to a principal in the same account, no
|
|
72
|
+
* additional identity-based policy is required. For more information about trust policies and
|
|
73
|
+
* resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the
|
|
74
|
+
* <i>IAM User Guide</i>.</p>
|
|
75
|
+
*
|
|
70
76
|
* <p>
|
|
71
77
|
* <b>Tags</b>
|
|
72
78
|
* </p>
|
|
@@ -112,7 +118,7 @@ export declare class STS extends STSClient {
|
|
|
112
118
|
* credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the
|
|
113
119
|
* 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
|
|
114
120
|
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
115
|
-
* STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
121
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
116
122
|
* <p>The temporary security credentials returned by this operation consist of an access key
|
|
117
123
|
* ID, a secret access key, and a security token. Applications can use these temporary
|
|
118
124
|
* security credentials to sign calls to Amazon Web Services services.</p>
|
|
@@ -134,15 +140,15 @@ export declare class STS extends STSClient {
|
|
|
134
140
|
* 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
|
|
135
141
|
* <i>IAM User Guide</i>.</p>
|
|
136
142
|
* <note>
|
|
137
|
-
*
|
|
138
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining">Role chaining</a> limits your CLI or Amazon Web Services API
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* <code>DurationSeconds</code> parameter value greater than one hour, the
|
|
145
|
-
*
|
|
143
|
+
* <p>
|
|
144
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining">Role chaining</a> limits your CLI or Amazon Web Services API role
|
|
145
|
+
* session to a maximum of one hour. When you use the <code>AssumeRole</code> API operation
|
|
146
|
+
* to assume a role, you can specify the duration of your role session with the
|
|
147
|
+
* <code>DurationSeconds</code> parameter. You can specify a parameter value of up to
|
|
148
|
+
* 43200 seconds (12 hours), depending on the maximum session duration setting for your
|
|
149
|
+
* role. However, if you assume a role using role chaining and provide a
|
|
150
|
+
* <code>DurationSeconds</code> parameter value greater than one hour, the operation
|
|
151
|
+
* fails.</p>
|
|
146
152
|
* </note>
|
|
147
153
|
* <p>
|
|
148
154
|
* <b>Permissions</b>
|
|
@@ -194,9 +200,9 @@ export declare class STS extends STSClient {
|
|
|
194
200
|
* request are to the upper size limit.
|
|
195
201
|
* </p>
|
|
196
202
|
* </note>
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
* key.</p>
|
|
203
|
+
*
|
|
204
|
+
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
|
|
205
|
+
* you do, session tags override the role's tags with the same key.</p>
|
|
200
206
|
* <p>An administrator must grant you the permissions necessary to pass session tags. The
|
|
201
207
|
* administrator can also create granular permissions to allow you to pass only specific
|
|
202
208
|
* session tags. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html">Tutorial: Using Tags
|
|
@@ -265,7 +271,7 @@ export declare class STS extends STSClient {
|
|
|
265
271
|
* <code>AssumeRoleWithWebIdentity</code> with the other API operations that produce
|
|
266
272
|
* temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
|
|
267
273
|
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
268
|
-
* STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
274
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
269
275
|
* <p>The temporary security credentials returned by this API consist of an access key ID, a
|
|
270
276
|
* secret access key, and a security token. Applications can use these temporary security
|
|
271
277
|
* credentials to sign calls to Amazon Web Services service API operations.</p>
|
|
@@ -323,9 +329,9 @@ export declare class STS extends STSClient {
|
|
|
323
329
|
* request are to the upper size limit.
|
|
324
330
|
* </p>
|
|
325
331
|
* </note>
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
* key.</p>
|
|
332
|
+
*
|
|
333
|
+
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
|
|
334
|
+
* you do, the session tag overrides the role tag with the same key.</p>
|
|
329
335
|
* <p>An administrator must grant you the permissions necessary to pass session tags. The
|
|
330
336
|
* administrator can also create granular permissions to allow you to pass only specific
|
|
331
337
|
* session tags. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html">Tutorial: Using Tags
|
|
@@ -395,9 +401,9 @@ export declare class STS extends STSClient {
|
|
|
395
401
|
* documentation for an individual operation indicates whether that operation returns an
|
|
396
402
|
* encoded message in addition to returning an HTTP code.</p>
|
|
397
403
|
* </note>
|
|
398
|
-
* <p>The message is encoded because the details of the authorization status can
|
|
404
|
+
* <p>The message is encoded because the details of the authorization status can contain
|
|
399
405
|
* privileged information that the user who requested the operation should not see. To decode
|
|
400
|
-
* an authorization status message, a user must be granted permissions
|
|
406
|
+
* an authorization status message, a user must be granted permissions through an IAM <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">policy</a> to
|
|
401
407
|
* request the <code>DecodeAuthorizationMessage</code>
|
|
402
408
|
* (<code>sts:DecodeAuthorizationMessage</code>) action. </p>
|
|
403
409
|
* <p>The decoded message includes the following type of information:</p>
|
|
@@ -426,38 +432,38 @@ export declare class STS extends STSClient {
|
|
|
426
432
|
decodeAuthorizationMessage(args: DecodeAuthorizationMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecodeAuthorizationMessageCommandOutput) => void): void;
|
|
427
433
|
/**
|
|
428
434
|
* <p>Returns the account identifier for the specified access key ID.</p>
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
435
|
+
* <p>Access keys consist of two parts: an access key ID (for example,
|
|
436
|
+
* <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example,
|
|
437
|
+
* <code>wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY</code>). For more information about
|
|
438
|
+
* access keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">Managing Access Keys for IAM
|
|
439
|
+
* Users</a> in the <i>IAM User Guide</i>.</p>
|
|
440
|
+
* <p>When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account
|
|
441
|
+
* to which the keys belong. Access key IDs beginning with <code>AKIA</code> are long-term
|
|
442
|
+
* credentials for an IAM user or the Amazon Web Services account root user. Access key IDs beginning with
|
|
443
|
+
* <code>ASIA</code> are temporary credentials that are created using STS operations. If
|
|
444
|
+
* the account in the response belongs to you, you can sign in as the root user and review
|
|
445
|
+
* 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
|
|
446
|
+
* learn which IAM user owns the keys. To learn who requested the temporary credentials for
|
|
447
|
+
* 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> in the
|
|
448
|
+
* <i>IAM User Guide</i>.</p>
|
|
449
|
+
* <p>This operation does not indicate the state of the access key. The key might be active,
|
|
450
|
+
* inactive, or deleted. Active keys might not have permissions to perform an operation.
|
|
451
|
+
* Providing a deleted access key might return an error that the key doesn't exist.</p>
|
|
446
452
|
*/
|
|
447
453
|
getAccessKeyInfo(args: GetAccessKeyInfoCommandInput, options?: __HttpHandlerOptions): Promise<GetAccessKeyInfoCommandOutput>;
|
|
448
454
|
getAccessKeyInfo(args: GetAccessKeyInfoCommandInput, cb: (err: any, data?: GetAccessKeyInfoCommandOutput) => void): void;
|
|
449
455
|
getAccessKeyInfo(args: GetAccessKeyInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessKeyInfoCommandOutput) => void): void;
|
|
450
456
|
/**
|
|
451
457
|
* <p>Returns details about the IAM user or role whose credentials are used to call the
|
|
452
|
-
*
|
|
453
|
-
*
|
|
458
|
+
* operation.</p>
|
|
459
|
+
* <note>
|
|
454
460
|
* <p>No permissions are required to perform this operation. If an administrator adds a
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
+
* policy to your IAM user or role that explicitly denies access to the
|
|
462
|
+
* <code>sts:GetCallerIdentity</code> action, you can still perform this operation.
|
|
463
|
+
* Permissions are not required because the same information is returned when an IAM user
|
|
464
|
+
* 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> in the
|
|
465
|
+
* <i>IAM User Guide</i>.</p>
|
|
466
|
+
* </note>
|
|
461
467
|
*/
|
|
462
468
|
getCallerIdentity(args: GetCallerIdentityCommandInput, options?: __HttpHandlerOptions): Promise<GetCallerIdentityCommandOutput>;
|
|
463
469
|
getCallerIdentity(args: GetCallerIdentityCommandInput, cb: (err: any, data?: GetCallerIdentityCommandOutput) => void): void;
|
|
@@ -472,7 +478,7 @@ export declare class STS extends STSClient {
|
|
|
472
478
|
* server-based application. For a comparison of <code>GetFederationToken</code> with the
|
|
473
479
|
* 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
|
|
474
480
|
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
475
|
-
* STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
481
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
476
482
|
* <note>
|
|
477
483
|
* <p>You can create a mobile-based or browser-based app that can authenticate users using
|
|
478
484
|
* a web identity provider like Login with Amazon, Facebook, Google, or an OpenID
|
|
@@ -491,8 +497,8 @@ export declare class STS extends STSClient {
|
|
|
491
497
|
* </p>
|
|
492
498
|
* <p>The temporary credentials are valid for the specified duration, from 900 seconds (15
|
|
493
499
|
* minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is
|
|
494
|
-
* 43,200 seconds (12 hours). Temporary credentials
|
|
495
|
-
*
|
|
500
|
+
* 43,200 seconds (12 hours). Temporary credentials obtained by using the Amazon Web Services account root
|
|
501
|
+
* user credentials have a maximum duration of 3,600 seconds (1 hour).</p>
|
|
496
502
|
* <p>
|
|
497
503
|
* <b>Permissions</b>
|
|
498
504
|
* </p>
|
|
@@ -530,78 +536,25 @@ export declare class STS extends STSClient {
|
|
|
530
536
|
* <p>(Optional) You can pass tag key-value pairs to your session. These are called session
|
|
531
537
|
* tags. 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
|
|
532
538
|
* <i>IAM User Guide</i>.</p>
|
|
533
|
-
*
|
|
534
|
-
* <p>You can create a mobile-based or browser-based app that can authenticate users
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
* account root user credentials have a maximum duration of 3,600 seconds (1 hour).</p>
|
|
553
|
-
* <p>
|
|
554
|
-
* <b>Permissions</b>
|
|
555
|
-
* </p>
|
|
556
|
-
* <p>You can use the temporary credentials created by <code>GetFederationToken</code> in
|
|
557
|
-
* any Amazon Web Services service except the following:</p>
|
|
558
|
-
* <ul>
|
|
559
|
-
* <li>
|
|
560
|
-
* <p>You cannot call any IAM operations using the CLI or the Amazon Web Services API.
|
|
561
|
-
* </p>
|
|
562
|
-
* </li>
|
|
563
|
-
* <li>
|
|
564
|
-
* <p>You cannot call any STS operations except
|
|
565
|
-
* <code>GetCallerIdentity</code>.</p>
|
|
566
|
-
* </li>
|
|
567
|
-
* </ul>
|
|
568
|
-
* <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
|
|
569
|
-
* this operation. You can pass a single JSON policy document to use as an inline session
|
|
570
|
-
* policy. You can also specify up to 10 managed policies to use as managed session
|
|
571
|
-
* policies. The plain text that you use for both inline and managed session policies can't
|
|
572
|
-
* exceed 2,048 characters.</p>
|
|
573
|
-
* <p>Though the session policy parameters are optional, if you do not pass a policy, then
|
|
574
|
-
* the resulting federated user session has no permissions. When you pass session policies,
|
|
575
|
-
* the session permissions are the intersection of the IAM user policies and the session
|
|
576
|
-
* policies that you pass. This gives you a way to further restrict the permissions for a
|
|
577
|
-
* federated user. You cannot use session policies to grant more permissions than those
|
|
578
|
-
* that are defined in the permissions policy of the IAM user. For more information, see
|
|
579
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a>
|
|
580
|
-
* in the <i>IAM User Guide</i>. For information about using
|
|
581
|
-
* <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>. </p>
|
|
582
|
-
* <p>You can use the credentials to access a resource that has a resource-based policy. If
|
|
583
|
-
* that policy specifically references the federated user session in the
|
|
584
|
-
* <code>Principal</code> element of the policy, the session has the permissions
|
|
585
|
-
* allowed by the policy. These permissions are granted in addition to the permissions
|
|
586
|
-
* granted by the session policies.</p>
|
|
587
|
-
* <p>
|
|
588
|
-
* <b>Tags</b>
|
|
589
|
-
* </p>
|
|
590
|
-
* <p>(Optional) You can pass tag key-value pairs to your session. These are called session
|
|
591
|
-
* tags. 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
|
|
592
|
-
* the <i>IAM User Guide</i>.</p>
|
|
593
|
-
* <p>An administrator must grant you the permissions necessary to pass session tags. The
|
|
594
|
-
* administrator can also create granular permissions to allow you to pass only specific
|
|
595
|
-
* session tags. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html">Tutorial: Using
|
|
596
|
-
* Tags for Attribute-Based Access Control</a> in the
|
|
597
|
-
* <i>IAM User Guide</i>.</p>
|
|
598
|
-
* <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
|
|
599
|
-
* cannot have separate <code>Department</code> and <code>department</code> tag keys.
|
|
600
|
-
* Assume that the user that you are federating has the
|
|
601
|
-
* <code>Department</code>=<code>Marketing</code> tag and you pass the
|
|
602
|
-
* <code>department</code>=<code>engineering</code> session tag.
|
|
603
|
-
* <code>Department</code> and <code>department</code> are not saved as separate tags,
|
|
604
|
-
* and the session tag passed in the request takes precedence over the user tag.</p>
|
|
539
|
+
* <note>
|
|
540
|
+
* <p>You can create a mobile-based or browser-based app that can authenticate users using
|
|
541
|
+
* a web identity provider like Login with Amazon, Facebook, Google, or an OpenID
|
|
542
|
+
* Connect-compatible identity provider. In this case, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or
|
|
543
|
+
* <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> in the
|
|
544
|
+
* <i>IAM User Guide</i>.</p>
|
|
545
|
+
* </note>
|
|
546
|
+
* <p>An administrator must grant you the permissions necessary to pass session tags. The
|
|
547
|
+
* administrator can also create granular permissions to allow you to pass only specific
|
|
548
|
+
* session tags. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html">Tutorial: Using Tags
|
|
549
|
+
* for Attribute-Based Access Control</a> in the
|
|
550
|
+
* <i>IAM User Guide</i>.</p>
|
|
551
|
+
* <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
|
|
552
|
+
* cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
|
|
553
|
+
* that the user that you are federating has the
|
|
554
|
+
* <code>Department</code>=<code>Marketing</code> tag and you pass the
|
|
555
|
+
* <code>department</code>=<code>engineering</code> session tag. <code>Department</code>
|
|
556
|
+
* and <code>department</code> are not saved as separate tags, and the session tag passed in
|
|
557
|
+
* the request takes precedence over the user tag.</p>
|
|
605
558
|
*/
|
|
606
559
|
getFederationToken(args: GetFederationTokenCommandInput, options?: __HttpHandlerOptions): Promise<GetFederationTokenCommandOutput>;
|
|
607
560
|
getFederationToken(args: GetFederationTokenCommandInput, cb: (err: any, data?: GetFederationTokenCommandOutput) => void): void;
|
|
@@ -618,7 +571,7 @@ export declare class STS extends STSClient {
|
|
|
618
571
|
* the API returns an access denied error. For a comparison of <code>GetSessionToken</code>
|
|
619
572
|
* 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
|
|
620
573
|
* Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
621
|
-
* STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
574
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
622
575
|
* <p>
|
|
623
576
|
* <b>Session Duration</b>
|
|
624
577
|
* </p>
|
|
@@ -84,6 +84,14 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
84
84
|
* Optional logger for logging debug/info/warn/error.
|
|
85
85
|
*/
|
|
86
86
|
logger?: __Logger;
|
|
87
|
+
/**
|
|
88
|
+
* Enables IPv6/IPv4 dualstack endpoint.
|
|
89
|
+
*/
|
|
90
|
+
useDualstackEndpoint?: boolean | __Provider<boolean>;
|
|
91
|
+
/**
|
|
92
|
+
* Enables FIPS compatible endpoints.
|
|
93
|
+
*/
|
|
94
|
+
useFipsEndpoint?: boolean | __Provider<boolean>;
|
|
87
95
|
/**
|
|
88
96
|
* Unique service identifier.
|
|
89
97
|
* @internal
|
|
@@ -8,20 +8,19 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* <i>IAM User Guide</i>.</p>
|
|
11
|
+
* resources that you might not normally have access to. These temporary credentials consist
|
|
12
|
+
* of an access key ID, a secret access key, and a security token. Typically, you use
|
|
13
|
+
* <code>AssumeRole</code> within your account or for cross-account access. For a
|
|
14
|
+
* comparison of <code>AssumeRole</code> with other API operations that produce temporary
|
|
15
|
+
* credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
|
|
16
|
+
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
17
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
19
18
|
* <p>
|
|
20
19
|
* <b>Permissions</b>
|
|
21
20
|
* </p>
|
|
22
21
|
* <p>The temporary security credentials created by <code>AssumeRole</code> can be used to
|
|
23
22
|
* make API calls to any Amazon Web Services service with the following exception: You cannot call the
|
|
24
|
-
* STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API
|
|
23
|
+
* Amazon Web Services STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API
|
|
25
24
|
* operations.</p>
|
|
26
25
|
* <p>(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
|
|
27
26
|
* this operation. You can pass a single JSON policy document to use as an inline session
|
|
@@ -35,28 +34,35 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
|
|
|
35
34
|
* by the identity-based policy of the role that is being assumed. For more information, see
|
|
36
35
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
|
|
37
36
|
* Policies</a> in the <i>IAM User Guide</i>.</p>
|
|
38
|
-
* <p>
|
|
37
|
+
* <p>When you create a role, you create two policies: A role trust policy that specifies
|
|
38
|
+
* <i>who</i> can assume the role and a permissions policy that specifies
|
|
39
|
+
* <i>what</i> can be done with the role. You specify the trusted principal
|
|
40
|
+
* who is allowed to assume the role in the role trust policy.</p>
|
|
41
|
+
* <p>To assume a role from a different account, your Amazon Web Services account must be trusted by the
|
|
39
42
|
* role. The trust relationship is defined in the role's trust policy when the role is
|
|
40
43
|
* created. That trust policy states which accounts are allowed to delegate that access to
|
|
41
44
|
* users in the account. </p>
|
|
42
45
|
* <p>A user who wants to access a role in a different account must also have permissions that
|
|
43
46
|
* are delegated from the user account administrator. The administrator must attach a policy
|
|
44
47
|
* that allows the user to call <code>AssumeRole</code> for the ARN of the role in the other
|
|
45
|
-
* account
|
|
48
|
+
* account.</p>
|
|
49
|
+
* <p>To allow a user to assume a role in the same account, you can do either of the
|
|
46
50
|
* following:</p>
|
|
47
51
|
* <ul>
|
|
48
52
|
* <li>
|
|
49
|
-
* <p>Attach a policy to the user
|
|
50
|
-
* account).</p>
|
|
53
|
+
* <p>Attach a policy to the user that allows the user to call
|
|
54
|
+
* <code>AssumeRole</code> (as long as the role's trust policy trusts the account).</p>
|
|
51
55
|
* </li>
|
|
52
56
|
* <li>
|
|
53
57
|
* <p>Add the user as a principal directly in the role's trust policy.</p>
|
|
54
58
|
* </li>
|
|
55
59
|
* </ul>
|
|
56
|
-
* <p>
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
+
* <p>You can do either because the role’s trust policy acts as an IAM resource-based
|
|
61
|
+
* policy. When a resource-based policy grants access to a principal in the same account, no
|
|
62
|
+
* additional identity-based policy is required. For more information about trust policies and
|
|
63
|
+
* resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the
|
|
64
|
+
* <i>IAM User Guide</i>.</p>
|
|
65
|
+
*
|
|
60
66
|
* <p>
|
|
61
67
|
* <b>Tags</b>
|
|
62
68
|
* </p>
|
|
@@ -103,7 +109,7 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
|
|
|
103
109
|
*
|
|
104
110
|
* @see {@link AssumeRoleCommandInput} for command's `input` shape.
|
|
105
111
|
* @see {@link AssumeRoleCommandOutput} for command's `response` shape.
|
|
106
|
-
* @see {@link STSClientResolvedConfig | config} for
|
|
112
|
+
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
107
113
|
*
|
|
108
114
|
*/
|
|
109
115
|
export declare class AssumeRoleCommand extends $Command<AssumeRoleCommandInput, AssumeRoleCommandOutput, STSClientResolvedConfig> {
|
|
@@ -13,7 +13,7 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
|
|
|
13
13
|
* credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the
|
|
14
14
|
* 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
|
|
15
15
|
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
16
|
-
* STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
16
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
17
17
|
* <p>The temporary security credentials returned by this operation consist of an access key
|
|
18
18
|
* ID, a secret access key, and a security token. Applications can use these temporary
|
|
19
19
|
* security credentials to sign calls to Amazon Web Services services.</p>
|
|
@@ -35,15 +35,15 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
|
|
|
35
35
|
* 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
|
|
36
36
|
* <i>IAM User Guide</i>.</p>
|
|
37
37
|
* <note>
|
|
38
|
-
*
|
|
39
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining">Role chaining</a> limits your CLI or Amazon Web Services API
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* <code>DurationSeconds</code> parameter value greater than one hour, the
|
|
46
|
-
*
|
|
38
|
+
* <p>
|
|
39
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining">Role chaining</a> limits your CLI or Amazon Web Services API role
|
|
40
|
+
* session to a maximum of one hour. When you use the <code>AssumeRole</code> API operation
|
|
41
|
+
* to assume a role, you can specify the duration of your role session with the
|
|
42
|
+
* <code>DurationSeconds</code> parameter. You can specify a parameter value of up to
|
|
43
|
+
* 43200 seconds (12 hours), depending on the maximum session duration setting for your
|
|
44
|
+
* role. However, if you assume a role using role chaining and provide a
|
|
45
|
+
* <code>DurationSeconds</code> parameter value greater than one hour, the operation
|
|
46
|
+
* fails.</p>
|
|
47
47
|
* </note>
|
|
48
48
|
* <p>
|
|
49
49
|
* <b>Permissions</b>
|
|
@@ -95,9 +95,9 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
|
|
|
95
95
|
* request are to the upper size limit.
|
|
96
96
|
* </p>
|
|
97
97
|
* </note>
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
* key.</p>
|
|
98
|
+
*
|
|
99
|
+
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
|
|
100
|
+
* you do, session tags override the role's tags with the same key.</p>
|
|
101
101
|
* <p>An administrator must grant you the permissions necessary to pass session tags. The
|
|
102
102
|
* administrator can also create granular permissions to allow you to pass only specific
|
|
103
103
|
* session tags. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html">Tutorial: Using Tags
|
|
@@ -151,7 +151,7 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
|
|
|
151
151
|
*
|
|
152
152
|
* @see {@link AssumeRoleWithSAMLCommandInput} for command's `input` shape.
|
|
153
153
|
* @see {@link AssumeRoleWithSAMLCommandOutput} for command's `response` shape.
|
|
154
|
-
* @see {@link STSClientResolvedConfig | config} for
|
|
154
|
+
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
155
155
|
*
|
|
156
156
|
*/
|
|
157
157
|
export declare class AssumeRoleWithSAMLCommand extends $Command<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput, STSClientResolvedConfig> {
|
|
@@ -29,7 +29,7 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
|
|
|
29
29
|
* <code>AssumeRoleWithWebIdentity</code> with the other API operations that produce
|
|
30
30
|
* temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
|
|
31
31
|
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
|
|
32
|
-
* STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
32
|
+
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
|
|
33
33
|
* <p>The temporary security credentials returned by this API consist of an access key ID, a
|
|
34
34
|
* secret access key, and a security token. Applications can use these temporary security
|
|
35
35
|
* credentials to sign calls to Amazon Web Services service API operations.</p>
|
|
@@ -87,9 +87,9 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
|
|
|
87
87
|
* request are to the upper size limit.
|
|
88
88
|
* </p>
|
|
89
89
|
* </note>
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
* key.</p>
|
|
90
|
+
*
|
|
91
|
+
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
|
|
92
|
+
* you do, the session tag overrides the role tag with the same key.</p>
|
|
93
93
|
* <p>An administrator must grant you the permissions necessary to pass session tags. The
|
|
94
94
|
* administrator can also create granular permissions to allow you to pass only specific
|
|
95
95
|
* session tags. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html">Tutorial: Using Tags
|
|
@@ -155,7 +155,7 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
|
|
|
155
155
|
*
|
|
156
156
|
* @see {@link AssumeRoleWithWebIdentityCommandInput} for command's `input` shape.
|
|
157
157
|
* @see {@link AssumeRoleWithWebIdentityCommandOutput} for command's `response` shape.
|
|
158
|
-
* @see {@link STSClientResolvedConfig | config} for
|
|
158
|
+
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
159
159
|
*
|
|
160
160
|
*/
|
|
161
161
|
export declare class AssumeRoleWithWebIdentityCommand extends $Command<AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput, STSClientResolvedConfig> {
|
|
@@ -18,9 +18,9 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
|
|
|
18
18
|
* documentation for an individual operation indicates whether that operation returns an
|
|
19
19
|
* encoded message in addition to returning an HTTP code.</p>
|
|
20
20
|
* </note>
|
|
21
|
-
* <p>The message is encoded because the details of the authorization status can
|
|
21
|
+
* <p>The message is encoded because the details of the authorization status can contain
|
|
22
22
|
* privileged information that the user who requested the operation should not see. To decode
|
|
23
|
-
* an authorization status message, a user must be granted permissions
|
|
23
|
+
* an authorization status message, a user must be granted permissions through an IAM <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">policy</a> to
|
|
24
24
|
* request the <code>DecodeAuthorizationMessage</code>
|
|
25
25
|
* (<code>sts:DecodeAuthorizationMessage</code>) action. </p>
|
|
26
26
|
* <p>The decoded message includes the following type of information:</p>
|
|
@@ -55,7 +55,7 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
|
|
|
55
55
|
*
|
|
56
56
|
* @see {@link DecodeAuthorizationMessageCommandInput} for command's `input` shape.
|
|
57
57
|
* @see {@link DecodeAuthorizationMessageCommandOutput} for command's `response` shape.
|
|
58
|
-
* @see {@link STSClientResolvedConfig | config} for
|
|
58
|
+
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
59
59
|
*
|
|
60
60
|
*/
|
|
61
61
|
export declare class DecodeAuthorizationMessageCommand extends $Command<DecodeAuthorizationMessageCommandInput, DecodeAuthorizationMessageCommandOutput, STSClientResolvedConfig> {
|