@aws-sdk/client-sts 3.289.0 → 3.292.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.
- package/dist-types/commands/AssumeRoleCommand.d.ts +27 -0
- package/dist-types/commands/AssumeRoleWithSAMLCommand.d.ts +37 -0
- package/dist-types/commands/AssumeRoleWithWebIdentityCommand.d.ts +44 -0
- package/dist-types/commands/DecodeAuthorizationMessageCommand.d.ts +6 -0
- package/dist-types/commands/GetAccessKeyInfoCommand.d.ts +1 -0
- package/dist-types/commands/GetCallerIdentityCommand.d.ts +1 -0
- package/dist-types/commands/GetFederationTokenCommand.d.ts +23 -0
- package/dist-types/commands/GetSessionTokenCommand.d.ts +8 -0
- package/package.json +35 -40
|
@@ -116,6 +116,33 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB
|
|
|
116
116
|
* @see {@link AssumeRoleCommandOutput} for command's `response` shape.
|
|
117
117
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
118
118
|
*
|
|
119
|
+
* @throws {@link ExpiredTokenException} (client fault)
|
|
120
|
+
* <p>The web identity token that was passed is expired or is not valid. Get a new identity
|
|
121
|
+
* token from the identity provider and then retry the request.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
124
|
+
* <p>The request was rejected because the policy document was malformed. The error message
|
|
125
|
+
* describes the specific error.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link PackedPolicyTooLargeException} (client fault)
|
|
128
|
+
* <p>The request was rejected because the total packed size of the session policies and
|
|
129
|
+
* session tags combined was too large. An Amazon Web Services conversion compresses the session policy
|
|
130
|
+
* document, session policy ARNs, and session tags into a packed binary format that has a
|
|
131
|
+
* separate limit. The error message indicates by percentage how close the policies and
|
|
132
|
+
* 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
|
|
133
|
+
* the <i>IAM User Guide</i>.</p>
|
|
134
|
+
* <p>You could receive this error even though you meet other defined session policy and
|
|
135
|
+
* 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
|
|
136
|
+
* Character Limits</a> in the <i>IAM User Guide</i>.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link RegionDisabledException} (client fault)
|
|
139
|
+
* <p>STS is not activated in the requested region for the account that is being asked to
|
|
140
|
+
* generate credentials. The account administrator must use the IAM console to activate STS
|
|
141
|
+
* in that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
|
|
142
|
+
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>IAM User
|
|
143
|
+
* Guide</i>.</p>
|
|
144
|
+
*
|
|
145
|
+
*
|
|
119
146
|
* @example To assume a role
|
|
120
147
|
* ```javascript
|
|
121
148
|
* //
|
|
@@ -157,6 +157,43 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
|
|
|
157
157
|
* @see {@link AssumeRoleWithSAMLCommandOutput} for command's `response` shape.
|
|
158
158
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
159
159
|
*
|
|
160
|
+
* @throws {@link ExpiredTokenException} (client fault)
|
|
161
|
+
* <p>The web identity token that was passed is expired or is not valid. Get a new identity
|
|
162
|
+
* token from the identity provider and then retry the request.</p>
|
|
163
|
+
*
|
|
164
|
+
* @throws {@link IDPRejectedClaimException} (client fault)
|
|
165
|
+
* <p>The identity provider (IdP) reported that authentication failed. This might be because
|
|
166
|
+
* the claim is invalid.</p>
|
|
167
|
+
* <p>If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it
|
|
168
|
+
* can also mean that the claim has expired or has been explicitly revoked. </p>
|
|
169
|
+
*
|
|
170
|
+
* @throws {@link InvalidIdentityTokenException} (client fault)
|
|
171
|
+
* <p>The web identity token that was passed could not be validated by Amazon Web Services. Get a new
|
|
172
|
+
* identity token from the identity provider and then retry the request.</p>
|
|
173
|
+
*
|
|
174
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
175
|
+
* <p>The request was rejected because the policy document was malformed. The error message
|
|
176
|
+
* describes the specific error.</p>
|
|
177
|
+
*
|
|
178
|
+
* @throws {@link PackedPolicyTooLargeException} (client fault)
|
|
179
|
+
* <p>The request was rejected because the total packed size of the session policies and
|
|
180
|
+
* session tags combined was too large. An Amazon Web Services conversion compresses the session policy
|
|
181
|
+
* document, session policy ARNs, and session tags into a packed binary format that has a
|
|
182
|
+
* separate limit. The error message indicates by percentage how close the policies and
|
|
183
|
+
* 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
|
|
184
|
+
* the <i>IAM User Guide</i>.</p>
|
|
185
|
+
* <p>You could receive this error even though you meet other defined session policy and
|
|
186
|
+
* 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
|
|
187
|
+
* Character Limits</a> in the <i>IAM User Guide</i>.</p>
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link RegionDisabledException} (client fault)
|
|
190
|
+
* <p>STS is not activated in the requested region for the account that is being asked to
|
|
191
|
+
* generate credentials. The account administrator must use the IAM console to activate STS
|
|
192
|
+
* in that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
|
|
193
|
+
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>IAM User
|
|
194
|
+
* Guide</i>.</p>
|
|
195
|
+
*
|
|
196
|
+
*
|
|
160
197
|
* @example To assume a role using a SAML assertion
|
|
161
198
|
* ```javascript
|
|
162
199
|
* //
|
|
@@ -161,6 +161,50 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
|
|
|
161
161
|
* @see {@link AssumeRoleWithWebIdentityCommandOutput} for command's `response` shape.
|
|
162
162
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
163
163
|
*
|
|
164
|
+
* @throws {@link ExpiredTokenException} (client fault)
|
|
165
|
+
* <p>The web identity token that was passed is expired or is not valid. Get a new identity
|
|
166
|
+
* token from the identity provider and then retry the request.</p>
|
|
167
|
+
*
|
|
168
|
+
* @throws {@link IDPCommunicationErrorException} (client fault)
|
|
169
|
+
* <p>The request could not be fulfilled because the identity provider (IDP) that
|
|
170
|
+
* was asked to verify the incoming identity token could not be reached. This is often a
|
|
171
|
+
* transient error caused by network conditions. Retry the request a limited number of
|
|
172
|
+
* times so that you don't exceed the request rate. If the error persists, the
|
|
173
|
+
* identity provider might be down or not responding.</p>
|
|
174
|
+
*
|
|
175
|
+
* @throws {@link IDPRejectedClaimException} (client fault)
|
|
176
|
+
* <p>The identity provider (IdP) reported that authentication failed. This might be because
|
|
177
|
+
* the claim is invalid.</p>
|
|
178
|
+
* <p>If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it
|
|
179
|
+
* can also mean that the claim has expired or has been explicitly revoked. </p>
|
|
180
|
+
*
|
|
181
|
+
* @throws {@link InvalidIdentityTokenException} (client fault)
|
|
182
|
+
* <p>The web identity token that was passed could not be validated by Amazon Web Services. Get a new
|
|
183
|
+
* identity token from the identity provider and then retry the request.</p>
|
|
184
|
+
*
|
|
185
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
186
|
+
* <p>The request was rejected because the policy document was malformed. The error message
|
|
187
|
+
* describes the specific error.</p>
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link PackedPolicyTooLargeException} (client fault)
|
|
190
|
+
* <p>The request was rejected because the total packed size of the session policies and
|
|
191
|
+
* session tags combined was too large. An Amazon Web Services conversion compresses the session policy
|
|
192
|
+
* document, session policy ARNs, and session tags into a packed binary format that has a
|
|
193
|
+
* separate limit. The error message indicates by percentage how close the policies and
|
|
194
|
+
* 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
|
|
195
|
+
* the <i>IAM User Guide</i>.</p>
|
|
196
|
+
* <p>You could receive this error even though you meet other defined session policy and
|
|
197
|
+
* 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
|
|
198
|
+
* Character Limits</a> in the <i>IAM User Guide</i>.</p>
|
|
199
|
+
*
|
|
200
|
+
* @throws {@link RegionDisabledException} (client fault)
|
|
201
|
+
* <p>STS is not activated in the requested region for the account that is being asked to
|
|
202
|
+
* generate credentials. The account administrator must use the IAM console to activate STS
|
|
203
|
+
* in that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
|
|
204
|
+
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>IAM User
|
|
205
|
+
* Guide</i>.</p>
|
|
206
|
+
*
|
|
207
|
+
*
|
|
164
208
|
* @example To assume a role as an OpenID Connect-federated user
|
|
165
209
|
* ```javascript
|
|
166
210
|
* //
|
|
@@ -64,6 +64,12 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
|
|
|
64
64
|
* @see {@link DecodeAuthorizationMessageCommandOutput} for command's `response` shape.
|
|
65
65
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
66
66
|
*
|
|
67
|
+
* @throws {@link InvalidAuthorizationMessageException} (client fault)
|
|
68
|
+
* <p>The error returned if the message passed to <code>DecodeAuthorizationMessage</code>
|
|
69
|
+
* was invalid. This can happen if the token contains invalid characters, such as
|
|
70
|
+
* linebreaks. </p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
67
73
|
* @example To decode information about an authorization status of a request
|
|
68
74
|
* ```javascript
|
|
69
75
|
* //
|
|
@@ -46,6 +46,7 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
|
|
|
46
46
|
* @see {@link GetAccessKeyInfoCommandOutput} for command's `response` shape.
|
|
47
47
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
48
48
|
*
|
|
49
|
+
*
|
|
49
50
|
*/
|
|
50
51
|
export declare class GetAccessKeyInfoCommand extends $Command<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput, STSClientResolvedConfig> {
|
|
51
52
|
readonly input: GetAccessKeyInfoCommandInput;
|
|
@@ -38,6 +38,7 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
|
|
|
38
38
|
* @see {@link GetCallerIdentityCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
*
|
|
41
42
|
* @example To get details about a calling IAM user
|
|
42
43
|
* ```javascript
|
|
43
44
|
* // This example shows a request and response made with the credentials for a user named Alice in the AWS account 123456789012.
|
|
@@ -115,6 +115,29 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
|
|
|
115
115
|
* @see {@link GetFederationTokenCommandOutput} for command's `response` shape.
|
|
116
116
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
117
117
|
*
|
|
118
|
+
* @throws {@link MalformedPolicyDocumentException} (client fault)
|
|
119
|
+
* <p>The request was rejected because the policy document was malformed. The error message
|
|
120
|
+
* describes the specific error.</p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link PackedPolicyTooLargeException} (client fault)
|
|
123
|
+
* <p>The request was rejected because the total packed size of the session policies and
|
|
124
|
+
* session tags combined was too large. An Amazon Web Services conversion compresses the session policy
|
|
125
|
+
* document, session policy ARNs, and session tags into a packed binary format that has a
|
|
126
|
+
* separate limit. The error message indicates by percentage how close the policies and
|
|
127
|
+
* 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
|
|
128
|
+
* the <i>IAM User Guide</i>.</p>
|
|
129
|
+
* <p>You could receive this error even though you meet other defined session policy and
|
|
130
|
+
* 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
|
|
131
|
+
* Character Limits</a> in the <i>IAM User Guide</i>.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link RegionDisabledException} (client fault)
|
|
134
|
+
* <p>STS is not activated in the requested region for the account that is being asked to
|
|
135
|
+
* generate credentials. The account administrator must use the IAM console to activate STS
|
|
136
|
+
* in that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
|
|
137
|
+
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>IAM User
|
|
138
|
+
* Guide</i>.</p>
|
|
139
|
+
*
|
|
140
|
+
*
|
|
118
141
|
* @example To get temporary credentials for a role by using GetFederationToken
|
|
119
142
|
* ```javascript
|
|
120
143
|
* //
|
|
@@ -87,6 +87,14 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
|
|
|
87
87
|
* @see {@link GetSessionTokenCommandOutput} for command's `response` shape.
|
|
88
88
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
89
89
|
*
|
|
90
|
+
* @throws {@link RegionDisabledException} (client fault)
|
|
91
|
+
* <p>STS is not activated in the requested region for the account that is being asked to
|
|
92
|
+
* generate credentials. The account administrator must use the IAM console to activate STS
|
|
93
|
+
* in that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and
|
|
94
|
+
* Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>IAM User
|
|
95
|
+
* Guide</i>.</p>
|
|
96
|
+
*
|
|
97
|
+
*
|
|
90
98
|
* @example To get temporary credentials for an IAM user or an AWS account
|
|
91
99
|
* ```javascript
|
|
92
100
|
* //
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-sts",
|
|
3
3
|
"description": "AWS SDK for JavaScript Sts Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.292.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -22,56 +22,51 @@
|
|
|
22
22
|
"dependencies": {
|
|
23
23
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
24
24
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
25
|
-
"@aws-sdk/config-resolver": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
28
|
-
"@aws-sdk/hash-node": "3.
|
|
29
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
30
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
31
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
32
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
33
|
-
"@aws-sdk/middleware-logger": "3.
|
|
34
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
35
|
-
"@aws-sdk/middleware-retry": "3.
|
|
36
|
-
"@aws-sdk/middleware-sdk-sts": "3.
|
|
37
|
-
"@aws-sdk/middleware-serde": "3.
|
|
38
|
-
"@aws-sdk/middleware-signing": "3.
|
|
39
|
-
"@aws-sdk/middleware-stack": "3.
|
|
40
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
41
|
-
"@aws-sdk/node-config-provider": "3.
|
|
42
|
-
"@aws-sdk/node-http-handler": "3.
|
|
43
|
-
"@aws-sdk/protocol-http": "3.
|
|
44
|
-
"@aws-sdk/smithy-client": "3.
|
|
45
|
-
"@aws-sdk/types": "3.
|
|
46
|
-
"@aws-sdk/url-parser": "3.
|
|
47
|
-
"@aws-sdk/util-base64": "3.
|
|
48
|
-
"@aws-sdk/util-body-length-browser": "3.
|
|
49
|
-
"@aws-sdk/util-body-length-node": "3.
|
|
50
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
51
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
52
|
-
"@aws-sdk/util-endpoints": "3.
|
|
53
|
-
"@aws-sdk/util-retry": "3.
|
|
54
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
55
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
56
|
-
"@aws-sdk/util-utf8": "3.
|
|
25
|
+
"@aws-sdk/config-resolver": "3.292.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.292.0",
|
|
27
|
+
"@aws-sdk/fetch-http-handler": "3.292.0",
|
|
28
|
+
"@aws-sdk/hash-node": "3.292.0",
|
|
29
|
+
"@aws-sdk/invalid-dependency": "3.292.0",
|
|
30
|
+
"@aws-sdk/middleware-content-length": "3.292.0",
|
|
31
|
+
"@aws-sdk/middleware-endpoint": "3.292.0",
|
|
32
|
+
"@aws-sdk/middleware-host-header": "3.292.0",
|
|
33
|
+
"@aws-sdk/middleware-logger": "3.292.0",
|
|
34
|
+
"@aws-sdk/middleware-recursion-detection": "3.292.0",
|
|
35
|
+
"@aws-sdk/middleware-retry": "3.292.0",
|
|
36
|
+
"@aws-sdk/middleware-sdk-sts": "3.292.0",
|
|
37
|
+
"@aws-sdk/middleware-serde": "3.292.0",
|
|
38
|
+
"@aws-sdk/middleware-signing": "3.292.0",
|
|
39
|
+
"@aws-sdk/middleware-stack": "3.292.0",
|
|
40
|
+
"@aws-sdk/middleware-user-agent": "3.292.0",
|
|
41
|
+
"@aws-sdk/node-config-provider": "3.292.0",
|
|
42
|
+
"@aws-sdk/node-http-handler": "3.292.0",
|
|
43
|
+
"@aws-sdk/protocol-http": "3.292.0",
|
|
44
|
+
"@aws-sdk/smithy-client": "3.292.0",
|
|
45
|
+
"@aws-sdk/types": "3.292.0",
|
|
46
|
+
"@aws-sdk/url-parser": "3.292.0",
|
|
47
|
+
"@aws-sdk/util-base64": "3.292.0",
|
|
48
|
+
"@aws-sdk/util-body-length-browser": "3.292.0",
|
|
49
|
+
"@aws-sdk/util-body-length-node": "3.292.0",
|
|
50
|
+
"@aws-sdk/util-defaults-mode-browser": "3.292.0",
|
|
51
|
+
"@aws-sdk/util-defaults-mode-node": "3.292.0",
|
|
52
|
+
"@aws-sdk/util-endpoints": "3.292.0",
|
|
53
|
+
"@aws-sdk/util-retry": "3.292.0",
|
|
54
|
+
"@aws-sdk/util-user-agent-browser": "3.292.0",
|
|
55
|
+
"@aws-sdk/util-user-agent-node": "3.292.0",
|
|
56
|
+
"@aws-sdk/util-utf8": "3.292.0",
|
|
57
57
|
"fast-xml-parser": "4.1.2",
|
|
58
58
|
"tslib": "^2.3.1"
|
|
59
59
|
},
|
|
60
60
|
"devDependencies": {
|
|
61
|
-
"@aws-sdk/service-client-documentation-generator": "3.
|
|
61
|
+
"@aws-sdk/service-client-documentation-generator": "3.292.0",
|
|
62
62
|
"@tsconfig/node14": "1.0.3",
|
|
63
63
|
"@types/node": "^14.14.31",
|
|
64
64
|
"concurrently": "7.0.0",
|
|
65
65
|
"downlevel-dts": "0.10.1",
|
|
66
66
|
"rimraf": "3.0.2",
|
|
67
|
-
"typedoc": "0.
|
|
67
|
+
"typedoc": "0.23.23",
|
|
68
68
|
"typescript": "~4.6.2"
|
|
69
69
|
},
|
|
70
|
-
"overrides": {
|
|
71
|
-
"typedoc": {
|
|
72
|
-
"typescript": "~4.6.2"
|
|
73
|
-
}
|
|
74
|
-
},
|
|
75
70
|
"engines": {
|
|
76
71
|
"node": ">=14.0.0"
|
|
77
72
|
},
|