@aws-sdk/client-sts 3.40.0 → 3.45.0

package/dist-types/models/models_0.d.ts

@@ -43,7 +43,7 @@ export declare namespace PolicyDescriptorType {
 /**
  * <p>You can pass custom key-value pair attributes when you assume a role or federate a user.
  *          These are called session tags. You can then use the session tags to control access to
- *          resources. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Tagging STS Sessions</a> in the
+ *          resources. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Tagging Amazon Web Services STS Sessions</a> in the
  *             <i>IAM User Guide</i>.</p>
  */
 export interface Tag {
@@ -93,6 +93,7 @@ export interface AssumeRoleRequest {
      *          plaintext that you use for both inline and managed session policies can't exceed 2,048
      *          characters. 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
      *             Service Namespaces</a> in the Amazon Web Services General Reference.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -127,6 +128,7 @@ export interface AssumeRoleRequest {
      *          character to the end of the valid character list (\u0020 through \u00FF). It can also
      *          include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
      *          characters.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -138,13 +140,19 @@ export interface AssumeRoleRequest {
      */
     Policy?: string;
     /**
-     * <p>The duration, in seconds, of the role session. The value specified can can range from
-     *          900 seconds (15 minutes) up to the maximum session duration that is set for the role. The
-     *          maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a
-     *          value higher than this setting or the administrator setting (whichever is lower), the
-     *          operation fails. For example, if you specify a session duration of 12 hours, but your
-     *          administrator set the maximum session duration to 6 hours, your operation fails. To learn
-     *          how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the
+     * <p>The duration, in seconds, of the role session. The value specified can range from 900
+     *          seconds (15 minutes) up to the maximum session duration set for the role. The maximum
+     *          session duration setting can have a value from 1 hour to 12 hours. If you specify a value
+     *          higher than this setting or the administrator setting (whichever is lower), the operation
+     *          fails. For example, if you specify a session duration of 12 hours, but your administrator
+     *          set the maximum session duration to 6 hours, your operation fails. </p>
+     *          <p>Role chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour.
+     *          When you use the <code>AssumeRole</code> API operation to assume a role, you can specify
+     *          the duration of your role session with the <code>DurationSeconds</code> parameter. You can
+     *          specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum
+     *          session duration setting for your role. However, if you assume a role using role chaining
+     *          and provide a <code>DurationSeconds</code> parameter value greater than one hour, the
+     *          operation fails. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the
      *             Maximum Session Duration Setting for a Role</a> in the
      *             <i>IAM User Guide</i>.</p>
      *          <p>By default, the value is set to <code>3600</code> seconds. </p>
@@ -154,14 +162,14 @@ export interface AssumeRoleRequest {
      *             federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
      *             parameter that specifies the maximum length of the console session. For more
      *             information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
-     *                that Enables Federated Users to Access the Management Console</a> in the
+     *                that Enables Federated Users to Access the Amazon Web Services Management Console</a> in the
      *                <i>IAM User Guide</i>.</p>
      *          </note>
      */
     DurationSeconds?: number;
     /**
      * <p>A list of session tags that you want to pass. Each session tag consists of a key name
-     *          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 STS
+     *          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
      *             Sessions</a> in the <i>IAM User Guide</i>.</p>
      *          <p>This parameter is optional. You can pass up to 50 session tags. The plaintext session
      *          tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these
@@ -176,8 +184,9 @@ export interface AssumeRoleRequest {
      *             request are to the upper size limit.
      *             </p>
      *          </note>
-     *          <p>You can pass a session tag with the same key as a tag that is already
-     *          attached to the role. When you do, session tags override a role tag with the same key. </p>
+     *
+     *          <p>You can pass a session tag with the same key as a tag that is already attached to the
+     *          role. When you do, session tags override a role tag with the same key. </p>
      *          <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
      *          cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
      *          that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the
@@ -253,8 +262,7 @@ export interface AssumeRoleRequest {
      *          <p>The regex used to validate this parameter is a string of characters consisting of upper-
      *          and lower-case alphanumeric characters with no spaces. You can also include underscores or
      *          any of the following characters: =,.@-. You cannot use a value that begins with the text
-     *          <code>aws:</code>. This prefix is reserved for Amazon Web Services internal
-     *          use.</p>
+     *             <code>aws:</code>. This prefix is reserved for Amazon Web Services internal use.</p>
      */
     SourceIdentity?: string;
 }
@@ -300,6 +308,7 @@ export interface AssumeRoleResponse {
     /**
      * <p>The temporary security credentials, which include an access key ID, a secret access key,
      *          and a security (or session) token.</p>
+     *
      *          <note>
      *             <p>The size of the security token that STS API operations return is not fixed. We
      *         strongly recommend that you make no assumptions about the maximum size.</p>
@@ -381,7 +390,7 @@ export declare namespace MalformedPolicyDocumentException {
  *             tags are to the upper size limit. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Passing Session Tags in STS</a> in
  *             the <i>IAM User Guide</i>.</p>
  *         <p>You could receive this error even though you meet other defined session policy and
- *             session tag limits. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">IAM and STS Entity
+ *             session tag limits. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-limits-entity-length">IAM and STS Entity
  *                 Character Limits</a> in the <i>IAM User Guide</i>.</p>
  */
 export interface PackedPolicyTooLargeException extends __SmithyException, $MetadataBearer {
@@ -436,6 +445,7 @@ export interface AssumeRoleWithSAMLRequest {
      *          plaintext that you use for both inline and managed session policies can't exceed 2,048
      *          characters. 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
      *             Service Namespaces</a> in the Amazon Web Services General Reference.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -470,6 +480,7 @@ export interface AssumeRoleWithSAMLRequest {
      *          character to the end of the valid character list (\u0020 through \u00FF). It can also
      *          include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
      *          characters.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -499,7 +510,7 @@ export interface AssumeRoleWithSAMLRequest {
      *             federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
      *             parameter that specifies the maximum length of the console session. For more
      *             information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
-     *                that Enables Federated Users to Access the Management Console</a> in the
+     *                that Enables Federated Users to Access the Amazon Web Services Management Console</a> in the
      *                <i>IAM User Guide</i>.</p>
      *          </note>
      */
@@ -519,6 +530,7 @@ export interface AssumeRoleWithSAMLResponse {
     /**
      * <p>The temporary security credentials, which include an access key ID, a secret access key,
      *          and a security (or session) token.</p>
+     *
      *          <note>
      *             <p>The size of the security token that STS API operations return is not fixed. We
      *         strongly recommend that you make no assumptions about the maximum size.</p>
@@ -678,6 +690,7 @@ export interface AssumeRoleWithWebIdentityRequest {
      *          plaintext that you use for both inline and managed session policies can't exceed 2,048
      *          characters. 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
      *             Service Namespaces</a> in the Amazon Web Services General Reference.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -712,6 +725,7 @@ export interface AssumeRoleWithWebIdentityRequest {
      *          character to the end of the valid character list (\u0020 through \u00FF). It can also
      *          include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
      *          characters.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -738,7 +752,7 @@ export interface AssumeRoleWithWebIdentityRequest {
      *             federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
      *             parameter that specifies the maximum length of the console session. For more
      *             information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
-     *                that Enables Federated Users to Access the Management Console</a> in the
+     *                that Enables Federated Users to Access the Amazon Web Services Management Console</a> in the
      *                <i>IAM User Guide</i>.</p>
      *          </note>
      */
@@ -758,6 +772,7 @@ export interface AssumeRoleWithWebIdentityResponse {
     /**
      * <p>The temporary security credentials, which include an access key ID, a secret access key,
      *          and a security token.</p>
+     *
      *          <note>
      *             <p>The size of the security token that STS API operations return is not fixed. We
      *         strongly recommend that you make no assumptions about the maximum size.</p>
@@ -863,7 +878,7 @@ export declare namespace DecodeAuthorizationMessageRequest {
  */
 export interface DecodeAuthorizationMessageResponse {
     /**
-     * <p>An XML document that contains the decoded message.</p>
+     * <p>The API returns a response with the decoded message.</p>
      */
     DecodedMessage?: string;
 }
@@ -892,8 +907,8 @@ export declare namespace InvalidAuthorizationMessageException {
 export interface GetAccessKeyInfoRequest {
     /**
      * <p>The identifier of an access key.</p>
-     *         <p>This parameter allows (through its regex pattern) a string of characters that can
-     *             consist of any upper- or lowercase letter or digit.</p>
+     *          <p>This parameter allows (through its regex pattern) a string of characters that can
+     *          consist of any upper- or lowercase letter or digit.</p>
      */
     AccessKeyId: string | undefined;
 }
@@ -985,6 +1000,7 @@ export interface GetFederationTokenRequest {
      *          character to the end of the valid character list (\u0020 through \u00FF). It can also
      *          include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
      *          characters.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -1005,7 +1021,8 @@ export interface GetFederationTokenRequest {
      *          The plaintext that you use for both inline and managed session policies can't exceed 2,048
      *          characters. You can provide up to 10 managed policy ARNs. 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 Service Namespaces</a> in the Amazon Web Services General Reference.</p>
+     *             Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the
+     *          Amazon Web Services General Reference.</p>
      *          <p>This parameter is optional. However, if you do not pass any session policies, then the
      *          resulting federated user session has no permissions.</p>
      *          <p>When you pass session policies, the session permissions are the intersection of the
@@ -1019,6 +1036,7 @@ export interface GetFederationTokenRequest {
      *             <code>Principal</code> element of the policy, the session has the permissions allowed by
      *          the policy. These permissions are granted in addition to the permissions that are granted
      *          by the session policies.</p>
+     *
      *          <note>
      *             <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
      *             packed binary format that has a separate limit. Your request can fail for this limit
@@ -1055,9 +1073,9 @@ export interface GetFederationTokenRequest {
      *             request are to the upper size limit.
      *             </p>
      *          </note>
-     *          <p>You can pass a session tag with the same key as a tag that is already
-     *          attached to the user you are federating. When you do, session tags override a user tag with
-     *          the same key. </p>
+     *
+     *          <p>You can pass a session tag with the same key as a tag that is already attached to the
+     *          user you are federating. When you do, session tags override a user tag with the same key. </p>
      *          <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
      *          cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
      *          that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the
@@ -1103,6 +1121,7 @@ export interface GetFederationTokenResponse {
     /**
      * <p>The temporary security credentials, which include an access key ID, a secret access key,
      *          and a security (or session) token.</p>
+     *
      *          <note>
      *             <p>The size of the security token that STS API operations return is not fixed. We
      *         strongly recommend that you make no assumptions about the maximum size.</p>
@@ -1131,34 +1150,34 @@ export declare namespace GetFederationTokenResponse {
 }
 export interface GetSessionTokenRequest {
     /**
-     * <p>The duration, in seconds, that the credentials should remain valid. Acceptable
-     *             durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds
-     *             (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account
-     *             owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is
-     *             longer than one hour, the session for Amazon Web Services account owners defaults to one hour.</p>
+     * <p>The duration, in seconds, that the credentials should remain valid. Acceptable durations
+     *          for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours),
+     *          with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account owners are
+     *          restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one
+     *          hour, the session for Amazon Web Services account owners defaults to one hour.</p>
      */
     DurationSeconds?: number;
     /**
      * <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 if the IAM user
-     *             has a policy that requires MFA authentication. The value is either the serial number for
-     *             a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN)
-     *             for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can
-     *             find the device for an IAM user by going to the Management Console and viewing the user's
-     *             security credentials. </p>
-     *         <p>The regex used to validate this parameter is a string of
+     *          is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a
+     *          policy that requires MFA authentication. The value is either the serial number for a
+     *          hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a
+     *          virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the
+     *          device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security
+     *          credentials. </p>
+     *          <p>The regex used to validate this parameter is a string of
      *     characters consisting of upper- and lower-case alphanumeric characters with no spaces.
      *     You can also include underscores or any of the following characters: =,.@:/-</p>
      */
     SerialNumber?: string;
     /**
      * <p>The value provided by the MFA device, if MFA is required. If any policy requires the
-     *             IAM user to submit an MFA code, specify this value. If MFA authentication is required,
-     *             the user must provide a code when requesting a set of temporary security credentials. A
-     *             user who fails to provide the code receives an "access denied" response when requesting
-     *             resources that require MFA authentication.</p>
-     *         <p>The format for this parameter, as described by its regex pattern, is a sequence of six
-     *             numeric digits.</p>
+     *          IAM user to submit an MFA code, specify this value. If MFA authentication is required,
+     *          the user must provide a code when requesting a set of temporary security credentials. A
+     *          user who fails to provide the code receives an "access denied" response when requesting
+     *          resources that require MFA authentication.</p>
+     *          <p>The format for this parameter, as described by its regex pattern, is a sequence of six
+     *          numeric digits.</p>
      */
     TokenCode?: string;
 }
@@ -1174,8 +1193,8 @@ export declare namespace GetSessionTokenRequest {
  */
 export interface GetSessionTokenResponse {
     /**
-     * <p>The temporary security credentials, which include an access key ID, a secret access
-     *             key, and a security (or session) token.</p>
+     * <p>The temporary security credentials, which include an access key ID, a secret access key,
+     *          and a security (or session) token.</p>
      *
      *          <note>
      *             <p>The size of the security token that STS API operations return is not fixed. We

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sts",
   "description": "AWS SDK for JavaScript Sts Client for Node.js, Browser and React Native",
-  "version": "3.40.0",
+  "version": "3.45.0",
   "scripts": {
     "build": "yarn build:cjs && yarn build:es && yarn build:types",
     "build:cjs": "tsc -p tsconfig.json",
@@ -21,8 +21,8 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/config-resolver": "3.40.0",
-    "@aws-sdk/credential-provider-node": "3.40.0",
+    "@aws-sdk/config-resolver": "3.45.0",
+    "@aws-sdk/credential-provider-node": "3.45.0",
     "@aws-sdk/fetch-http-handler": "3.40.0",
     "@aws-sdk/hash-node": "3.40.0",
     "@aws-sdk/invalid-dependency": "3.40.0",
@@ -30,15 +30,15 @@
     "@aws-sdk/middleware-host-header": "3.40.0",
     "@aws-sdk/middleware-logger": "3.40.0",
     "@aws-sdk/middleware-retry": "3.40.0",
-    "@aws-sdk/middleware-sdk-sts": "3.40.0",
+    "@aws-sdk/middleware-sdk-sts": "3.45.0",
     "@aws-sdk/middleware-serde": "3.40.0",
-    "@aws-sdk/middleware-signing": "3.40.0",
+    "@aws-sdk/middleware-signing": "3.45.0",
     "@aws-sdk/middleware-stack": "3.40.0",
     "@aws-sdk/middleware-user-agent": "3.40.0",
     "@aws-sdk/node-config-provider": "3.40.0",
     "@aws-sdk/node-http-handler": "3.40.0",
     "@aws-sdk/protocol-http": "3.40.0",
-    "@aws-sdk/smithy-client": "3.40.0",
+    "@aws-sdk/smithy-client": "3.41.0",
     "@aws-sdk/types": "3.40.0",
     "@aws-sdk/url-parser": "3.40.0",
     "@aws-sdk/util-base64-browser": "3.37.0",