@aws-sdk/client-sts 3.186.0 → 3.186.2

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.
Files changed (30) hide show
  1. package/dist-cjs/protocols/Aws_query.js +2 -2
  2. package/dist-cjs/xml-parser.js +18 -0
  3. package/dist-es/protocols/Aws_query.js +1 -1
  4. package/dist-es/xml-parser.js +15 -0
  5. package/dist-types/ts3.4/STS.d.ts +626 -140
  6. package/dist-types/ts3.4/STSClient.d.ts +156 -151
  7. package/dist-types/ts3.4/commands/AssumeRoleCommand.d.ts +124 -32
  8. package/dist-types/ts3.4/commands/AssumeRoleWithSAMLCommand.d.ts +166 -36
  9. package/dist-types/ts3.4/commands/AssumeRoleWithWebIdentityCommand.d.ts +170 -39
  10. package/dist-types/ts3.4/commands/DecodeAuthorizationMessageCommand.d.ts +70 -39
  11. package/dist-types/ts3.4/commands/GetAccessKeyInfoCommand.d.ts +52 -35
  12. package/dist-types/ts3.4/commands/GetCallerIdentityCommand.d.ts +44 -36
  13. package/dist-types/ts3.4/commands/GetFederationTokenCommand.d.ts +120 -36
  14. package/dist-types/ts3.4/commands/GetSessionTokenCommand.d.ts +93 -35
  15. package/dist-types/ts3.4/commands/index.d.ts +8 -8
  16. package/dist-types/ts3.4/defaultRoleAssumers.d.ts +20 -22
  17. package/dist-types/ts3.4/defaultStsRoleAssumers.d.ts +35 -25
  18. package/dist-types/ts3.4/endpoints.d.ts +2 -2
  19. package/dist-types/ts3.4/index.d.ts +6 -6
  20. package/dist-types/ts3.4/models/STSServiceException.d.ts +10 -7
  21. package/dist-types/ts3.4/models/index.d.ts +1 -1
  22. package/dist-types/ts3.4/models/models_0.d.ts +1146 -238
  23. package/dist-types/ts3.4/protocols/Aws_query.d.ts +26 -101
  24. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +40 -67
  25. package/dist-types/ts3.4/runtimeConfig.d.ts +40 -65
  26. package/dist-types/ts3.4/runtimeConfig.native.d.ts +39 -68
  27. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +13 -10
  28. package/dist-types/ts3.4/xml-parser.d.ts +4 -0
  29. package/dist-types/xml-parser.d.ts +4 -0
  30. package/package.json +2 -2
