Skip to content

Commit 583db52

Browse files
author
awstools
committed
docs(client-sts): Documentation updates for AWS Security Token Service.
1 parent 4a5f530 commit 583db52

File tree

8 files changed

+474
-489
lines changed

8 files changed

+474
-489
lines changed

‎clients/client-sts/src/STS.ts

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ export class STS extends STSClient {
6565
* operations.</p>
6666
* <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
6767
* this operation. You can pass a single JSON policy document to use as an inline session
68-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
69-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
70-
* characters. Passing policies to this operation returns new
68+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
69+
* managed session policies. The plaintext that you use for both inline and managed session
70+
* policies can't exceed 2,048 characters. Passing policies to this operation returns new
7171
* temporary credentials. The resulting session's permissions are the intersection of the
7272
* role's identity-based policy and the session policies. You can use the role's temporary
7373
* credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
@@ -210,9 +210,9 @@ export class STS extends STSClient {
210210
* operations.</p>
211211
* <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
212212
* this operation. You can pass a single JSON policy document to use as an inline session
213-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
214-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
215-
* characters. Passing policies to this operation returns new
213+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
214+
* managed session policies. The plaintext that you use for both inline and managed session
215+
* policies can't exceed 2,048 characters. Passing policies to this operation returns new
216216
* temporary credentials. The resulting session's permissions are the intersection of the
217217
* role's identity-based policy and the session policies. You can use the role's temporary
218218
* credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
@@ -244,12 +244,11 @@ export class STS extends STSClient {
244244
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
245245
*
246246
* <note>
247-
* <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
248-
* packed binary format that has a separate limit. Your request can fail for this limit
249-
* even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
250-
* response element indicates by percentage how close the policies and tags for your
251-
* request are to the upper size limit.
252-
* </p>
247+
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
248+
* and session tags into a packed binary format that has a separate limit. Your request can
249+
* fail for this limit even if your plaintext meets the other requirements. The
250+
* <code>PackedPolicySize</code> response element indicates by percentage how close the
251+
* policies and tags for your request are to the upper size limit.</p>
253252
* </note>
254253
*
255254
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
@@ -376,9 +375,9 @@ export class STS extends STSClient {
376375
* operations.</p>
377376
* <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
378377
* this operation. You can pass a single JSON policy document to use as an inline session
379-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
380-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
381-
* characters. Passing policies to this operation returns new
378+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
379+
* managed session policies. The plaintext that you use for both inline and managed session
380+
* policies can't exceed 2,048 characters. Passing policies to this operation returns new
382381
* temporary credentials. The resulting session's permissions are the intersection of the
383382
* role's identity-based policy and the session policies. You can use the role's temporary
384383
* credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
@@ -399,12 +398,11 @@ export class STS extends STSClient {
399398
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
400399
*
401400
* <note>
402-
* <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
403-
* packed binary format that has a separate limit. Your request can fail for this limit
404-
* even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
405-
* response element indicates by percentage how close the policies and tags for your
406-
* request are to the upper size limit.
407-
* </p>
401+
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
402+
* and session tags into a packed binary format that has a separate limit. Your request can
403+
* fail for this limit even if your plaintext meets the other requirements. The
404+
* <code>PackedPolicySize</code> response element indicates by percentage how close the
405+
* policies and tags for your request are to the upper size limit.</p>
408406
* </note>
409407
*
410408
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
@@ -695,9 +693,9 @@ export class STS extends STSClient {
695693
* </ul>
696694
* <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
697695
* this operation. You can pass a single JSON policy document to use as an inline session
698-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
699-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
700-
* characters.</p>
696+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
697+
* managed session policies. The plaintext that you use for both inline and managed session
698+
* policies can't exceed 2,048 characters.</p>
701699
* <p>Though the session policy parameters are optional, if you do not pass a policy, then the
702700
* resulting federated user session has no permissions. When you pass session policies, the
703701
* session permissions are the intersection of the IAM user policies and the session

‎clients/client-sts/src/commands/AssumeRoleCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
4444
* operations.</p>
4545
* <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
4646
* this operation. You can pass a single JSON policy document to use as an inline session
47-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
48-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
49-
* characters. Passing policies to this operation returns new
47+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
48+
* managed session policies. The plaintext that you use for both inline and managed session
49+
* policies can't exceed 2,048 characters. Passing policies to this operation returns new
5050
* temporary credentials. The resulting session's permissions are the intersection of the
5151
* role's identity-based policy and the session policies. You can use the role's temporary
5252
* credentials in subsequent Amazon Web Services API calls to access resources in the account that owns

‎clients/client-sts/src/commands/AssumeRoleWithSAMLCommand.ts

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
7676
* operations.</p>
7777
* <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
7878
* this operation. You can pass a single JSON policy document to use as an inline session
79-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
80-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
81-
* characters. Passing policies to this operation returns new
79+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
80+
* managed session policies. The plaintext that you use for both inline and managed session
81+
* policies can't exceed 2,048 characters. Passing policies to this operation returns new
8282
* temporary credentials. The resulting session's permissions are the intersection of the
8383
* role's identity-based policy and the session policies. You can use the role's temporary
8484
* credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
@@ -110,12 +110,11 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
110110
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
111111
*
112112
* <note>
113-
* <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
114-
* packed binary format that has a separate limit. Your request can fail for this limit
115-
* even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
116-
* response element indicates by percentage how close the policies and tags for your
117-
* request are to the upper size limit.
118-
* </p>
113+
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
114+
* and session tags into a packed binary format that has a separate limit. Your request can
115+
* fail for this limit even if your plaintext meets the other requirements. The
116+
* <code>PackedPolicySize</code> response element indicates by percentage how close the
117+
* policies and tags for your request are to the upper size limit.</p>
119118
* </note>
120119
*
121120
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When

‎clients/client-sts/src/commands/AssumeRoleWithWebIdentityCommand.ts

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
7979
* operations.</p>
8080
* <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
8181
* this operation. You can pass a single JSON policy document to use as an inline session
82-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
83-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
84-
* characters. Passing policies to this operation returns new
82+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
83+
* managed session policies. The plaintext that you use for both inline and managed session
84+
* policies can't exceed 2,048 characters. Passing policies to this operation returns new
8585
* temporary credentials. The resulting session's permissions are the intersection of the
8686
* role's identity-based policy and the session policies. You can use the role's temporary
8787
* credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
@@ -102,12 +102,11 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
102102
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
103103
*
104104
* <note>
105-
* <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
106-
* packed binary format that has a separate limit. Your request can fail for this limit
107-
* even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
108-
* response element indicates by percentage how close the policies and tags for your
109-
* request are to the upper size limit.
110-
* </p>
105+
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
106+
* and session tags into a packed binary format that has a separate limit. Your request can
107+
* fail for this limit even if your plaintext meets the other requirements. The
108+
* <code>PackedPolicySize</code> response element indicates by percentage how close the
109+
* policies and tags for your request are to the upper size limit.</p>
111110
* </note>
112111
*
113112
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When

‎clients/client-sts/src/commands/GetFederationTokenCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
7575
* </ul>
7676
* <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
7777
* this operation. You can pass a single JSON policy document to use as an inline session
78-
* policy. You can also specify up to 10 managed policies to use as managed session policies.
79-
* The plaintext that you use for both inline and managed session policies can't exceed 2,048
80-
* characters.</p>
78+
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as
79+
* managed session policies. The plaintext that you use for both inline and managed session
80+
* policies can't exceed 2,048 characters.</p>
8181
* <p>Though the session policy parameters are optional, if you do not pass a policy, then the
8282
* resulting federated user session has no permissions. When you pass session policies, the
8383
* session permissions are the intersection of the IAM user policies and the session

‎clients/client-sts/src/endpoint/ruleset.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -855,8 +855,8 @@ export const ruleSet: RuleSetObject = {
855855
authSchemes: [
856856
{
857857
name: "sigv4",
858-
signingName: "sts",
859858
signingRegion: "us-east-1",
859+
signingName: "sts",
860860
},
861861
],
862862
},

0 commit comments

Comments
 (0)