@aws-sdk/client-sts 3.295.0 → 3.297.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-cjs/protocols/Aws_query.js +19 -83
- package/dist-es/protocols/Aws_query.js +19 -83
- package/dist-types/STS.d.ts +10 -1
- package/dist-types/STSClient.d.ts +24 -4
- package/dist-types/commands/AssumeRoleCommand.d.ts +17 -1
- package/dist-types/commands/AssumeRoleWithSAMLCommand.d.ts +16 -0
- package/dist-types/commands/AssumeRoleWithWebIdentityCommand.d.ts +16 -0
- package/dist-types/commands/DecodeAuthorizationMessageCommand.d.ts +16 -0
- package/dist-types/commands/GetAccessKeyInfoCommand.d.ts +16 -0
- package/dist-types/commands/GetCallerIdentityCommand.d.ts +16 -0
- package/dist-types/commands/GetFederationTokenCommand.d.ts +16 -0
- package/dist-types/commands/GetSessionTokenCommand.d.ts +16 -0
- package/dist-types/models/STSServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +47 -0
- package/package.json +29 -29
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { AssumeRoleWithSAMLRequest, AssumeRoleWithSAMLResponse } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AssumeRoleWithSAMLCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AssumeRoleWithSAMLCommandInput extends AssumeRoleWithSAMLRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AssumeRoleWithSAMLCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a set of temporary security credentials for users who have been authenticated
|
|
18
23
|
* via a SAML authentication response. This operation provides a mechanism for tying an
|
|
19
24
|
* enterprise identity store or directory to role-based Amazon Web Services access without user-specific
|
|
@@ -153,6 +158,8 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
|
|
|
153
158
|
* const response = await client.send(command);
|
|
154
159
|
* ```
|
|
155
160
|
*
|
|
161
|
+
* @param AssumeRoleWithSAMLCommandInput - {@link AssumeRoleWithSAMLCommandInput}
|
|
162
|
+
* @returns {@link AssumeRoleWithSAMLCommandOutput}
|
|
156
163
|
* @see {@link AssumeRoleWithSAMLCommandInput} for command's `input` shape.
|
|
157
164
|
* @see {@link AssumeRoleWithSAMLCommandOutput} for command's `response` shape.
|
|
158
165
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
@@ -232,11 +239,20 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo
|
|
|
232
239
|
export declare class AssumeRoleWithSAMLCommand extends $Command<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput, STSClientResolvedConfig> {
|
|
233
240
|
readonly input: AssumeRoleWithSAMLCommandInput;
|
|
234
241
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
235
245
|
constructor(input: AssumeRoleWithSAMLCommandInput);
|
|
236
246
|
/**
|
|
237
247
|
* @internal
|
|
238
248
|
*/
|
|
239
249
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput>;
|
|
250
|
+
/**
|
|
251
|
+
* @internal
|
|
252
|
+
*/
|
|
240
253
|
private serialize;
|
|
254
|
+
/**
|
|
255
|
+
* @internal
|
|
256
|
+
*/
|
|
241
257
|
private deserialize;
|
|
242
258
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { AssumeRoleWithWebIdentityRequest, AssumeRoleWithWebIdentityResponse } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AssumeRoleWithWebIdentityCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AssumeRoleWithWebIdentityCommandInput extends AssumeRoleWithWebIdentityRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AssumeRoleWithWebIdentityCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWebIdentityResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a set of temporary security credentials for users who have been authenticated in
|
|
18
23
|
* a mobile or web application with a web identity provider. Example providers include the
|
|
19
24
|
* OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible
|
|
@@ -157,6 +162,8 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
|
|
|
157
162
|
* const response = await client.send(command);
|
|
158
163
|
* ```
|
|
159
164
|
*
|
|
165
|
+
* @param AssumeRoleWithWebIdentityCommandInput - {@link AssumeRoleWithWebIdentityCommandInput}
|
|
166
|
+
* @returns {@link AssumeRoleWithWebIdentityCommandOutput}
|
|
160
167
|
* @see {@link AssumeRoleWithWebIdentityCommandInput} for command's `input` shape.
|
|
161
168
|
* @see {@link AssumeRoleWithWebIdentityCommandOutput} for command's `response` shape.
|
|
162
169
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
@@ -243,11 +250,20 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe
|
|
|
243
250
|
export declare class AssumeRoleWithWebIdentityCommand extends $Command<AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput, STSClientResolvedConfig> {
|
|
244
251
|
readonly input: AssumeRoleWithWebIdentityCommandInput;
|
|
245
252
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
253
|
+
/**
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
246
256
|
constructor(input: AssumeRoleWithWebIdentityCommandInput);
|
|
247
257
|
/**
|
|
248
258
|
* @internal
|
|
249
259
|
*/
|
|
250
260
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput>;
|
|
261
|
+
/**
|
|
262
|
+
* @internal
|
|
263
|
+
*/
|
|
251
264
|
private serialize;
|
|
265
|
+
/**
|
|
266
|
+
* @internal
|
|
267
|
+
*/
|
|
252
268
|
private deserialize;
|
|
253
269
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { DecodeAuthorizationMessageRequest, DecodeAuthorizationMessageResponse } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link DecodeAuthorizationMessageCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface DecodeAuthorizationMessageCommandInput extends DecodeAuthorizationMessageRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link DecodeAuthorizationMessageCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthorizationMessageResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Decodes additional information about the authorization status of a request from an
|
|
18
23
|
* encoded message returned in response to an Amazon Web Services request.</p>
|
|
19
24
|
* <p>For example, if a user is not authorized to perform an operation that he or she has
|
|
@@ -60,6 +65,8 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
|
|
|
60
65
|
* const response = await client.send(command);
|
|
61
66
|
* ```
|
|
62
67
|
*
|
|
68
|
+
* @param DecodeAuthorizationMessageCommandInput - {@link DecodeAuthorizationMessageCommandInput}
|
|
69
|
+
* @returns {@link DecodeAuthorizationMessageCommandOutput}
|
|
63
70
|
* @see {@link DecodeAuthorizationMessageCommandInput} for command's `input` shape.
|
|
64
71
|
* @see {@link DecodeAuthorizationMessageCommandOutput} for command's `response` shape.
|
|
65
72
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
@@ -90,11 +97,20 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza
|
|
|
90
97
|
export declare class DecodeAuthorizationMessageCommand extends $Command<DecodeAuthorizationMessageCommandInput, DecodeAuthorizationMessageCommandOutput, STSClientResolvedConfig> {
|
|
91
98
|
readonly input: DecodeAuthorizationMessageCommandInput;
|
|
92
99
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
93
103
|
constructor(input: DecodeAuthorizationMessageCommandInput);
|
|
94
104
|
/**
|
|
95
105
|
* @internal
|
|
96
106
|
*/
|
|
97
107
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DecodeAuthorizationMessageCommandInput, DecodeAuthorizationMessageCommandOutput>;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
98
111
|
private serialize;
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
99
115
|
private deserialize;
|
|
100
116
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { GetAccessKeyInfoRequest, GetAccessKeyInfoResponse } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetAccessKeyInfoCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetAccessKeyInfoCommandInput extends GetAccessKeyInfoRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetAccessKeyInfoCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns the account identifier for the specified access key ID.</p>
|
|
18
23
|
* <p>Access keys consist of two parts: an access key ID (for example,
|
|
19
24
|
* <code>AKIAIOSFODNN7EXAMPLE</code>) and a secret access key (for example,
|
|
@@ -42,6 +47,8 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
|
|
|
42
47
|
* const response = await client.send(command);
|
|
43
48
|
* ```
|
|
44
49
|
*
|
|
50
|
+
* @param GetAccessKeyInfoCommandInput - {@link GetAccessKeyInfoCommandInput}
|
|
51
|
+
* @returns {@link GetAccessKeyInfoCommandOutput}
|
|
45
52
|
* @see {@link GetAccessKeyInfoCommandInput} for command's `input` shape.
|
|
46
53
|
* @see {@link GetAccessKeyInfoCommandOutput} for command's `response` shape.
|
|
47
54
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
@@ -51,11 +58,20 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse,
|
|
|
51
58
|
export declare class GetAccessKeyInfoCommand extends $Command<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput, STSClientResolvedConfig> {
|
|
52
59
|
readonly input: GetAccessKeyInfoCommandInput;
|
|
53
60
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
54
64
|
constructor(input: GetAccessKeyInfoCommandInput);
|
|
55
65
|
/**
|
|
56
66
|
* @internal
|
|
57
67
|
*/
|
|
58
68
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput>;
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
59
72
|
private serialize;
|
|
73
|
+
/**
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
60
76
|
private deserialize;
|
|
61
77
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { GetCallerIdentityRequest, GetCallerIdentityResponse } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetCallerIdentityCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetCallerIdentityCommandInput extends GetCallerIdentityRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetCallerIdentityCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetCallerIdentityCommandOutput extends GetCallerIdentityResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns details about the IAM user or role whose credentials are used to call the
|
|
18
23
|
* operation.</p>
|
|
19
24
|
* <note>
|
|
@@ -34,6 +39,8 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
|
|
|
34
39
|
* const response = await client.send(command);
|
|
35
40
|
* ```
|
|
36
41
|
*
|
|
42
|
+
* @param GetCallerIdentityCommandInput - {@link GetCallerIdentityCommandInput}
|
|
43
|
+
* @returns {@link GetCallerIdentityCommandOutput}
|
|
37
44
|
* @see {@link GetCallerIdentityCommandInput} for command's `input` shape.
|
|
38
45
|
* @see {@link GetCallerIdentityCommandOutput} for command's `response` shape.
|
|
39
46
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
@@ -91,11 +98,20 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons
|
|
|
91
98
|
export declare class GetCallerIdentityCommand extends $Command<GetCallerIdentityCommandInput, GetCallerIdentityCommandOutput, STSClientResolvedConfig> {
|
|
92
99
|
readonly input: GetCallerIdentityCommandInput;
|
|
93
100
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
101
|
+
/**
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
94
104
|
constructor(input: GetCallerIdentityCommandInput);
|
|
95
105
|
/**
|
|
96
106
|
* @internal
|
|
97
107
|
*/
|
|
98
108
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCallerIdentityCommandInput, GetCallerIdentityCommandOutput>;
|
|
109
|
+
/**
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
99
112
|
private serialize;
|
|
113
|
+
/**
|
|
114
|
+
* @internal
|
|
115
|
+
*/
|
|
100
116
|
private deserialize;
|
|
101
117
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { GetFederationTokenRequest, GetFederationTokenResponse } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetFederationTokenCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetFederationTokenCommandInput extends GetFederationTokenRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetFederationTokenCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetFederationTokenCommandOutput extends GetFederationTokenResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a set of temporary security credentials (consisting of an access key ID, a
|
|
18
23
|
* secret access key, and a security token) for a federated user. A typical use is in a proxy
|
|
19
24
|
* application that gets temporary security credentials on behalf of distributed applications
|
|
@@ -111,6 +116,8 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
|
|
|
111
116
|
* const response = await client.send(command);
|
|
112
117
|
* ```
|
|
113
118
|
*
|
|
119
|
+
* @param GetFederationTokenCommandInput - {@link GetFederationTokenCommandInput}
|
|
120
|
+
* @returns {@link GetFederationTokenCommandOutput}
|
|
114
121
|
* @see {@link GetFederationTokenCommandInput} for command's `input` shape.
|
|
115
122
|
* @see {@link GetFederationTokenCommandOutput} for command's `response` shape.
|
|
116
123
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
@@ -180,11 +187,20 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
|
|
|
180
187
|
export declare class GetFederationTokenCommand extends $Command<GetFederationTokenCommandInput, GetFederationTokenCommandOutput, STSClientResolvedConfig> {
|
|
181
188
|
readonly input: GetFederationTokenCommandInput;
|
|
182
189
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
183
193
|
constructor(input: GetFederationTokenCommandInput);
|
|
184
194
|
/**
|
|
185
195
|
* @internal
|
|
186
196
|
*/
|
|
187
197
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFederationTokenCommandInput, GetFederationTokenCommandOutput>;
|
|
198
|
+
/**
|
|
199
|
+
* @internal
|
|
200
|
+
*/
|
|
188
201
|
private serialize;
|
|
202
|
+
/**
|
|
203
|
+
* @internal
|
|
204
|
+
*/
|
|
189
205
|
private deserialize;
|
|
190
206
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { GetSessionTokenRequest, GetSessionTokenResponse } from "../models/models_0";
|
|
5
5
|
import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link GetSessionTokenCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface GetSessionTokenCommandInput extends GetSessionTokenRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link GetSessionTokenCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The
|
|
18
23
|
* credentials consist of an access key ID, a secret access key, and a security token.
|
|
19
24
|
* Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect
|
|
@@ -83,6 +88,8 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
|
|
|
83
88
|
* const response = await client.send(command);
|
|
84
89
|
* ```
|
|
85
90
|
*
|
|
91
|
+
* @param GetSessionTokenCommandInput - {@link GetSessionTokenCommandInput}
|
|
92
|
+
* @returns {@link GetSessionTokenCommandOutput}
|
|
86
93
|
* @see {@link GetSessionTokenCommandInput} for command's `input` shape.
|
|
87
94
|
* @see {@link GetSessionTokenCommandOutput} for command's `response` shape.
|
|
88
95
|
* @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
|
|
@@ -122,11 +129,20 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _
|
|
|
122
129
|
export declare class GetSessionTokenCommand extends $Command<GetSessionTokenCommandInput, GetSessionTokenCommandOutput, STSClientResolvedConfig> {
|
|
123
130
|
readonly input: GetSessionTokenCommandInput;
|
|
124
131
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
125
135
|
constructor(input: GetSessionTokenCommandInput);
|
|
126
136
|
/**
|
|
127
137
|
* @internal
|
|
128
138
|
*/
|
|
129
139
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSessionTokenCommandInput, GetSessionTokenCommandOutput>;
|
|
140
|
+
/**
|
|
141
|
+
* @internal
|
|
142
|
+
*/
|
|
130
143
|
private serialize;
|
|
144
|
+
/**
|
|
145
|
+
* @internal
|
|
146
|
+
*/
|
|
131
147
|
private deserialize;
|
|
132
148
|
}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
|
|
2
2
|
/**
|
|
3
|
+
* @public
|
|
4
|
+
*
|
|
3
5
|
* Base exception class for all service exceptions from STS service.
|
|
4
6
|
*/
|
|
5
7
|
export declare class STSServiceException extends __ServiceException {
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { STSServiceException as __BaseException } from "./STSServiceException";
|
|
3
3
|
/**
|
|
4
|
+
* @public
|
|
4
5
|
* <p>The identifiers for the temporary security credentials that the operation
|
|
5
6
|
* returns.</p>
|
|
6
7
|
*/
|
|
@@ -18,6 +19,7 @@ export interface AssumedRoleUser {
|
|
|
18
19
|
Arn: string | undefined;
|
|
19
20
|
}
|
|
20
21
|
/**
|
|
22
|
+
* @public
|
|
21
23
|
* <p>A reference to the IAM managed policy that is passed as a session policy for a role
|
|
22
24
|
* session or a federated user session.</p>
|
|
23
25
|
*/
|
|
@@ -30,6 +32,7 @@ export interface PolicyDescriptorType {
|
|
|
30
32
|
arn?: string;
|
|
31
33
|
}
|
|
32
34
|
/**
|
|
35
|
+
* @public
|
|
33
36
|
* <p>You can pass custom key-value pair attributes when you assume a role or federate a user.
|
|
34
37
|
* These are called session tags. You can then use the session tags to control access to
|
|
35
38
|
* 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
|
|
@@ -51,6 +54,9 @@ export interface Tag {
|
|
|
51
54
|
*/
|
|
52
55
|
Value: string | undefined;
|
|
53
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
54
60
|
export interface AssumeRoleRequest {
|
|
55
61
|
/**
|
|
56
62
|
* <p>The Amazon Resource Name (ARN) of the role to assume.</p>
|
|
@@ -242,6 +248,7 @@ export interface AssumeRoleRequest {
|
|
|
242
248
|
SourceIdentity?: string;
|
|
243
249
|
}
|
|
244
250
|
/**
|
|
251
|
+
* @public
|
|
245
252
|
* <p>Amazon Web Services credentials for API authentication.</p>
|
|
246
253
|
*/
|
|
247
254
|
export interface Credentials {
|
|
@@ -264,6 +271,7 @@ export interface Credentials {
|
|
|
264
271
|
Expiration: Date | undefined;
|
|
265
272
|
}
|
|
266
273
|
/**
|
|
274
|
+
* @public
|
|
267
275
|
* <p>Contains the response to a successful <a>AssumeRole</a> request, including
|
|
268
276
|
* temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
|
|
269
277
|
*/
|
|
@@ -309,6 +317,7 @@ export interface AssumeRoleResponse {
|
|
|
309
317
|
SourceIdentity?: string;
|
|
310
318
|
}
|
|
311
319
|
/**
|
|
320
|
+
* @public
|
|
312
321
|
* <p>The web identity token that was passed is expired or is not valid. Get a new identity
|
|
313
322
|
* token from the identity provider and then retry the request.</p>
|
|
314
323
|
*/
|
|
@@ -321,6 +330,7 @@ export declare class ExpiredTokenException extends __BaseException {
|
|
|
321
330
|
constructor(opts: __ExceptionOptionType<ExpiredTokenException, __BaseException>);
|
|
322
331
|
}
|
|
323
332
|
/**
|
|
333
|
+
* @public
|
|
324
334
|
* <p>The request was rejected because the policy document was malformed. The error message
|
|
325
335
|
* describes the specific error.</p>
|
|
326
336
|
*/
|
|
@@ -333,6 +343,7 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
|
|
|
333
343
|
constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
|
|
334
344
|
}
|
|
335
345
|
/**
|
|
346
|
+
* @public
|
|
336
347
|
* <p>The request was rejected because the total packed size of the session policies and
|
|
337
348
|
* session tags combined was too large. An Amazon Web Services conversion compresses the session policy
|
|
338
349
|
* document, session policy ARNs, and session tags into a packed binary format that has a
|
|
@@ -352,6 +363,7 @@ export declare class PackedPolicyTooLargeException extends __BaseException {
|
|
|
352
363
|
constructor(opts: __ExceptionOptionType<PackedPolicyTooLargeException, __BaseException>);
|
|
353
364
|
}
|
|
354
365
|
/**
|
|
366
|
+
* @public
|
|
355
367
|
* <p>STS is not activated in the requested region for the account that is being asked to
|
|
356
368
|
* generate credentials. The account administrator must use the IAM console to activate STS
|
|
357
369
|
* 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
|
|
@@ -366,6 +378,9 @@ export declare class RegionDisabledException extends __BaseException {
|
|
|
366
378
|
*/
|
|
367
379
|
constructor(opts: __ExceptionOptionType<RegionDisabledException, __BaseException>);
|
|
368
380
|
}
|
|
381
|
+
/**
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
369
384
|
export interface AssumeRoleWithSAMLRequest {
|
|
370
385
|
/**
|
|
371
386
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
@@ -456,6 +471,7 @@ export interface AssumeRoleWithSAMLRequest {
|
|
|
456
471
|
DurationSeconds?: number;
|
|
457
472
|
}
|
|
458
473
|
/**
|
|
474
|
+
* @public
|
|
459
475
|
* <p>Contains the response to a successful <a>AssumeRoleWithSAML</a> request,
|
|
460
476
|
* including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
|
|
461
477
|
*/
|
|
@@ -546,6 +562,7 @@ export interface AssumeRoleWithSAMLResponse {
|
|
|
546
562
|
SourceIdentity?: string;
|
|
547
563
|
}
|
|
548
564
|
/**
|
|
565
|
+
* @public
|
|
549
566
|
* <p>The identity provider (IdP) reported that authentication failed. This might be because
|
|
550
567
|
* the claim is invalid.</p>
|
|
551
568
|
* <p>If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it
|
|
@@ -560,6 +577,7 @@ export declare class IDPRejectedClaimException extends __BaseException {
|
|
|
560
577
|
constructor(opts: __ExceptionOptionType<IDPRejectedClaimException, __BaseException>);
|
|
561
578
|
}
|
|
562
579
|
/**
|
|
580
|
+
* @public
|
|
563
581
|
* <p>The web identity token that was passed could not be validated by Amazon Web Services. Get a new
|
|
564
582
|
* identity token from the identity provider and then retry the request.</p>
|
|
565
583
|
*/
|
|
@@ -571,6 +589,9 @@ export declare class InvalidIdentityTokenException extends __BaseException {
|
|
|
571
589
|
*/
|
|
572
590
|
constructor(opts: __ExceptionOptionType<InvalidIdentityTokenException, __BaseException>);
|
|
573
591
|
}
|
|
592
|
+
/**
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
574
595
|
export interface AssumeRoleWithWebIdentityRequest {
|
|
575
596
|
/**
|
|
576
597
|
* <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
|
|
@@ -674,6 +695,7 @@ export interface AssumeRoleWithWebIdentityRequest {
|
|
|
674
695
|
DurationSeconds?: number;
|
|
675
696
|
}
|
|
676
697
|
/**
|
|
698
|
+
* @public
|
|
677
699
|
* <p>Contains the response to a successful <a>AssumeRoleWithWebIdentity</a>
|
|
678
700
|
* request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
|
|
679
701
|
*/
|
|
@@ -745,6 +767,7 @@ export interface AssumeRoleWithWebIdentityResponse {
|
|
|
745
767
|
SourceIdentity?: string;
|
|
746
768
|
}
|
|
747
769
|
/**
|
|
770
|
+
* @public
|
|
748
771
|
* <p>The request could not be fulfilled because the identity provider (IDP) that
|
|
749
772
|
* was asked to verify the incoming identity token could not be reached. This is often a
|
|
750
773
|
* transient error caused by network conditions. Retry the request a limited number of
|
|
@@ -759,6 +782,9 @@ export declare class IDPCommunicationErrorException extends __BaseException {
|
|
|
759
782
|
*/
|
|
760
783
|
constructor(opts: __ExceptionOptionType<IDPCommunicationErrorException, __BaseException>);
|
|
761
784
|
}
|
|
785
|
+
/**
|
|
786
|
+
* @public
|
|
787
|
+
*/
|
|
762
788
|
export interface DecodeAuthorizationMessageRequest {
|
|
763
789
|
/**
|
|
764
790
|
* <p>The encoded message that was returned with the response.</p>
|
|
@@ -766,6 +792,7 @@ export interface DecodeAuthorizationMessageRequest {
|
|
|
766
792
|
EncodedMessage: string | undefined;
|
|
767
793
|
}
|
|
768
794
|
/**
|
|
795
|
+
* @public
|
|
769
796
|
* <p>A document that contains additional information about the authorization status of a
|
|
770
797
|
* request from an encoded message that is returned in response to an Amazon Web Services request.</p>
|
|
771
798
|
*/
|
|
@@ -776,6 +803,7 @@ export interface DecodeAuthorizationMessageResponse {
|
|
|
776
803
|
DecodedMessage?: string;
|
|
777
804
|
}
|
|
778
805
|
/**
|
|
806
|
+
* @public
|
|
779
807
|
* <p>The error returned if the message passed to <code>DecodeAuthorizationMessage</code>
|
|
780
808
|
* was invalid. This can happen if the token contains invalid characters, such as
|
|
781
809
|
* linebreaks. </p>
|
|
@@ -788,6 +816,9 @@ export declare class InvalidAuthorizationMessageException extends __BaseExceptio
|
|
|
788
816
|
*/
|
|
789
817
|
constructor(opts: __ExceptionOptionType<InvalidAuthorizationMessageException, __BaseException>);
|
|
790
818
|
}
|
|
819
|
+
/**
|
|
820
|
+
* @public
|
|
821
|
+
*/
|
|
791
822
|
export interface GetAccessKeyInfoRequest {
|
|
792
823
|
/**
|
|
793
824
|
* <p>The identifier of an access key.</p>
|
|
@@ -796,15 +827,22 @@ export interface GetAccessKeyInfoRequest {
|
|
|
796
827
|
*/
|
|
797
828
|
AccessKeyId: string | undefined;
|
|
798
829
|
}
|
|
830
|
+
/**
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
799
833
|
export interface GetAccessKeyInfoResponse {
|
|
800
834
|
/**
|
|
801
835
|
* <p>The number used to identify the Amazon Web Services account.</p>
|
|
802
836
|
*/
|
|
803
837
|
Account?: string;
|
|
804
838
|
}
|
|
839
|
+
/**
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
805
842
|
export interface GetCallerIdentityRequest {
|
|
806
843
|
}
|
|
807
844
|
/**
|
|
845
|
+
* @public
|
|
808
846
|
* <p>Contains the response to a successful <a>GetCallerIdentity</a> request,
|
|
809
847
|
* including information about the entity making the request.</p>
|
|
810
848
|
*/
|
|
@@ -826,6 +864,9 @@ export interface GetCallerIdentityResponse {
|
|
|
826
864
|
*/
|
|
827
865
|
Arn?: string;
|
|
828
866
|
}
|
|
867
|
+
/**
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
829
870
|
export interface GetFederationTokenRequest {
|
|
830
871
|
/**
|
|
831
872
|
* <p>The name of the federated user. The name is used as an identifier for the temporary
|
|
@@ -938,6 +979,7 @@ export interface GetFederationTokenRequest {
|
|
|
938
979
|
Tags?: Tag[];
|
|
939
980
|
}
|
|
940
981
|
/**
|
|
982
|
+
* @public
|
|
941
983
|
* <p>Identifiers for the federated user that is associated with the credentials.</p>
|
|
942
984
|
*/
|
|
943
985
|
export interface FederatedUser {
|
|
@@ -954,6 +996,7 @@ export interface FederatedUser {
|
|
|
954
996
|
Arn: string | undefined;
|
|
955
997
|
}
|
|
956
998
|
/**
|
|
999
|
+
* @public
|
|
957
1000
|
* <p>Contains the response to a successful <a>GetFederationToken</a> request,
|
|
958
1001
|
* including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
|
|
959
1002
|
*/
|
|
@@ -981,6 +1024,9 @@ export interface GetFederationTokenResponse {
|
|
|
981
1024
|
*/
|
|
982
1025
|
PackedPolicySize?: number;
|
|
983
1026
|
}
|
|
1027
|
+
/**
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
984
1030
|
export interface GetSessionTokenRequest {
|
|
985
1031
|
/**
|
|
986
1032
|
* <p>The duration, in seconds, that the credentials should remain valid. Acceptable durations
|
|
@@ -1015,6 +1061,7 @@ export interface GetSessionTokenRequest {
|
|
|
1015
1061
|
TokenCode?: string;
|
|
1016
1062
|
}
|
|
1017
1063
|
/**
|
|
1064
|
+
* @public
|
|
1018
1065
|
* <p>Contains the response to a successful <a>GetSessionToken</a> request,
|
|
1019
1066
|
* including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
|
|
1020
1067
|
*/
|