@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.
@@ -8,23 +8,23 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
8
8
  }
9
9
  /**
10
10
  * <p>Returns the account identifier for the specified access key ID.</p>
11
- * <p>Access keys consist of two parts: an access key ID (for example,
12
- * <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example,
13
- * <code>wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY</code>). For more information about
14
- * access keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">Managing Access Keys for IAM
15
- * Users</a> in the <i>IAM User Guide</i>.</p>
16
- * <p>When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services
17
- * account to which the keys belong. Access key IDs beginning with <code>AKIA</code> are
18
- * long-term credentials for an IAM user or the Amazon Web Services account root user. Access key IDs
19
- * beginning with <code>ASIA</code> are temporary credentials that are created using STS
20
- * operations. If the account in the response belongs to you, you can sign in as the root
21
- * user and review 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 learn which IAM user owns the keys. To learn who
22
- * requested the temporary credentials for an <code>ASIA</code> access key, view the STS
23
- * events in your <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/cloudtrail-integration.html">CloudTrail logs</a> in the
24
- * <i>IAM User Guide</i>.</p>
25
- * <p>This operation does not indicate the state of the access key. The key might be active,
26
- * inactive, or deleted. Active keys might not have permissions to perform an operation.
27
- * Providing a deleted access key might return an error that the key doesn't exist.</p>
11
+ * <p>Access keys consist of two parts: an access key ID (for example,
12
+ * <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example,
13
+ * <code>wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY</code>). For more information about
14
+ * access keys, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">Managing Access Keys for IAM
15
+ * Users</a> in the <i>IAM User Guide</i>.</p>
16
+ * <p>When you pass an access key ID to this operation, it returns the ID of the Amazon Web Services account
17
+ * to which the keys belong. Access key IDs beginning with <code>AKIA</code> are long-term
18
+ * credentials for an IAM user or the Amazon Web Services account root user. Access key IDs beginning with
19
+ * <code>ASIA</code> are temporary credentials that are created using STS operations. If
20
+ * the account in the response belongs to you, you can sign in as the root user and review
21
+ * 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
22
+ * learn which IAM user owns the keys. To learn who requested the temporary credentials for
23
+ * 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
24
+ * <i>IAM User Guide</i>.</p>
25
+ * <p>This operation does not indicate the state of the access key. The key might be active,
26
+ * inactive, or deleted. Active keys might not have permissions to perform an operation.
27
+ * Providing a deleted access key might return an error that the key doesn't exist.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
@@ -37,7 +37,7 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
37
37
  *
38
38
  * @see {@link GetAccessKeyInfoCommandInput} for command's `input` shape.
39
39
  * @see {@link GetAccessKeyInfoCommandOutput} for command's `response` shape.
40
- * @see {@link STSClientResolvedConfig | config} for command's `input` shape.
40
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
41
41
  *
42
42
  */
43
43
  export declare class GetAccessKeyInfoCommand extends $Command<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput, STSClientResolvedConfig> {
@@ -8,15 +8,15 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
8
8
  }
9
9
  /**
10
10
  * <p>Returns details about the IAM user or role whose credentials are used to call the
11
- * operation.</p>
12
- * <note>
11
+ * operation.</p>
12
+ * <note>
13
13
  * <p>No permissions are required to perform this operation. If an administrator adds a
14
- * policy to your IAM user or role that explicitly denies access to the
15
- * <code>sts:GetCallerIdentity</code> action, you can still perform this operation.
16
- * Permissions are not required because the same information is returned when an IAM
17
- * user 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
18
- * <i>IAM User Guide</i>.</p>
19
- * </note>
14
+ * policy to your IAM user or role that explicitly denies access to the
15
+ * <code>sts:GetCallerIdentity</code> action, you can still perform this operation.
16
+ * Permissions are not required because the same information is returned when an IAM user
17
+ * 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
18
+ * <i>IAM User Guide</i>.</p>
19
+ * </note>
20
20
  * @example
21
21
  * Use a bare-bones client and the command you need to make an API call.
22
22
  * ```javascript
@@ -29,7 +29,7 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
29
29
  *
30
30
  * @see {@link GetCallerIdentityCommandInput} for command's `input` shape.
31
31
  * @see {@link GetCallerIdentityCommandOutput} for command's `response` shape.
32
- * @see {@link STSClientResolvedConfig | config} for command's `input` shape.
32
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
33
33
  *
34
34
  */
