Skip to content

Commit 3ea4627

Browse files
author
awstools
committedJan 10, 2025
docs(client-sts): Fixed typos in the descriptions.
1 parent 05635df commit 3ea4627

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed
 

Diff for: ‎clients/client-sts/src/commands/AssumeRootCommand.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ export interface AssumeRootCommandInput extends AssumeRootRequest {}
2828
export interface AssumeRootCommandOutput extends AssumeRootResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a set of short term credentials you can use to perform privileged tasks in a
32-
* member account.</p>
33-
* <p>Before you can launch a privileged session, you must have enabled centralized root
34-
* access in your organization. For steps to enable this feature, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html">Centralize root access for member accounts</a> in the <i>IAM User
35-
* Guide</i>.</p>
31+
* <p>Returns a set of short term credentials you can use to perform privileged tasks on a
32+
* member account in your organization.</p>
33+
* <p>Before you can launch a privileged session, you must have centralized root access in
34+
* your organization. For steps to enable this feature, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html">Centralize root access for
35+
* member accounts</a> in the <i>IAM User Guide</i>.</p>
3636
* <note>
37-
* <p>The global endpoint is not supported for AssumeRoot. You must send this request to a
38-
* Regional STS endpoint. For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html#sts-endpoints">Endpoints</a>.</p>
37+
* <p>The STS global endpoint is not supported for AssumeRoot. You must send this request
38+
* to a Regional STS endpoint. For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html#sts-endpoints">Endpoints</a>.</p>
3939
* </note>
4040
* <p>You can track AssumeRoot in CloudTrail logs to determine what actions were performed in a
4141
* session. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-track-privileged-tasks.html">Track privileged tasks