@@ -1,36 +1,166 @@
1
- import { Command as $Command } from "@aws-sdk/smithy-client";
2
- import {
3
- Handler,
4
- HttpHandlerOptions as __HttpHandlerOptions,
5
- MetadataBearer as __MetadataBearer,
6
- MiddlewareStack,
7
- } from "@aws-sdk/types";
8
- import {
9
- AssumeRoleWithSAMLRequest,
10
- AssumeRoleWithSAMLResponse,
11
- } from "../models/models_0";
12
- import {
13
- ServiceInputTypes,
14
- ServiceOutputTypes,
15
- STSClientResolvedConfig,
16
- } from "../STSClient";
17
- export interface AssumeRoleWithSAMLCommandInput
18
- extends AssumeRoleWithSAMLRequest {}
19
- export interface AssumeRoleWithSAMLCommandOutput
20
- extends AssumeRoleWithSAMLResponse,
21
- __MetadataBearer {}
22
- export declare class AssumeRoleWithSAMLCommand extends $Command<
23
- AssumeRoleWithSAMLCommandInput,
24
- AssumeRoleWithSAMLCommandOutput,
25
- STSClientResolvedConfig
26
- > {
27
- readonly input: AssumeRoleWithSAMLCommandInput;
28
- constructor(input: AssumeRoleWithSAMLCommandInput);
29
- resolveMiddleware(
30
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
31
- configuration: STSClientResolvedConfig,
32
- options?: __HttpHandlerOptions
33
- ): Handler<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput>;
34
- private serialize;
35
- private deserialize;
36
- }
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { AssumeRoleWithSAMLRequest, AssumeRoleWithSAMLResponse } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
5
+ export interface AssumeRoleWithSAMLCommandInput extends AssumeRoleWithSAMLRequest {
6
+ }
7
+ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Returns a set of temporary security credentials for users who have been authenticated
11
+ * via a SAML authentication response. This operation provides a mechanism for tying an
12
+ * enterprise identity store or directory to role-based Amazon Web Services access without user-specific
13
+ * credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the
14
+ * 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
15
+ * Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
16
+ * Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
17
+ * <p>The temporary security credentials returned by this operation consist of an access key
18
+ * ID, a secret access key, and a security token. Applications can use these temporary
19
+ * security credentials to sign calls to Amazon Web Services services.</p>
20
+ * <p>
21
+ * <b>Session Duration</b>
22
+ * </p>
23
+ * <p>By default, the temporary security credentials created by
24
+ * <code>AssumeRoleWithSAML</code> last for one hour. However, you can use the optional
25
+ * <code>DurationSeconds</code> parameter to specify the duration of your session. Your
26
+ * role session lasts for the duration that you specify, or until the time specified in the
27
+ * SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is
28
+ * shorter. You can provide a <code>DurationSeconds</code> value from 900 seconds (15 minutes)
29
+ * up to the maximum session duration setting for the role. This setting can have a value from
30
+ * 1 hour to 12 hours. 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
31
+ * Maximum Session Duration Setting for a Role</a> in the
32
+ * <i>IAM User Guide</i>. The maximum session duration limit applies when
33
+ * you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI
34
+ * commands. However the limit does not apply when you use those operations to create a
35
+ * console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the
36
+ * <i>IAM User Guide</i>.</p>
37
+ * <note>
38
+ * <p>
39
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-role-chaining">Role chaining</a> limits your CLI or Amazon Web Services API role
40
+ * session to a maximum of one hour. When you use the <code>AssumeRole</code> API operation
41
+ * to assume a role, you can specify the duration of your role session with the
42
+ * <code>DurationSeconds</code> parameter. You can specify a parameter value of up to
43
+ * 43200 seconds (12 hours), depending on the maximum session duration setting for your
44
+ * role. However, if you assume a role using role chaining and provide a
45
+ * <code>DurationSeconds</code> parameter value greater than one hour, the operation
46
+ * fails.</p>
47
+ * </note>
48
+ * <p>
49
+ * <b>Permissions</b>
50
+ * </p>
51
+ * <p>The temporary security credentials created by <code>AssumeRoleWithSAML</code> can be
52
+ * used to make API calls to any Amazon Web Services service with the following exception: you cannot call
53
+ * the STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API
54
+ * operations.</p>
55
+ * <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to
56
+ * this operation. You can pass a single JSON policy document to use as an inline session
57
+ * policy. You can also specify up to 10 managed policies to use as managed session policies.
58
+ * The plaintext that you use for both inline and managed session policies can't exceed 2,048
59
+ * characters. Passing policies to this operation returns new
60
+ * temporary credentials. The resulting session's permissions are the intersection of the
61
+ * role's identity-based policy and the session policies. You can use the role's temporary
62
+ * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
63
+ * the role. You cannot use session policies to grant more permissions than those allowed
64
+ * by the identity-based policy of the role that is being assumed. For more information, see
65
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
66
+ * Policies</a> in the <i>IAM User Guide</i>.</p>
67
+ * <p>Calling <code>AssumeRoleWithSAML</code> does not require the use of Amazon Web Services security
68
+ * credentials. The identity of the caller is validated by using keys in the metadata document
69
+ * that is uploaded for the SAML provider entity for your identity provider. </p>
70
+ * <important>
71
+ * <p>Calling <code>AssumeRoleWithSAML</code> can result in an entry in your CloudTrail logs.
72
+ * The entry includes the value in the <code>NameID</code> element of the SAML assertion.
73
+ * We recommend that you use a <code>NameIDType</code> that is not associated with any
74
+ * personally identifiable information (PII). For example, you could instead use the
75
+ * persistent identifier
76
+ * (<code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code>).</p>
77
+ * </important>
78
+ * <p>
79
+ * <b>Tags</b>
80
+ * </p>
81
+ * <p>(Optional) You can configure your IdP to pass attributes into your SAML assertion as
82
+ * session tags. Each session tag consists of a key name and an associated value. For more
83
+ * 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
84
+ * <i>IAM User Guide</i>.</p>
85
+ * <p>You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128
86
+ * characters and the values can’t exceed 256 characters. For these and additional limits, see
87
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
88
+ * and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
89
+ *
90
+ * <note>
91
+ * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
92
+ * packed binary format that has a separate limit. Your request can fail for this limit
93
+ * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
94
+ * response element indicates by percentage how close the policies and tags for your
95
+ * request are to the upper size limit.
96
+ * </p>
97
+ * </note>
98
+ *
99
+ * <p>You can pass a session tag with the same key as a tag that is attached to the role. When
100
+ * you do, session tags override the role's tags with the same key.</p>
101
+ * <p>An administrator must grant you the permissions necessary to pass session tags. The
102
+ * administrator can also create granular permissions to allow you to pass only specific
103
+ * 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
104
+ * for Attribute-Based Access Control</a> in the
105
+ * <i>IAM User Guide</i>.</p>
106
+ * <p>You can set the session tags as transitive. Transitive tags persist during role
107
+ * chaining. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining">Chaining Roles
108
+ * with Session Tags</a> in the <i>IAM User Guide</i>.</p>
109
+ * <p>
110
+ * <b>SAML Configuration</b>
111
+ * </p>
112
+ * <p>Before your application can call <code>AssumeRoleWithSAML</code>, you must configure
113
+ * your SAML identity provider (IdP) to issue the claims required by Amazon Web Services. Additionally, you
114
+ * must use Identity and Access Management (IAM) to create a SAML provider entity in your Amazon Web Services account that
115
+ * represents your identity provider. You must also create an IAM role that specifies this
116
+ * SAML provider in its trust policy. </p>
117
+ * <p>For more information, see the following resources:</p>
118
+ * <ul>
119
+ * <li>
120
+ * <p>
121
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About
122
+ * SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>.
123
+ * </p>
124
+ * </li>
125
+ * <li>
126
+ * <p>
127
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the
128
+ * <i>IAM User Guide</i>. </p>
129
+ * </li>
130
+ * <li>
131
+ * <p>
132
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring
133
+ * a Relying Party and Claims</a> in the <i>IAM User Guide</i>.
134
+ * </p>
135
+ * </li>
136
+ * <li>
137
+ * <p>
138
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the
139
+ * <i>IAM User Guide</i>. </p>
140
+ * </li>
141
+ * </ul>
142
+ * @example
143
+ * Use a bare-bones client and the command you need to make an API call.
144
+ * ```javascript
145
+ * import { STSClient, AssumeRoleWithSAMLCommand } from "@aws-sdk/client-sts"; // ES Modules import
146
+ * // const { STSClient, AssumeRoleWithSAMLCommand } = require("@aws-sdk/client-sts"); // CommonJS import
147
+ * const client = new STSClient(config);
148
+ * const command = new AssumeRoleWithSAMLCommand(input);
149
+ * const response = await client.send(command);
150
+ * ```
151
+ *
152
+ * @see {@link AssumeRoleWithSAMLCommandInput} for command's `input` shape.
153
+ * @see {@link AssumeRoleWithSAMLCommandOutput} for command's `response` shape.
154
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
155
+ *
156
+ */
157
+ export declare class AssumeRoleWithSAMLCommand extends $Command<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput, STSClientResolvedConfig> {
158
+ readonly input: AssumeRoleWithSAMLCommandInput;
159
+ constructor(input: AssumeRoleWithSAMLCommandInput);
160
+ /**
161
+ * @internal
162
+ */
163
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssumeRoleWithSAMLCommandInput, AssumeRoleWithSAMLCommandOutput>;
164
+ private serialize;
165
+ private deserialize;
166
+ }
@@ -1,39 +1,170 @@
1
- import { Command as $Command } from "@aws-sdk/smithy-client";
2
- import {
3
- Handler,
4
- HttpHandlerOptions as __HttpHandlerOptions,
5
- MetadataBearer as __MetadataBearer,
6
- MiddlewareStack,
7
- } from "@aws-sdk/types";
8
- import {
9
- AssumeRoleWithWebIdentityRequest,
10
- AssumeRoleWithWebIdentityResponse,
11
- } from "../models/models_0";
12
- import {
13
- ServiceInputTypes,
14
- ServiceOutputTypes,
15
- STSClientResolvedConfig,
16
- } from "../STSClient";
17
- export interface AssumeRoleWithWebIdentityCommandInput
18
- extends AssumeRoleWithWebIdentityRequest {}
19
- export interface AssumeRoleWithWebIdentityCommandOutput
20
- extends AssumeRoleWithWebIdentityResponse,
21
- __MetadataBearer {}
22
- export declare class AssumeRoleWithWebIdentityCommand extends $Command<
23
- AssumeRoleWithWebIdentityCommandInput,
24
- AssumeRoleWithWebIdentityCommandOutput,
25
- STSClientResolvedConfig
26
- > {
27
- readonly input: AssumeRoleWithWebIdentityCommandInput;
28
- constructor(input: AssumeRoleWithWebIdentityCommandInput);
29
- resolveMiddleware(
30
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
31
- configuration: STSClientResolvedConfig,
32
- options?: __HttpHandlerOptions
33
- ): Handler<
34
- AssumeRoleWithWebIdentityCommandInput,
35
- AssumeRoleWithWebIdentityCommandOutput
36
- >;
37
- private serialize;
38
- private deserialize;
39
- }
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { AssumeRoleWithWebIdentityRequest, AssumeRoleWithWebIdentityResponse } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
5
+ export interface AssumeRoleWithWebIdentityCommandInput extends AssumeRoleWithWebIdentityRequest {
6
+ }
7
+ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWebIdentityResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Returns a set of temporary security credentials for users who have been authenticated in
11
+ * a mobile or web application with a web identity provider. Example providers include the
12
+ * OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible
13
+ * identity provider such as Google or <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito federated identities</a>.</p>
14
+ * <note>
15
+ * <p>For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the
16
+ * <a href="http://aws.amazon.com/sdkforios/">Amazon Web Services SDK for iOS Developer Guide</a> and the <a href="http://aws.amazon.com/sdkforandroid/">Amazon Web Services SDK for Android Developer Guide</a> to uniquely
17
+ * identify a user. You can also supply the user with a consistent identity throughout the
18
+ * lifetime of an application.</p>
19
+ * <p>To learn more about Amazon Cognito, see <a href="https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in
20
+ * <i>Amazon Web Services SDK for Android Developer Guide</i> and <a href="https://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664">Amazon Cognito Overview</a> in the
21
+ * <i>Amazon Web Services SDK for iOS Developer Guide</i>.</p>
22
+ * </note>
23
+ * <p>Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of Amazon Web Services
24
+ * security credentials. Therefore, you can distribute an application (for example, on mobile
25
+ * devices) that requests temporary security credentials without including long-term Amazon Web Services
26
+ * credentials in the application. You also don't need to deploy server-based proxy services
27
+ * that use long-term Amazon Web Services credentials. Instead, the identity of the caller is validated by
28
+ * using a token from the web identity provider. For a comparison of
29
+ * <code>AssumeRoleWithWebIdentity</code> with the other API operations that produce
30
+ * temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
31
+ * Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the
32
+ * Amazon Web Services STS API operations</a> in the <i>IAM User Guide</i>.</p>
33
+ * <p>The temporary security credentials returned by this API consist of an access key ID, a
34
+ * secret access key, and a security token. Applications can use these temporary security
35
+ * credentials to sign calls to Amazon Web Services service API operations.</p>
36
+ * <p>
37
+ * <b>Session Duration</b>
38
+ * </p>
39
+ * <p>By default, the temporary security credentials created by
40
+ * <code>AssumeRoleWithWebIdentity</code> last for one hour. However, you can use the
41
+ * optional <code>DurationSeconds</code> parameter to specify the duration of your session.
42
+ * You can provide a value from 900 seconds (15 minutes) up to the maximum session duration
43
+ * setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how
44
+ * 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
45
+ * Maximum Session Duration Setting for a Role</a> in the
46
+ * <i>IAM User Guide</i>. The maximum session duration limit applies when
47
+ * you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI
48
+ * commands. However the limit does not apply when you use those operations to create a
49
+ * console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the
50
+ * <i>IAM User Guide</i>. </p>
51
+ * <p>
52
+ * <b>Permissions</b>
53
+ * </p>
54
+ * <p>The temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> can
55
+ * be used to make API calls to any Amazon Web Services service with the following exception: you cannot
56
+ * call the STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API
57
+ * operations.</p>
58
+ * <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to
59
+ * this operation. You can pass a single JSON policy document to use as an inline session
60
+ * policy. You can also specify up to 10 managed policies to use as managed session policies.
61
+ * The plaintext that you use for both inline and managed session policies can't exceed 2,048
62
+ * characters. Passing policies to this operation returns new
63
+ * temporary credentials. The resulting session's permissions are the intersection of the
64
+ * role's identity-based policy and the session policies. You can use the role's temporary
65
+ * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
66
+ * the role. You cannot use session policies to grant more permissions than those allowed
67
+ * by the identity-based policy of the role that is being assumed. For more information, see
68
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
69
+ * Policies</a> in the <i>IAM User Guide</i>.</p>
70
+ * <p>
71
+ * <b>Tags</b>
72
+ * </p>
73
+ * <p>(Optional) You can configure your IdP to pass attributes into your web identity token as
74
+ * session tags. Each session tag consists of a key name and an associated value. For more
75
+ * 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
+ * <i>IAM User Guide</i>.</p>
77
+ * <p>You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128
78
+ * characters and the values can’t exceed 256 characters. For these and additional limits, see
79
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
80
+ * and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
81
+ *
82
+ * <note>
83
+ * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
84
+ * packed binary format that has a separate limit. Your request can fail for this limit
85
+ * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
86
+ * response element indicates by percentage how close the policies and tags for your
87
+ * request are to the upper size limit.
88
+ * </p>
89
+ * </note>
90
+ *
91
+ * <p>You can pass a session tag with the same key as a tag that is attached to the role. When
92
+ * you do, the session tag overrides the role tag with the same key.</p>
93
+ * <p>An administrator must grant you the permissions necessary to pass session tags. The
94
+ * administrator can also create granular permissions to allow you to pass only specific
95
+ * 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
96
+ * for Attribute-Based Access Control</a> in the
97
+ * <i>IAM User Guide</i>.</p>
98
+ * <p>You can set the session tags as transitive. Transitive tags persist during role
99
+ * chaining. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html#id_session-tags_role-chaining">Chaining Roles
100
+ * with Session Tags</a> in the <i>IAM User Guide</i>.</p>
101
+ * <p>
102
+ * <b>Identities</b>
103
+ * </p>
104
+ * <p>Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have
105
+ * an identity token from a supported identity provider and create a role that the application
106
+ * can assume. The role that your application assumes must trust the identity provider that is
107
+ * associated with the identity token. In other words, the identity provider must be specified
108
+ * in the role's trust policy. </p>
109
+ * <important>
110
+ * <p>Calling <code>AssumeRoleWithWebIdentity</code> can result in an entry in your
111
+ * CloudTrail logs. The entry includes the <a href="http://openid.net/specs/openid-connect-core-1_0.html#Claims">Subject</a> of
112
+ * the provided web identity token. We recommend that you avoid using any personally
113
+ * identifiable information (PII) in this field. For example, you could instead use a GUID
114
+ * or a pairwise identifier, as <a href="http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes">suggested
115
+ * in the OIDC specification</a>.</p>
116
+ * </important>
117
+ * <p>For more information about how to use web identity federation and the
118
+ * <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </p>
119
+ * <ul>
120
+ * <li>
121
+ * <p>
122
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html">Using Web Identity Federation API Operations for Mobile Apps</a> and <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>. </p>
123
+ * </li>
124
+ * <li>
125
+ * <p>
126
+ * <a href="https://aws.amazon.com/blogs/aws/the-aws-web-identity-federation-playground/"> Web Identity Federation Playground</a>. Walk through the process of
127
+ * authenticating through Login with Amazon, Facebook, or Google, getting temporary
128
+ * security credentials, and then using those credentials to make a request to Amazon Web Services.
129
+ * </p>
130
+ * </li>
131
+ * <li>
132
+ * <p>
133
+ * <a href="http://aws.amazon.com/sdkforios/">Amazon Web Services SDK for iOS Developer Guide</a> and <a href="http://aws.amazon.com/sdkforandroid/">Amazon Web Services SDK for Android Developer Guide</a>. These toolkits
134
+ * contain sample apps that show how to invoke the identity providers. The toolkits then
135
+ * show how to use the information from these providers to get and use temporary
136
+ * security credentials. </p>
137
+ * </li>
138
+ * <li>
139
+ * <p>
140
+ * <a href="http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications">Web Identity
141
+ * Federation with Mobile Applications</a>. This article discusses web identity
142
+ * federation and shows an example of how to use web identity federation to get access
143
+ * to content in Amazon S3. </p>
144
+ * </li>
145
+ * </ul>
146
+ * @example
147
+ * Use a bare-bones client and the command you need to make an API call.
148
+ * ```javascript
149
+ * import { STSClient, AssumeRoleWithWebIdentityCommand } from "@aws-sdk/client-sts"; // ES Modules import
150
+ * // const { STSClient, AssumeRoleWithWebIdentityCommand } = require("@aws-sdk/client-sts"); // CommonJS import
151
+ * const client = new STSClient(config);
152
+ * const command = new AssumeRoleWithWebIdentityCommand(input);
153
+ * const response = await client.send(command);
154
+ * ```
155
+ *
156
+ * @see {@link AssumeRoleWithWebIdentityCommandInput} for command's `input` shape.
157
+ * @see {@link AssumeRoleWithWebIdentityCommandOutput} for command's `response` shape.
158
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
159
+ *
160
+ */
161
+ export declare class AssumeRoleWithWebIdentityCommand extends $Command<AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput, STSClientResolvedConfig> {
162
+ readonly input: AssumeRoleWithWebIdentityCommandInput;
163
+ constructor(input: AssumeRoleWithWebIdentityCommandInput);
164
+ /**
165
+ * @internal
166
+ */
167
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput>;
168
+ private serialize;
169
+ private deserialize;
170
+ }
@@ -1,39 +1,70 @@
1
- import { Command as $Command } from "@aws-sdk/smithy-client";
2
- import {
3
- Handler,
4
- HttpHandlerOptions as __HttpHandlerOptions,
5
- MetadataBearer as __MetadataBearer,
6
- MiddlewareStack,
7
- } from "@aws-sdk/types";
8
- import {
9
- DecodeAuthorizationMessageRequest,
10
- DecodeAuthorizationMessageResponse,
11
- } from "../models/models_0";
12
- import {
13
- ServiceInputTypes,
14
- ServiceOutputTypes,
15
- STSClientResolvedConfig,
16
- } from "../STSClient";
17
- export interface DecodeAuthorizationMessageCommandInput
18
- extends DecodeAuthorizationMessageRequest {}
19
- export interface DecodeAuthorizationMessageCommandOutput
20
- extends DecodeAuthorizationMessageResponse,
21
- __MetadataBearer {}
22
- export declare class DecodeAuthorizationMessageCommand extends $Command<
23
- DecodeAuthorizationMessageCommandInput,
24
- DecodeAuthorizationMessageCommandOutput,
25
- STSClientResolvedConfig
26
- > {
27
- readonly input: DecodeAuthorizationMessageCommandInput;
28
- constructor(input: DecodeAuthorizationMessageCommandInput);
29
- resolveMiddleware(
30
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
31
- configuration: STSClientResolvedConfig,
32
- options?: __HttpHandlerOptions
33
- ): Handler<
34
- DecodeAuthorizationMessageCommandInput,
35
- DecodeAuthorizationMessageCommandOutput
36
- >;
37
- private serialize;
38
- private deserialize;
39
- }
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { DecodeAuthorizationMessageRequest, DecodeAuthorizationMessageResponse } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
5
+ export interface DecodeAuthorizationMessageCommandInput extends DecodeAuthorizationMessageRequest {
6
+ }
7
+ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthorizationMessageResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Decodes additional information about the authorization status of a request from an
11
+ * encoded message returned in response to an Amazon Web Services request.</p>
12
+ * <p>For example, if a user is not authorized to perform an operation that he or she has
13
+ * requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an
14
+ * HTTP 403 response). Some Amazon Web Services operations additionally return an encoded message that can
15
+ * provide details about this authorization failure. </p>
16
+ * <note>
17
+ * <p>Only certain Amazon Web Services operations return an encoded authorization message. The
18
+ * documentation for an individual operation indicates whether that operation returns an
19
+ * encoded message in addition to returning an HTTP code.</p>
20
+ * </note>
21
+ * <p>The message is encoded because the details of the authorization status can contain
22
+ * privileged information that the user who requested the operation should not see. To decode
23
+ * an authorization status message, a user must be granted permissions through an IAM <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">policy</a> to
24
+ * request the <code>DecodeAuthorizationMessage</code>
25
+ * (<code>sts:DecodeAuthorizationMessage</code>) action. </p>
26
+ * <p>The decoded message includes the following type of information:</p>
27
+ * <ul>
28
+ * <li>
29
+ * <p>Whether the request was denied due to an explicit deny or due to the absence of an
30
+ * explicit allow. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the
31
+ * <i>IAM User Guide</i>. </p>
32
+ * </li>
33
+ * <li>
34
+ * <p>The principal who made the request.</p>
35
+ * </li>
36
+ * <li>
37
+ * <p>The requested action.</p>
38
+ * </li>
39
+ * <li>
40
+ * <p>The requested resource.</p>
41
+ * </li>
42
+ * <li>
43
+ * <p>The values of condition keys in the context of the user's request.</p>
44
+ * </li>
45
+ * </ul>
46
+ * @example
47
+ * Use a bare-bones client and the command you need to make an API call.
48
+ * ```javascript
49
+ * import { STSClient, DecodeAuthorizationMessageCommand } from "@aws-sdk/client-sts"; // ES Modules import
50
+ * // const { STSClient, DecodeAuthorizationMessageCommand } = require("@aws-sdk/client-sts"); // CommonJS import
51
+ * const client = new STSClient(config);
52
+ * const command = new DecodeAuthorizationMessageCommand(input);
53
+ * const response = await client.send(command);
54
+ * ```
55
+ *
56
+ * @see {@link DecodeAuthorizationMessageCommandInput} for command's `input` shape.
57
+ * @see {@link DecodeAuthorizationMessageCommandOutput} for command's `response` shape.
58
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
59
+ *
60
+ */
61
+ export declare class DecodeAuthorizationMessageCommand extends $Command<DecodeAuthorizationMessageCommandInput, DecodeAuthorizationMessageCommandOutput, STSClientResolvedConfig> {
62
+ readonly input: DecodeAuthorizationMessageCommandInput;
63
+ constructor(input: DecodeAuthorizationMessageCommandInput);
64
+ /**
65
+ * @internal
66
+ */
67
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DecodeAuthorizationMessageCommandInput, DecodeAuthorizationMessageCommandOutput>;
68
+ private serialize;
69
+ private deserialize;
70
+ }
@@ -1,35 +1,52 @@
1
- import { Command as $Command } from "@aws-sdk/smithy-client";
2
- import {
3
- Handler,
4
- HttpHandlerOptions as __HttpHandlerOptions,
5
- MetadataBearer as __MetadataBearer,
6
- MiddlewareStack,
7
- } from "@aws-sdk/types";
8
- import {
9
- GetAccessKeyInfoRequest,
10
- GetAccessKeyInfoResponse,
11
- } from "../models/models_0";
12
- import {
13
- ServiceInputTypes,
14
- ServiceOutputTypes,
15
- STSClientResolvedConfig,
16
- } from "../STSClient";
17
- export interface GetAccessKeyInfoCommandInput extends GetAccessKeyInfoRequest {}
18
- export interface GetAccessKeyInfoCommandOutput
19
- extends GetAccessKeyInfoResponse,
20
- __MetadataBearer {}
21
- export declare class GetAccessKeyInfoCommand extends $Command<
22
- GetAccessKeyInfoCommandInput,
23
- GetAccessKeyInfoCommandOutput,
24
- STSClientResolvedConfig
25
- > {
26
- readonly input: GetAccessKeyInfoCommandInput;
27
- constructor(input: GetAccessKeyInfoCommandInput);
28
- resolveMiddleware(
29
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
30
- configuration: STSClientResolvedConfig,
31
- options?: __HttpHandlerOptions
32
- ): Handler<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput>;
33
- private serialize;
34
- private deserialize;
35
- }
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { GetAccessKeyInfoRequest, GetAccessKeyInfoResponse } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
5
+ export interface GetAccessKeyInfoCommandInput extends GetAccessKeyInfoRequest {
6
+ }
7
+ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse, __MetadataBearer {
8
+ }
9
+ /**
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 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
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { STSClient, GetAccessKeyInfoCommand } from "@aws-sdk/client-sts"; // ES Modules import
32
+ * // const { STSClient, GetAccessKeyInfoCommand } = require("@aws-sdk/client-sts"); // CommonJS import
33
+ * const client = new STSClient(config);
34
+ * const command = new GetAccessKeyInfoCommand(input);
35
+ * const response = await client.send(command);
36
+ * ```
37
+ *
38
+ * @see {@link GetAccessKeyInfoCommandInput} for command's `input` shape.
39
+ * @see {@link GetAccessKeyInfoCommandOutput} for command's `response` shape.
40
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
41
+ *
42
+ */
43
+ export declare class GetAccessKeyInfoCommand extends $Command<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput, STSClientResolvedConfig> {
44
+ readonly input: GetAccessKeyInfoCommandInput;
45
+ constructor(input: GetAccessKeyInfoCommandInput);
46
+ /**
47
+ * @internal
48
+ */
49
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: STSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccessKeyInfoCommandInput, GetAccessKeyInfoCommandOutput>;
50
+ private serialize;
51
+ private deserialize;
52
+ }