35
35
  export declare class GetCallerIdentityCommand extends $Command<GetCallerIdentityCommandInput, GetCallerIdentityCommandOutput, STSClientResolvedConfig> {
@@ -16,7 +16,7 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
16
16
  * server-based application. For a comparison of <code>GetFederationToken</code> with the
17
17
  * 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
18
18
  * Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
19
- * STS API operations</a> in the <i>IAM User Guide</i>.</p>
19
+ * Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
20
20
  * <note>
21
21
  * <p>You can create a mobile-based or browser-based app that can authenticate users using
22
22
  * a web identity provider like Login with Amazon, Facebook, Google, or an OpenID
@@ -35,8 +35,8 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
35
35
  * </p>
36
36
  * <p>The temporary credentials are valid for the specified duration, from 900 seconds (15
37
37
  * minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is
38
- * 43,200 seconds (12 hours). Temporary credentials that are obtained by using Amazon Web Services account
39
- * root user credentials have a maximum duration of 3,600 seconds (1 hour).</p>
38
+ * 43,200 seconds (12 hours). Temporary credentials obtained by using the Amazon Web Services account root
39
+ * user credentials have a maximum duration of 3,600 seconds (1 hour).</p>
40
40
  * <p>
41
41
  * <b>Permissions</b>
42
42
  * </p>
@@ -74,78 +74,25 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
74
74
  * <p>(Optional) You can pass tag key-value pairs to your session. These are called session
75
75
  * 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
76
76
  * <i>IAM User Guide</i>.</p>
77
- * <note>
78
- * <p>You can create a mobile-based or browser-based app that can authenticate users
79
- * using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID
80
- * Connect-compatible identity provider. In this case, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or
81
- * <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
82
- * <i>IAM User Guide</i>.</p>
83
- * </note>
84
- * <p>You can also call <code>GetFederationToken</code> using the security credentials of an
85
- * Amazon Web Services account root user, but we do not recommend it. Instead, we recommend that you
86
- * create an IAM user for the purpose of the proxy application. Then attach a policy to
87
- * the IAM user that limits federated users to only the actions and resources that they
88
- * need to access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the
89
- * <i>IAM User Guide</i>. </p>
90
- * <p>
91
- * <b>Session duration</b>
92
- * </p>
93
- * <p>The temporary credentials are valid for the specified duration, from 900 seconds (15
94
- * minutes) up to a maximum of 129,600 seconds (36 hours). The default session duration is
95
- * 43,200 seconds (12 hours). Temporary credentials that are obtained by using Amazon Web Services
96
- * account root user credentials have a maximum duration of 3,600 seconds (1 hour).</p>
97
- * <p>
98
- * <b>Permissions</b>
99
- * </p>
100
- * <p>You can use the temporary credentials created by <code>GetFederationToken</code> in
101
- * any Amazon Web Services service except the following:</p>
102
- * <ul>
103
- * <li>
104
- * <p>You cannot call any IAM operations using the CLI or the Amazon Web Services API.
105
- * </p>
106
- * </li>
107
- * <li>
108
- * <p>You cannot call any STS operations except
109
- * <code>GetCallerIdentity</code>.</p>
110
- * </li>
111
- * </ul>
112
- * <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
113
- * this operation. You can pass a single JSON policy document to use as an inline session
114
- * policy. You can also specify up to 10 managed policies to use as managed session
115
- * policies. The plain text that you use for both inline and managed session policies can't
116
- * exceed 2,048 characters.</p>
117
- * <p>Though the session policy parameters are optional, if you do not pass a policy, then
118
- * the resulting federated user session has no permissions. When you pass session policies,
119
- * the session permissions are the intersection of the IAM user policies and the session
120
- * policies that you pass. This gives you a way to further restrict the permissions for a
121
- * federated user. You cannot use session policies to grant more permissions than those
122
- * that are defined in the permissions policy of the IAM user. For more information, see
123
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a>
124
- * in the <i>IAM User Guide</i>. For information about using
125
- * <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>
126
- * <p>You can use the credentials to access a resource that has a resource-based policy. If
127
- * that policy specifically references the federated user session in the
128
- * <code>Principal</code> element of the policy, the session has the permissions
129
- * allowed by the policy. These permissions are granted in addition to the permissions
130
- * granted by the session policies.</p>
131
- * <p>
132
- * <b>Tags</b>
133
- * </p>
134
- * <p>(Optional) You can pass tag key-value pairs to your session. These are called session
135
- * 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
136
- * the <i>IAM User Guide</i>.</p>
137
- * <p>An administrator must grant you the permissions necessary to pass session tags. The
138
- * administrator can also create granular permissions to allow you to pass only specific
139
- * session tags. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_attribute-based-access-control.html">Tutorial: Using
140
- * Tags for Attribute-Based Access Control</a> in the
141
- * <i>IAM User Guide</i>.</p>
142
- * <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
143
- * cannot have separate <code>Department</code> and <code>department</code> tag keys.
144
- * Assume that the user that you are federating has the
145
- * <code>Department</code>=<code>Marketing</code> tag and you pass the
146
- * <code>department</code>=<code>engineering</code> session tag.
147
- * <code>Department</code> and <code>department</code> are not saved as separate tags,
148
- * and the session tag passed in the request takes precedence over the user tag.</p>
77
+ * <note>
78
+ * <p>You can create a mobile-based or browser-based app that can authenticate users using
79
+ * a web identity provider like Login with Amazon, Facebook, Google, or an OpenID
80
+ * Connect-compatible identity provider. In this case, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or
81
+ * <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
82
+ * <i>IAM User Guide</i>.</p>
83
+ * </note>
84
+ * <p>An administrator must grant you the permissions necessary to pass session tags. The
85
+ * administrator can also create granular permissions to allow you to pass only specific
86
+ * 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
87
+ * for Attribute-Based Access Control</a> in the
88
+ * <i>IAM User Guide</i>.</p>
89
+ * <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
90
+ * cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
91
+ * that the user that you are federating has the
92
+ * <code>Department</code>=<code>Marketing</code> tag and you pass the
93
+ * <code>department</code>=<code>engineering</code> session tag. <code>Department</code>
94
+ * and <code>department</code> are not saved as separate tags, and the session tag passed in
95
+ * the request takes precedence over the user tag.</p>
149
96
  * @example
150
97
  * Use a bare-bones client and the command you need to make an API call.
151
98
  * ```javascript
@@ -158,7 +105,7 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
158
105
  *
159
106
  * @see {@link GetFederationTokenCommandInput} for command's `input` shape.
160
107
  * @see {@link GetFederationTokenCommandOutput} for command's `response` shape.
161
- * @see {@link STSClientResolvedConfig | config} for command's `input` shape.
108
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
162
109
  *
163
110
  */
164
111
  export declare class GetFederationTokenCommand extends $Command<GetFederationTokenCommandInput, GetFederationTokenCommandOutput, STSClientResolvedConfig> {
@@ -18,7 +18,7 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
18
18
  * the API returns an access denied error. For a comparison of <code>GetSessionToken</code>
19
19
  * 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
20
20
  * Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
21
- * STS API operations</a> in the <i>IAM User Guide</i>.</p>
21
+ * Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
22
22
  * <p>
23
23
  * <b>Session Duration</b>
24
24
  * </p>
@@ -71,7 +71,7 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
71
71
  *
72
72
  * @see {@link GetSessionTokenCommandInput} for command's `input` shape.
73
73
  * @see {@link GetSessionTokenCommandOutput} for command's `response` shape.
74
- * @see {@link STSClientResolvedConfig | config} for command's `input` shape.
74
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
75
75
  *
76
76
  */
77
77
  export declare class GetSessionTokenCommand extends $Command<GetSessionTokenCommandInput, GetSessionTokenCommandOutput, STSClientResolvedConfig> {
@@ -43,7 +43,7 @@ export declare namespace PolicyDescriptorType {
43
43
  /**
44
44
  * <p>You can pass custom key-value pair attributes when you assume a role or federate a user.
45
45
  * These are called session tags. You can then use the session tags to control access to
46
- * 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
46
+ * 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
47
47
  * <i>IAM User Guide</i>.</p>
48
48
  */
49
49
  export interface Tag {
@@ -93,6 +93,7 @@ export interface AssumeRoleRequest {
93
93
  * plaintext that you use for both inline and managed session policies can't exceed 2,048
94
94
  * 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
95
95
  * Service Namespaces</a> in the Amazon Web Services General Reference.</p>
96
+ *
96
97
  * <note>
97
98
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
98
99
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -127,6 +128,7 @@ export interface AssumeRoleRequest {
127
128
  * character to the end of the valid character list (\u0020 through \u00FF). It can also
128
129
  * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
129
130
  * characters.</p>
131
+ *
130
132
  * <note>
131
133
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
132
134
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -138,13 +140,19 @@ export interface AssumeRoleRequest {
138
140
  */
139
141
  Policy?: string;
140
142
  /**
141
- * <p>The duration, in seconds, of the role session. The value specified can can range from
142
- * 900 seconds (15 minutes) up to the maximum session duration that is set for the role. The
143
- * maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a
144
- * value higher than this setting or the administrator setting (whichever is lower), the
145
- * operation fails. For example, if you specify a session duration of 12 hours, but your
146
- * administrator set the maximum session duration to 6 hours, your operation fails. To learn
147
- * 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
143
+ * <p>The duration, in seconds, of the role session. The value specified can range from 900
144
+ * seconds (15 minutes) up to the maximum session duration set for the role. The maximum
145
+ * session duration setting can have a value from 1 hour to 12 hours. If you specify a value
146
+ * higher than this setting or the administrator setting (whichever is lower), the operation
147
+ * fails. For example, if you specify a session duration of 12 hours, but your administrator
148
+ * set the maximum session duration to 6 hours, your operation fails. </p>
149
+ * <p>Role chaining limits your Amazon Web Services CLI or Amazon Web Services API role session to a maximum of one hour.
150
+ * When you use the <code>AssumeRole</code> API operation to assume a role, you can specify
151
+ * the duration of your role session with the <code>DurationSeconds</code> parameter. You can
152
+ * specify a parameter value of up to 43200 seconds (12 hours), depending on the maximum
153
+ * session duration setting for your role. However, if you assume a role using role chaining
154
+ * and provide a <code>DurationSeconds</code> parameter value greater than one hour, the
155
+ * 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
148
156
  * Maximum Session Duration Setting for a Role</a> in the
149
157
  * <i>IAM User Guide</i>.</p>
150
158
  * <p>By default, the value is set to <code>3600</code> seconds. </p>
@@ -154,14 +162,14 @@ export interface AssumeRoleRequest {
154
162
  * federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
155
163
  * parameter that specifies the maximum length of the console session. For more
156
164
  * information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
157
- * that Enables Federated Users to Access the Management Console</a> in the
165
+ * that Enables Federated Users to Access the Amazon Web Services Management Console</a> in the
158
166
  * <i>IAM User Guide</i>.</p>
159
167
  * </note>
160
168
  */
161
169
  DurationSeconds?: number;
162
170
  /**
163
171
  * <p>A list of session tags that you want to pass. Each session tag consists of a key name
164
- * 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
172
+ * 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
165
173
  * Sessions</a> in the <i>IAM User Guide</i>.</p>
166
174
  * <p>This parameter is optional. You can pass up to 50 session tags. The plaintext session
167
175
  * tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these
@@ -176,8 +184,9 @@ export interface AssumeRoleRequest {
176
184
  * request are to the upper size limit.
177
185
  * </p>
178
186
  * </note>
179
- * <p>You can pass a session tag with the same key as a tag that is already
180
- * attached to the role. When you do, session tags override a role tag with the same key. </p>
187
+ *
188
+ * <p>You can pass a session tag with the same key as a tag that is already attached to the
189
+ * role. When you do, session tags override a role tag with the same key. </p>
181
190
  * <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
182
191
  * cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
183
192
  * that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the
@@ -253,8 +262,7 @@ export interface AssumeRoleRequest {
253
262
  * <p>The regex used to validate this parameter is a string of characters consisting of upper-
254
263
  * and lower-case alphanumeric characters with no spaces. You can also include underscores or
255
264
  * any of the following characters: =,.@-. You cannot use a value that begins with the text
256
- * <code>aws:</code>. This prefix is reserved for Amazon Web Services internal
257
- * use.</p>
265
+ * <code>aws:</code>. This prefix is reserved for Amazon Web Services internal use.</p>
258
266
  */
259
267
  SourceIdentity?: string;
260
268
  }
@@ -300,6 +308,7 @@ export interface AssumeRoleResponse {
300
308
  /**
301
309
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
302
310
  * and a security (or session) token.</p>
311
+ *
303
312
  * <note>
304
313
  * <p>The size of the security token that STS API operations return is not fixed. We
305
314
  * strongly recommend that you make no assumptions about the maximum size.</p>
@@ -381,7 +390,7 @@ export declare namespace MalformedPolicyDocumentException {
381
390
  * 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
382
391
  * the <i>IAM User Guide</i>.</p>
383
392
  * <p>You could receive this error even though you meet other defined session policy and
384
- * 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
393
+ * 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
385
394
  * Character Limits</a> in the <i>IAM User Guide</i>.</p>
386
395
  */
387
396
  export interface PackedPolicyTooLargeException extends __SmithyException, $MetadataBearer {
@@ -436,6 +445,7 @@ export interface AssumeRoleWithSAMLRequest {
436
445
  * plaintext that you use for both inline and managed session policies can't exceed 2,048
437
446
  * 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
438
447
  * Service Namespaces</a> in the Amazon Web Services General Reference.</p>
448
+ *
439
449
  * <note>
440
450
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
441
451
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -470,6 +480,7 @@ export interface AssumeRoleWithSAMLRequest {
470
480
  * character to the end of the valid character list (\u0020 through \u00FF). It can also
471
481
  * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
472
482
  * characters.</p>
483
+ *
473
484
  * <note>
474
485
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
475
486
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -499,7 +510,7 @@ export interface AssumeRoleWithSAMLRequest {
499
510
  * federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
500
511
  * parameter that specifies the maximum length of the console session. For more
501
512
  * information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
502
- * that Enables Federated Users to Access the Management Console</a> in the
513
+ * that Enables Federated Users to Access the Amazon Web Services Management Console</a> in the
503
514
  * <i>IAM User Guide</i>.</p>
504
515
  * </note>
505
516
  */
@@ -519,6 +530,7 @@ export interface AssumeRoleWithSAMLResponse {
519
530
  /**
520
531
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
521
532
  * and a security (or session) token.</p>
533
+ *
522
534
  * <note>
523
535
  * <p>The size of the security token that STS API operations return is not fixed. We
524
536
  * strongly recommend that you make no assumptions about the maximum size.</p>
@@ -678,6 +690,7 @@ export interface AssumeRoleWithWebIdentityRequest {
678
690
  * plaintext that you use for both inline and managed session policies can't exceed 2,048
679
691
  * 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
680
692
  * Service Namespaces</a> in the Amazon Web Services General Reference.</p>
693
+ *
681
694
  * <note>
682
695
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
683
696
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -712,6 +725,7 @@ export interface AssumeRoleWithWebIdentityRequest {
712
725
  * character to the end of the valid character list (\u0020 through \u00FF). It can also
713
726
  * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
714
727
  * characters.</p>
728
+ *
715
729
  * <note>
716
730
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
717
731
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -738,7 +752,7 @@ export interface AssumeRoleWithWebIdentityRequest {
738
752
  * federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
739
753
  * parameter that specifies the maximum length of the console session. For more
740
754
  * information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
741
- * that Enables Federated Users to Access the Management Console</a> in the
755
+ * that Enables Federated Users to Access the Amazon Web Services Management Console</a> in the
742
756
  * <i>IAM User Guide</i>.</p>
743
757
  * </note>
744
758
  */
@@ -758,6 +772,7 @@ export interface AssumeRoleWithWebIdentityResponse {
758
772
  /**
759
773
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
760
774
  * and a security token.</p>
775
+ *
761
776
  * <note>
762
777
  * <p>The size of the security token that STS API operations return is not fixed. We
763
778
  * strongly recommend that you make no assumptions about the maximum size.</p>
@@ -863,7 +878,7 @@ export declare namespace DecodeAuthorizationMessageRequest {
863
878
  */
864
879
  export interface DecodeAuthorizationMessageResponse {
865
880
  /**
866
- * <p>An XML document that contains the decoded message.</p>
881
+ * <p>The API returns a response with the decoded message.</p>
867
882
  */
868
883
  DecodedMessage?: string;
869
884
  }
@@ -892,8 +907,8 @@ export declare namespace InvalidAuthorizationMessageException {
892
907
  export interface GetAccessKeyInfoRequest {
893
908
  /**
894
909
  * <p>The identifier of an access key.</p>
895
- * <p>This parameter allows (through its regex pattern) a string of characters that can
896
- * consist of any upper- or lowercase letter or digit.</p>
910
+ * <p>This parameter allows (through its regex pattern) a string of characters that can
911
+ * consist of any upper- or lowercase letter or digit.</p>
897
912
  */
898
913
  AccessKeyId: string | undefined;
899
914
  }
@@ -985,6 +1000,7 @@ export interface GetFederationTokenRequest {
985
1000
  * character to the end of the valid character list (\u0020 through \u00FF). It can also
986
1001
  * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
987
1002
  * characters.</p>
1003
+ *
988
1004
  * <note>
989
1005
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
990
1006
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -1005,7 +1021,8 @@ export interface GetFederationTokenRequest {
1005
1021
  * The plaintext that you use for both inline and managed session policies can't exceed 2,048
1006
1022
  * characters. You can provide up to 10 managed policy ARNs. For more information about ARNs,
1007
1023
  * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1008
- * Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the Amazon Web Services General Reference.</p>
1024
+ * Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the
1025
+ * Amazon Web Services General Reference.</p>
1009
1026
  * <p>This parameter is optional. However, if you do not pass any session policies, then the
1010
1027
  * resulting federated user session has no permissions.</p>
1011
1028
  * <p>When you pass session policies, the session permissions are the intersection of the
@@ -1019,6 +1036,7 @@ export interface GetFederationTokenRequest {
1019
1036
  * <code>Principal</code> element of the policy, the session has the permissions allowed by
1020
1037
  * the policy. These permissions are granted in addition to the permissions that are granted
1021
1038
  * by the session policies.</p>
1039
+ *
1022
1040
  * <note>
1023
1041
  * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
1024
1042
  * packed binary format that has a separate limit. Your request can fail for this limit
@@ -1055,9 +1073,9 @@ export interface GetFederationTokenRequest {
1055
1073
  * request are to the upper size limit.
1056
1074
  * </p>
1057
1075
  * </note>
1058
- * <p>You can pass a session tag with the same key as a tag that is already
1059
- * attached to the user you are federating. When you do, session tags override a user tag with
1060
- * the same key. </p>
1076
+ *
1077
+ * <p>You can pass a session tag with the same key as a tag that is already attached to the
1078
+ * user you are federating. When you do, session tags override a user tag with the same key. </p>
1061
1079
  * <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
1062
1080
  * cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
1063
1081
  * that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the
@@ -1103,6 +1121,7 @@ export interface GetFederationTokenResponse {
1103
1121
  /**
1104
1122
  * <p>The temporary security credentials, which include an access key ID, a secret access key,
1105
1123
  * and a security (or session) token.</p>
1124
+ *
1106
1125
  * <note>
1107
1126
  * <p>The size of the security token that STS API operations return is not fixed. We
1108
1127
  * strongly recommend that you make no assumptions about the maximum size.</p>
@@ -1131,34 +1150,34 @@ export declare namespace GetFederationTokenResponse {
1131
1150
  }
1132
1151
  export interface GetSessionTokenRequest {
1133
1152
  /**
1134
- * <p>The duration, in seconds, that the credentials should remain valid. Acceptable
1135
- * durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds
1136
- * (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account
1137
- * owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is
1138
- * longer than one hour, the session for Amazon Web Services account owners defaults to one hour.</p>
1153
+ * <p>The duration, in seconds, that the credentials should remain valid. Acceptable durations
1154
+ * for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours),
1155
+ * with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account owners are
1156
+ * restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one
1157
+ * hour, the session for Amazon Web Services account owners defaults to one hour.</p>
1139
1158
  */
1140
1159
  DurationSeconds?: number;
1141
1160
  /**
1142
1161
  * <p>The identification number of the MFA device that is associated with the IAM user who
1143
- * is making the <code>GetSessionToken</code> call. Specify this value if the IAM user
1144
- * has a policy that requires MFA authentication. The value is either the serial number for
1145
- * a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN)
1146
- * for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can
1147
- * find the device for an IAM user by going to the Management Console and viewing the user's
1148
- * security credentials. </p>
1149
- * <p>The regex used to validate this parameter is a string of
1162
+ * is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a
1163
+ * policy that requires MFA authentication. The value is either the serial number for a
1164
+ * hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a
1165
+ * virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the
1166
+ * device for an IAM user by going to the Amazon Web Services Management Console and viewing the user's security
1167
+ * credentials. </p>
1168
+ * <p>The regex used to validate this parameter is a string of
1150
1169
  * characters consisting of upper- and lower-case alphanumeric characters with no spaces.
1151
1170
  * You can also include underscores or any of the following characters: =,.@:/-</p>
1152
1171
  */
1153
1172
  SerialNumber?: string;
1154
1173
  /**
1155
1174
  * <p>The value provided by the MFA device, if MFA is required. If any policy requires the
1156
- * IAM user to submit an MFA code, specify this value. If MFA authentication is required,
1157
- * the user must provide a code when requesting a set of temporary security credentials. A
1158
- * user who fails to provide the code receives an "access denied" response when requesting
1159
- * resources that require MFA authentication.</p>
1160
- * <p>The format for this parameter, as described by its regex pattern, is a sequence of six
1161
- * numeric digits.</p>
1175
+ * IAM user to submit an MFA code, specify this value. If MFA authentication is required,
1176
+ * the user must provide a code when requesting a set of temporary security credentials. A
1177
+ * user who fails to provide the code receives an "access denied" response when requesting
1178
+ * resources that require MFA authentication.</p>
1179
+ * <p>The format for this parameter, as described by its regex pattern, is a sequence of six
1180
+ * numeric digits.</p>
1162
1181
  */
1163
1182
  TokenCode?: string;
1164
1183
  }
@@ -1174,8 +1193,8 @@ export declare namespace GetSessionTokenRequest {
1174
1193
  */
1175
1194
  export interface GetSessionTokenResponse {
1176
1195
  /**
1177
- * <p>The temporary security credentials, which include an access key ID, a secret access
1178
- * key, and a security (or session) token.</p>
1196
+ * <p>The temporary security credentials, which include an access key ID, a secret access key,
1197
+ * and a security (or session) token.</p>
1179
1198
  *
1180
1199
  * <note>
1181
1200
  * <p>The size of the security token that STS API operations return is not fixed. We
@@ -16,6 +16,8 @@ export declare const getRuntimeConfig: (config: STSClientConfig) => {
16
16
  retryMode: string | import("@aws-sdk/types").Provider<string>;
17
17
  sha256: import("@aws-sdk/types").HashConstructor;
18
18
  streamCollector: import("@aws-sdk/types").StreamCollector;
19
+ useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
20
+ useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
19
21
  utf8Decoder: import("@aws-sdk/types").Decoder;
20
22
  utf8Encoder: import("@aws-sdk/types").Encoder;
21
23
  apiVersion: string;
@@ -16,6 +16,8 @@ export declare const getRuntimeConfig: (config: STSClientConfig) => {
16
16
  retryMode: string | import("@aws-sdk/types").Provider<string>;
17
17
  sha256: import("@aws-sdk/types").HashConstructor;
18
18
  streamCollector: import("@aws-sdk/types").StreamCollector;
19
+ useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
20
+ useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
19
21
  utf8Decoder: import("@aws-sdk/types").Decoder;
20
22
  utf8Encoder: import("@aws-sdk/types").Encoder;
21
23
  apiVersion: string;
@@ -18,6 +18,8 @@ export declare const getRuntimeConfig: (config: STSClientConfig) => {
18
18
  maxAttempts: number | import("@aws-sdk/types").Provider<number>;
19
19
  retryMode: string | import("@aws-sdk/types").Provider<string>;
20
20
  logger: import("@aws-sdk/types").Logger;
21
+ useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
22
+ useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
21
23
  serviceId: string;
22
24
  region: string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Provider<any>;
23
25
  credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
@@ -46,6 +46,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
46
46
 
47
47
  logger?: __Logger;
48
48
 
49
+ useDualstackEndpoint?: boolean | __Provider<boolean>;
50
+
51
+ useFipsEndpoint?: boolean | __Provider<boolean>;
52
+
49
53
  serviceId?: string;
50
54
 
51
55
  region?: string | __Provider<string>;
@@ -14,6 +14,8 @@ export declare const getRuntimeConfig: (config: STSClientConfig) => {
14
14
  retryMode: string | import("@aws-sdk/types").Provider<string>;
15
15
  sha256: import("@aws-sdk/types").HashConstructor;
16
16
  streamCollector: import("@aws-sdk/types").StreamCollector;
17
+ useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
18
+ useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
17
19
  utf8Decoder: import("@aws-sdk/types").Decoder;
18
20
  utf8Encoder: import("@aws-sdk/types").Encoder;
19
21
  apiVersion: string;
@@ -14,6 +14,8 @@ export declare const getRuntimeConfig: (config: STSClientConfig) => {
14
14
  retryMode: string | import("@aws-sdk/types").Provider<string>;
15
15
  sha256: import("@aws-sdk/types").HashConstructor;
16
16
  streamCollector: import("@aws-sdk/types").StreamCollector;
17
+ useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
18
+ useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
17
19
  utf8Decoder: import("@aws-sdk/types").Decoder;
18
20
  utf8Encoder: import("@aws-sdk/types").Encoder;
19
21
  apiVersion: string;