Diff for: ‎clients/client-sts/src/models/models_0.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ export interface AssumeRoleRequest {
303303
* <i>IAM User Guide</i>.</p>
304304
* <p>The regex used to validate this parameter is a string of characters consisting of upper-
305305
* and lower-case alphanumeric characters with no spaces. You can also include underscores or
306-
* any of the following characters: =,.@-. You cannot use a value that begins with the text
306+
* any of the following characters: +=,.@-. You cannot use a value that begins with the text
307307
* <code>aws:</code>. This prefix is reserved for Amazon Web Services internal use.</p>
308308
* @public
309309
*/
@@ -806,8 +806,8 @@ export interface AssumeRoleWithWebIdentityRequest {
806806
* provider. Your application must get this token by authenticating the user who is using your
807807
* application with a web identity provider before the application makes an
808808
* <code>AssumeRoleWithWebIdentity</code> call. Timestamps in the token must be formatted
809-
* as either an integer or a long integer. Only tokens with RSA algorithms (RS256) are
810-
* supported.</p>
809+
* as either an integer or a long integer. Tokens must be signed using either RSA keys (RS256,
810+
* RS384, or RS512) or ECDSA keys (ES256, ES384, or ES512).</p>
811811
* @public
812812
*/
813813
WebIdentityToken: string | undefined;
@@ -1023,9 +1023,8 @@ export interface AssumeRootRequest {
10231023

10241024
/**
10251025
* <p>The identity based policy that scopes the session to the privileged tasks that can be
1026-
* performed. You can use one of following Amazon Web Services managed policies to scope
1027-
* root session actions. You can add additional customer managed policies to further limit the
1028-
* permissions for the root session.</p>
1026+
* performed. You can use one of following Amazon Web Services managed policies to scope root session
1027+
* actions.</p>
10291028
* <ul>
10301029
* <li>
10311030
* <p>

Diff for: ‎codegen/sdk-codegen/aws-models/sts.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -2383,7 +2383,7 @@
23832383
"SourceIdentity": {
23842384
"target": "com.amazonaws.sts#sourceIdentityType",
23852385
"traits": {
2386-
"smithy.api#documentation": "<p>The source identity specified by the principal that is calling the\n <code>AssumeRole</code> operation. The source identity value persists across <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html#iam-term-role-chaining\">chained role</a> sessions.</p>\n <p>You can require users to specify a source identity when they assume a role. You do this\n by using the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceidentity\">\n <code>sts:SourceIdentity</code>\n </a> condition key in a role trust policy. You\n can use source identity information in CloudTrail logs to determine who took actions with a\n role. You can use the <code>aws:SourceIdentity</code> condition key to further control\n access to Amazon Web Services resources based on the value of source identity. For more information about\n using source identity, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html\">Monitor and control\n actions taken with assumed roles</a> in the\n <i>IAM User Guide</i>.</p>\n <p>The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: =,.@-. You cannot use a value that begins with the text\n <code>aws:</code>. This prefix is reserved for Amazon Web Services internal use.</p>"
2386+
"smithy.api#documentation": "<p>The source identity specified by the principal that is calling the\n <code>AssumeRole</code> operation. The source identity value persists across <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html#iam-term-role-chaining\">chained role</a> sessions.</p>\n <p>You can require users to specify a source identity when they assume a role. You do this\n by using the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceidentity\">\n <code>sts:SourceIdentity</code>\n </a> condition key in a role trust policy. You\n can use source identity information in CloudTrail logs to determine who took actions with a\n role. You can use the <code>aws:SourceIdentity</code> condition key to further control\n access to Amazon Web Services resources based on the value of source identity. For more information about\n using source identity, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html\">Monitor and control\n actions taken with assumed roles</a> in the\n <i>IAM User Guide</i>.</p>\n <p>The regex used to validate this parameter is a string of characters consisting of upper-\n and lower-case alphanumeric characters with no spaces. You can also include underscores or\n any of the following characters: +=,.@-. You cannot use a value that begins with the text\n <code>aws:</code>. This prefix is reserved for Amazon Web Services internal use.</p>"
23872387
}
23882388
},
23892389
"ProvidedContexts": {
@@ -2687,7 +2687,7 @@
26872687
"WebIdentityToken": {
26882688
"target": "com.amazonaws.sts#clientTokenType",
26892689
"traits": {
2690-
"smithy.api#documentation": "<p>The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n provider. Your application must get this token by authenticating the user who is using your\n application with a web identity provider before the application makes an\n <code>AssumeRoleWithWebIdentity</code> call. Timestamps in the token must be formatted\n as either an integer or a long integer. Only tokens with RSA algorithms (RS256) are\n supported.</p>",
2690+
"smithy.api#documentation": "<p>The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n provider. Your application must get this token by authenticating the user who is using your\n application with a web identity provider before the application makes an\n <code>AssumeRoleWithWebIdentity</code> call. Timestamps in the token must be formatted\n as either an integer or a long integer. Tokens must be signed using either RSA keys (RS256,\n RS384, or RS512) or ECDSA keys (ES256, ES384, or ES512).</p>",
26912691
"smithy.api#required": {}
26922692
}
26932693
},
@@ -2788,7 +2788,7 @@
27882788
}
27892789
],
27902790
"traits": {
2791-
"smithy.api#documentation": "<p>Returns a set of short term credentials you can use to perform privileged tasks in a\n member account.</p>\n <p>Before you can launch a privileged session, you must have enabled centralized root\n access in your organization. For steps to enable this feature, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html\">Centralize root access for member accounts</a> in the <i>IAM User\n Guide</i>.</p>\n <note>\n <p>The global endpoint is not supported for AssumeRoot. You must send this request to a\n Regional STS endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html#sts-endpoints\">Endpoints</a>.</p>\n </note>\n <p>You can track AssumeRoot in CloudTrail logs to determine what actions were performed in a\n session. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-track-privileged-tasks.html\">Track privileged tasks\n in CloudTrail</a> in the <i>IAM User Guide</i>.</p>",
2791+
"smithy.api#documentation": "<p>Returns a set of short term credentials you can use to perform privileged tasks on a\n member account in your organization.</p>\n <p>Before you can launch a privileged session, you must have centralized root access in\n your organization. For steps to enable this feature, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html\">Centralize root access for\n member accounts</a> in the <i>IAM User Guide</i>.</p>\n <note>\n <p>The STS global endpoint is not supported for AssumeRoot. You must send this request\n to a Regional STS endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html#sts-endpoints\">Endpoints</a>.</p>\n </note>\n <p>You can track AssumeRoot in CloudTrail logs to determine what actions were performed in a\n session. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-track-privileged-tasks.html\">Track privileged tasks\n in CloudTrail</a> in the <i>IAM User Guide</i>.</p>",
27922792
"smithy.api#examples": [
27932793
{
27942794
"title": "To launch a privileged session",
@@ -2826,7 +2826,7 @@
28262826
"TaskPolicyArn": {
28272827
"target": "com.amazonaws.sts#PolicyDescriptorType",
28282828
"traits": {
2829-
"smithy.api#documentation": "<p>The identity based policy that scopes the session to the privileged tasks that can be\n performed. You can use one of following Amazon Web Services managed policies to scope\n root session actions. You can add additional customer managed policies to further limit the\n permissions for the root session.</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMAuditRootUserCredentials\">IAMAuditRootUserCredentials</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMCreateRootUserPassword\">IAMCreateRootUserPassword</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMDeleteRootUserCredentials\">IAMDeleteRootUserCredentials</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-S3UnlockBucketPolicy\">S3UnlockBucketPolicy</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-SQSUnlockQueuePolicy\">SQSUnlockQueuePolicy</a>\n </p>\n </li>\n </ul>",
2829+
"smithy.api#documentation": "<p>The identity based policy that scopes the session to the privileged tasks that can be\n performed. You can use one of following Amazon Web Services managed policies to scope root session\n actions.</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMAuditRootUserCredentials\">IAMAuditRootUserCredentials</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMCreateRootUserPassword\">IAMCreateRootUserPassword</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-IAMDeleteRootUserCredentials\">IAMDeleteRootUserCredentials</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-S3UnlockBucketPolicy\">S3UnlockBucketPolicy</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/security-iam-awsmanpol.html#security-iam-awsmanpol-SQSUnlockQueuePolicy\">SQSUnlockQueuePolicy</a>\n </p>\n </li>\n </ul>",
28302830
"smithy.api#required": {}
28312831
}
28322832
},

0 commit comments

Comments
 (0)
Please sign in to comment.