Skip to content

Commit 40714b5

Browse files
author
awstools
committed
docs(client-sts): Doc only change to update wording in a key topic
1 parent 1e68ae3 commit 40714b5

File tree

8 files changed

+531
-527
lines changed

8 files changed

+531
-527
lines changed

clients/client-sts/src/STS.ts

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,10 @@ import { STSClient } from "./STSClient";
4949
export class STS extends STSClient {
5050
/**
5151
* <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
52-
* resources that you might not normally have access to. These temporary credentials consist
53-
* of an access key ID, a secret access key, and a security token. Typically, you use
54-
* <code>AssumeRole</code> within your account or for cross-account access. For a
55-
* comparison of <code>AssumeRole</code> with other API operations that produce temporary
56-
* credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
52+
* resources. These temporary credentials consist of an access key ID, a secret access key,
53+
* and a security token. Typically, you use <code>AssumeRole</code> within your account or for
54+
* cross-account access. For a comparison of <code>AssumeRole</code> with other API operations
55+
* that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
5756
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
5857
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
5958
* <p>
@@ -103,7 +102,6 @@ export class STS extends STSClient {
103102
* additional identity-based policy is required. For more information about trust policies and
104103
* resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the
105104
* <i>IAM User Guide</i>.</p>
106-
*
107105
* <p>
108106
* <b>Tags</b>
109107
* </p>
@@ -242,15 +240,13 @@ export class STS extends STSClient {
242240
* characters and the values can’t exceed 256 characters. For these and additional limits, see
243241
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
244242
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
245-
*
246243
* <note>
247244
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
248245
* and session tags into a packed binary format that has a separate limit. Your request can
249246
* fail for this limit even if your plaintext meets the other requirements. The
250247
* <code>PackedPolicySize</code> response element indicates by percentage how close the
251248
* policies and tags for your request are to the upper size limit.</p>
252249
* </note>
253-
*
254250
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
255251
* you do, session tags override the role's tags with the same key.</p>
256252
* <p>An administrator must grant you the permissions necessary to pass session tags. The
@@ -396,15 +392,13 @@ export class STS extends STSClient {
396392
* characters and the values can’t exceed 256 characters. For these and additional limits, see
397393
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
398394
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
399-
*
400395
* <note>
401396
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
402397
* and session tags into a packed binary format that has a separate limit. Your request can
403398
* fail for this limit even if your plaintext meets the other requirements. The
404399
* <code>PackedPolicySize</code> response element indicates by percentage how close the
405400
* policies and tags for your request are to the upper size limit.</p>
406401
* </note>
407-
*
408402
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
409403
* you do, the session tag overrides the role tag with the same key.</p>
410404
* <p>An administrator must grant you the permissions necessary to pass session tags. The
@@ -682,15 +676,16 @@ export class STS extends STSClient {
682676
* <b>Permissions</b>
683677
* </p>
684678
* <p>You can use the temporary credentials created by <code>GetFederationToken</code> in any
685-
* Amazon Web Services service except the following:</p>
679+
* Amazon Web Services service with the following exceptions:</p>
686680
* <ul>
687681
* <li>
688-
* <p>You cannot call any IAM operations using the CLI or the Amazon Web Services API. </p>
682+
* <p>You cannot call any IAM operations using the CLI or the Amazon Web Services API. This limitation does not apply to console sessions.</p>
689683
* </li>
690684
* <li>
691685
* <p>You cannot call any STS operations except <code>GetCallerIdentity</code>.</p>
692686
* </li>
693687
* </ul>
688+
* <p>You can use temporary credentials for single sign-on (SSO) to the console.</p>
694689
* <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
695690
* this operation. You can pass a single JSON policy document to use as an inline session
696691
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
2828

2929
/**
3030
* <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
31-
* resources that you might not normally have access to. These temporary credentials consist
32-
* of an access key ID, a secret access key, and a security token. Typically, you use
33-
* <code>AssumeRole</code> within your account or for cross-account access. For a
34-
* comparison of <code>AssumeRole</code> with other API operations that produce temporary
35-
* credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
31+
* resources. These temporary credentials consist of an access key ID, a secret access key,
32+
* and a security token. Typically, you use <code>AssumeRole</code> within your account or for
33+
* cross-account access. For a comparison of <code>AssumeRole</code> with other API operations
34+
* that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
3635
* Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
3736
* Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
3837
* <p>
@@ -82,7 +81,6 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
8281
* additional identity-based policy is required. For more information about trust policies and
8382
* resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the
8483
* <i>IAM User Guide</i>.</p>
85-
*
8684
* <p>
8785
* <b>Tags</b>
8886
* </p>

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,13 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
108108
* characters and the values can’t exceed 256 characters. For these and additional limits, see
109109
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
110110
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
111-
*
112111
* <note>
113112
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
114113
* and session tags into a packed binary format that has a separate limit. Your request can
115114
* fail for this limit even if your plaintext meets the other requirements. The
116115
* <code>PackedPolicySize</code> response element indicates by percentage how close the
117116
* policies and tags for your request are to the upper size limit.</p>
118117
* </note>
119-
*
120118
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
121119
* you do, session tags override the role's tags with the same key.</p>
122120
* <p>An administrator must grant you the permissions necessary to pass session tags. The

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,13 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
100100
* characters and the values can’t exceed 256 characters. For these and additional limits, see
101101
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
102102
* and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
103-
*
104103
* <note>
105104
* <p>An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs,
106105
* and session tags into a packed binary format that has a separate limit. Your request can
107106
* fail for this limit even if your plaintext meets the other requirements. The
108107
* <code>PackedPolicySize</code> response element indicates by percentage how close the
109108
* policies and tags for your request are to the upper size limit.</p>
110109
* </note>
111-
*
112110
* <p>You can pass a session tag with the same key as a tag that is attached to the role. When
113111
* you do, the session tag overrides the role tag with the same key.</p>
114112
* <p>An administrator must grant you the permissions necessary to pass session tags. The

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,16 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
6464
* <b>Permissions</b>
6565
* </p>
6666
* <p>You can use the temporary credentials created by <code>GetFederationToken</code> in any
67-
* Amazon Web Services service except the following:</p>
67+
* Amazon Web Services service with the following exceptions:</p>
6868
* <ul>
6969
* <li>
70-
* <p>You cannot call any IAM operations using the CLI or the Amazon Web Services API. </p>
70+
* <p>You cannot call any IAM operations using the CLI or the Amazon Web Services API. This limitation does not apply to console sessions.</p>
7171
* </li>
7272
* <li>
7373
* <p>You cannot call any STS operations except <code>GetCallerIdentity</code>.</p>
7474
* </li>
7575
* </ul>
76+
* <p>You can use temporary credentials for single sign-on (SSO) to the console.</p>
7677
* <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
7778
* this operation. You can pass a single JSON policy document to use as an inline session
7879
* policy. You can also specify up to 10 managed policy Amazon Resource Names (ARNs) to use as

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

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
66
or see "smithy.rules#endpointRuleSet"
77
in codegen/sdk-codegen/aws-models/sts.json */
88

9-
const H="required",
9+
const G="required",
10+
H="type",
1011
I="fn",
1112
J="argv",
1213
K="ref",
@@ -18,32 +19,31 @@ c="PartitionResult",
1819
d="tree",
1920
e="booleanEquals",
2021
f="stringEquals",
21-
g="https://sts.amazonaws.com",
22-
h="sigv4",
22+
g="sigv4",
23+
h="us-east-1",
2324
i="sts",
24-
j="us-east-1",
25-
k="endpoint",
26-
l="https://sts.{Region}.{PartitionResult#dnsSuffix}",
27-
m="error",
28-
n="getAttr",
29-
o={[H]:false,"type":"String"},
30-
p={[H]:true,"default":false,"type":"Boolean"},
31-
q={[K]:"Region"},
32-
r={[K]:"UseFIPS"},
33-
s={[K]:"UseDualStack"},
34-
t={[I]:"isSet",[J]:[{[K]:"Endpoint"}]},
35-
u={[K]:"Endpoint"},
36-
v={"url":g,[L]:{"authSchemes":[{"name":h,"signingName":i,"signingRegion":j}]},[M]:{}},
37-
w={},
38-
x={[I]:e,[J]:[r,true]},
39-
y={[I]:e,[J]:[s,true]},
40-
z={[I]:e,[J]:[true,{[I]:n,[J]:[{[K]:c},"supportsFIPS"]}]},
25+
j="endpoint",
26+
k="https://sts.{Region}.{PartitionResult#dnsSuffix}",
27+
l="error",
28+
m="getAttr",
29+
n={[G]:false,[H]:"String"},
30+
o={[G]:true,"default":false,[H]:"Boolean"},
31+
p={[K]:"Region"},
32+
q={[K]:"UseFIPS"},
33+
r={[K]:"UseDualStack"},
34+
s={[I]:"isSet",[J]:[{[K]:"Endpoint"}]},
35+
t={[K]:"Endpoint"},
36+
u={"url":"https://sts.amazonaws.com",[L]:{"authSchemes":[{"name":g,"signingRegion":h,"signingName":i}]},[M]:{}},
37+
v={},
38+
w={"conditions":[{[I]:f,[J]:[p,"aws-global"]}],[j]:u,[H]:j},
39+
x={[I]:e,[J]:[q,true]},
40+
y={[I]:e,[J]:[r,true]},
41+
z={[I]:e,[J]:[true,{[I]:m,[J]:[{[K]:c},"supportsFIPS"]}]},
4142
A={[K]:c},
42-
B={[I]:e,[J]:[true,{[I]:n,[J]:[A,"supportsDualStack"]}]},
43-
C={"url":l,[L]:{},[M]:{}},
44-
D=[u],
45-
E=[{[I]:f,[J]:[q,"aws-global"]}],
46-
F=[x],
47-
G=[y];
48-
const _data={version:"1.0",parameters:{Region:o,UseDualStack:p,UseFIPS:p,Endpoint:o,UseGlobalEndpoint:p},rules:[{conditions:[{[I]:"aws.partition",[J]:[q],assign:c}],type:d,rules:[{conditions:[{[I]:e,[J]:[{[K]:"UseGlobalEndpoint"},b]},{[I]:e,[J]:[r,a]},{[I]:e,[J]:[s,a]},{[I]:"not",[J]:[t]}],type:d,rules:[{conditions:[{[I]:f,[J]:[q,"ap-northeast-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"ap-south-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"ap-southeast-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"ap-southeast-2"]}],endpoint:v,type:k},{conditions:E,endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"ca-central-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"eu-central-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"eu-north-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"eu-west-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"eu-west-2"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"eu-west-3"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"sa-east-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,j]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"us-east-2"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"us-west-1"]}],endpoint:v,type:k},{conditions:[{[I]:f,[J]:[q,"us-west-2"]}],endpoint:v,type:k},{endpoint:{url:l,[L]:{authSchemes:[{name:h,signingName:i,signingRegion:"{Region}"}]},[M]:w},type:k}]},{conditions:[t,{[I]:"parseURL",[J]:D,assign:"url"}],type:d,rules:[{conditions:F,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:m},{type:d,rules:[{conditions:G,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:m},{endpoint:{url:u,[L]:w,[M]:w},type:k}]}]},{conditions:[x,y],type:d,rules:[{conditions:[z,B],type:d,rules:[{endpoint:{url:"https://sts-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[L]:w,[M]:w},type:k}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:m}]},{conditions:F,type:d,rules:[{conditions:[z],type:d,rules:[{type:d,rules:[{conditions:[{[I]:f,[J]:["aws-us-gov",{[I]:n,[J]:[A,"name"]}]}],endpoint:C,type:k},{endpoint:{url:"https://sts-fips.{Region}.{PartitionResult#dnsSuffix}",[L]:w,[M]:w},type:k}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:m}]},{conditions:G,type:d,rules:[{conditions:[B],type:d,rules:[{endpoint:{url:"https://sts.{Region}.{PartitionResult#dualStackDnsSuffix}",[L]:w,[M]:w},type:k}]},{error:"DualStack is enabled but this partition does not support DualStack",type:m}]},{type:d,rules:[{conditions:E,endpoint:{url:g,[L]:{authSchemes:[{name:h,signingRegion:j,signingName:i}]},[M]:w},type:k},{endpoint:C,type:k}]}]}]};
43+
B={[I]:e,[J]:[true,{[I]:m,[J]:[A,"supportsDualStack"]}]},
44+
C={"url":k,[L]:{},[M]:{}},
45+
D=[t],
46+
E=[x],
47+
F=[y];
48+
const _data={version:"1.0",parameters:{Region:n,UseDualStack:o,UseFIPS:o,Endpoint:n,UseGlobalEndpoint:o},rules:[{conditions:[{[I]:"aws.partition",[J]:[p],assign:c}],[H]:d,rules:[{conditions:[{[I]:e,[J]:[{[K]:"UseGlobalEndpoint"},b]},{[I]:e,[J]:[q,a]},{[I]:e,[J]:[r,a]},{[I]:"not",[J]:[s]}],[H]:d,rules:[{conditions:[{[I]:f,[J]:[p,"ap-northeast-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"ap-south-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"ap-southeast-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"ap-southeast-2"]}],endpoint:u,[H]:j},w,{conditions:[{[I]:f,[J]:[p,"ca-central-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"eu-central-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"eu-north-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"eu-west-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"eu-west-2"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"eu-west-3"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"sa-east-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,h]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"us-east-2"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"us-west-1"]}],endpoint:u,[H]:j},{conditions:[{[I]:f,[J]:[p,"us-west-2"]}],endpoint:u,[H]:j},{endpoint:{url:k,[L]:{authSchemes:[{name:g,signingRegion:"{Region}",signingName:i}]},[M]:v},[H]:j}]},{conditions:[s,{[I]:"parseURL",[J]:D,assign:"url"}],[H]:d,rules:[{conditions:E,error:"Invalid Configuration: FIPS and custom endpoint are not supported",[H]:l},{[H]:d,rules:[{conditions:F,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",[H]:l},{endpoint:{url:t,[L]:v,[M]:v},[H]:j}]}]},{conditions:[x,y],[H]:d,rules:[{conditions:[z,B],[H]:d,rules:[{endpoint:{url:"https://sts-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",[L]:v,[M]:v},[H]:j}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",[H]:l}]},{conditions:E,[H]:d,rules:[{conditions:[z],[H]:d,rules:[{[H]:d,rules:[{conditions:[{[I]:f,[J]:["aws-us-gov",{[I]:m,[J]:[A,"name"]}]}],endpoint:C,[H]:j},{endpoint:{url:"https://sts-fips.{Region}.{PartitionResult#dnsSuffix}",[L]:v,[M]:v},[H]:j}]}]},{error:"FIPS is enabled but this partition does not support FIPS",[H]:l}]},{conditions:F,[H]:d,rules:[{conditions:[B],[H]:d,rules:[{endpoint:{url:"https://sts.{Region}.{PartitionResult#dualStackDnsSuffix}",[L]:v,[M]:v},[H]:j}]},{error:"DualStack is enabled but this partition does not support DualStack",[H]:l}]},{[H]:d,rules:[w,{endpoint:C,[H]:j}]}]}]};
4949
export const ruleSet: RuleSetObject = _data;

0 commit comments

Comments
 (0)