@aws-sdk/client-sts 3.33.0 → 3.36.1

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 (189) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/STS.js +1 -9
  3. package/dist-cjs/STSClient.js +34 -0
  4. package/dist-cjs/commands/AssumeRoleCommand.js +38 -0
  5. package/dist-cjs/commands/AssumeRoleWithSAMLCommand.js +36 -0
  6. package/dist-cjs/commands/AssumeRoleWithWebIdentityCommand.js +36 -0
  7. package/dist-cjs/commands/DecodeAuthorizationMessageCommand.js +38 -0
  8. package/dist-cjs/commands/GetAccessKeyInfoCommand.js +38 -0
  9. package/dist-cjs/commands/GetCallerIdentityCommand.js +38 -0
  10. package/dist-cjs/commands/GetFederationTokenCommand.js +38 -0
  11. package/dist-cjs/commands/GetSessionTokenCommand.js +38 -0
  12. package/{dist/cjs → dist-cjs}/defaultRoleAssumers.js +0 -17
  13. package/{dist/cjs → dist-cjs}/defaultStsRoleAssumers.js +0 -21
  14. package/{dist/cjs → dist-cjs}/endpoints.js +0 -1
  15. package/{dist/cjs → dist-cjs}/index.js +0 -1
  16. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  17. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -88
  18. package/{dist/cjs → dist-cjs}/protocols/Aws_query.js +22 -25
  19. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  20. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  21. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  22. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  23. package/{dist/es → dist-es}/STS.js +2 -10
  24. package/{dist/es → dist-es}/STSClient.js +2 -15
  25. package/dist-es/commands/AssumeRoleCommand.js +41 -0
  26. package/dist-es/commands/AssumeRoleWithSAMLCommand.js +39 -0
  27. package/dist-es/commands/AssumeRoleWithWebIdentityCommand.js +39 -0
  28. package/dist-es/commands/DecodeAuthorizationMessageCommand.js +41 -0
  29. package/dist-es/commands/GetAccessKeyInfoCommand.js +41 -0
  30. package/{dist/es → dist-es}/commands/GetCallerIdentityCommand.js +4 -39
  31. package/dist-es/commands/GetFederationTokenCommand.js +41 -0
  32. package/dist-es/commands/GetSessionTokenCommand.js +41 -0
  33. package/dist-es/defaultRoleAssumers.js +16 -0
  34. package/{dist/es → dist-es}/defaultStsRoleAssumers.js +10 -32
  35. package/{dist/es → dist-es}/endpoints.js +1 -2
  36. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  37. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  38. package/{dist/es → dist-es}/models/models_0.js +0 -88
  39. package/{dist/es → dist-es}/protocols/Aws_query.js +152 -155
  40. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -5
  41. package/{dist/es → dist-es}/runtimeConfig.js +1 -5
  42. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -4
  43. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -5
  44. package/{dist/types → dist-types}/STS.d.ts +2 -2
  45. package/{dist/types → dist-types}/STSClient.d.ts +8 -8
  46. package/{dist/types → dist-types}/commands/AssumeRoleCommand.d.ts +3 -3
  47. package/{dist/types → dist-types}/commands/AssumeRoleWithSAMLCommand.d.ts +3 -3
  48. package/{dist/types → dist-types}/commands/AssumeRoleWithWebIdentityCommand.d.ts +3 -3
  49. package/{dist/types → dist-types}/commands/DecodeAuthorizationMessageCommand.d.ts +3 -3
  50. package/{dist/types → dist-types}/commands/GetAccessKeyInfoCommand.d.ts +3 -3
  51. package/{dist/types → dist-types}/commands/GetCallerIdentityCommand.d.ts +3 -3
  52. package/{dist/types → dist-types}/commands/GetFederationTokenCommand.d.ts +3 -3
  53. package/{dist/types → dist-types}/commands/GetSessionTokenCommand.d.ts +3 -3
  54. package/{dist/types → dist-types}/defaultRoleAssumers.d.ts +0 -0
  55. package/{dist/types → dist-types}/defaultStsRoleAssumers.d.ts +0 -0
  56. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  57. package/{index.ts → dist-types/index.d.ts} +0 -0
  58. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  59. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  60. package/{dist/types → dist-types}/protocols/Aws_query.d.ts +2 -2
  61. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  62. package/{dist/types → dist-types}/runtimeConfig.d.ts +0 -0
  63. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  64. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  65. package/dist-types/ts3.4/STS.d.ts +45 -0
  66. package/{dist/types → dist-types}/ts3.4/STSClient.d.ts +32 -101
  67. package/dist-types/ts3.4/commands/AssumeRoleCommand.d.ts +17 -0
  68. package/dist-types/ts3.4/commands/AssumeRoleWithSAMLCommand.d.ts +17 -0
  69. package/dist-types/ts3.4/commands/AssumeRoleWithWebIdentityCommand.d.ts +17 -0
  70. package/dist-types/ts3.4/commands/DecodeAuthorizationMessageCommand.d.ts +17 -0
  71. package/dist-types/ts3.4/commands/GetAccessKeyInfoCommand.d.ts +17 -0
  72. package/dist-types/ts3.4/commands/GetCallerIdentityCommand.d.ts +17 -0
  73. package/dist-types/ts3.4/commands/GetFederationTokenCommand.d.ts +17 -0
  74. package/dist-types/ts3.4/commands/GetSessionTokenCommand.d.ts +17 -0
  75. package/dist-types/ts3.4/defaultRoleAssumers.d.ts +8 -0
  76. package/{dist/types → dist-types}/ts3.4/defaultStsRoleAssumers.d.ts +6 -25
  77. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  78. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  79. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  80. package/dist-types/ts3.4/models/models_0.d.ts +367 -0
  81. package/{dist/types → dist-types}/ts3.4/protocols/Aws_query.d.ts +2 -2
  82. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  83. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +1 -3
  84. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  85. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  86. package/package.json +52 -49
  87. package/STS.ts +0 -896
  88. package/STSClient.ts +0 -263
  89. package/commands/AssumeRoleCommand.ts +0 -176
  90. package/commands/AssumeRoleWithSAMLCommand.ts +0 -225
  91. package/commands/AssumeRoleWithWebIdentityCommand.ts +0 -232
  92. package/commands/DecodeAuthorizationMessageCommand.ts +0 -134
  93. package/commands/GetAccessKeyInfoCommand.ts +0 -113
  94. package/commands/GetCallerIdentityCommand.ts +0 -105
  95. package/commands/GetFederationTokenCommand.ts +0 -234
  96. package/commands/GetSessionTokenCommand.ts +0 -147
  97. package/defaultRoleAssumers.spec.ts +0 -148
  98. package/defaultRoleAssumers.ts +0 -41
  99. package/defaultStsRoleAssumers.ts +0 -126
  100. package/dist/cjs/STS.js.map +0 -1
  101. package/dist/cjs/STSClient.js +0 -47
  102. package/dist/cjs/STSClient.js.map +0 -1
  103. package/dist/cjs/commands/AssumeRoleCommand.js +0 -146
  104. package/dist/cjs/commands/AssumeRoleCommand.js.map +0 -1
  105. package/dist/cjs/commands/AssumeRoleWithSAMLCommand.js +0 -192
  106. package/dist/cjs/commands/AssumeRoleWithSAMLCommand.js.map +0 -1
  107. package/dist/cjs/commands/AssumeRoleWithWebIdentityCommand.js +0 -196
  108. package/dist/cjs/commands/AssumeRoleWithWebIdentityCommand.js.map +0 -1
  109. package/dist/cjs/commands/DecodeAuthorizationMessageCommand.js +0 -98
  110. package/dist/cjs/commands/DecodeAuthorizationMessageCommand.js.map +0 -1
  111. package/dist/cjs/commands/GetAccessKeyInfoCommand.js +0 -80
  112. package/dist/cjs/commands/GetAccessKeyInfoCommand.js.map +0 -1
  113. package/dist/cjs/commands/GetCallerIdentityCommand.js +0 -72
  114. package/dist/cjs/commands/GetCallerIdentityCommand.js.map +0 -1
  115. package/dist/cjs/commands/GetFederationTokenCommand.js +0 -201
  116. package/dist/cjs/commands/GetFederationTokenCommand.js.map +0 -1
  117. package/dist/cjs/commands/GetSessionTokenCommand.js +0 -114
  118. package/dist/cjs/commands/GetSessionTokenCommand.js.map +0 -1
  119. package/dist/cjs/defaultRoleAssumers.js.map +0 -1
  120. package/dist/cjs/defaultRoleAssumers.spec.js +0 -135
  121. package/dist/cjs/defaultRoleAssumers.spec.js.map +0 -1
  122. package/dist/cjs/defaultStsRoleAssumers.js.map +0 -1
  123. package/dist/cjs/endpoints.js.map +0 -1
  124. package/dist/cjs/index.js.map +0 -1
  125. package/dist/cjs/models/index.js.map +0 -1
  126. package/dist/cjs/models/models_0.js.map +0 -1
  127. package/dist/cjs/package.json +0 -93
  128. package/dist/cjs/protocols/Aws_query.js.map +0 -1
  129. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  130. package/dist/cjs/runtimeConfig.js.map +0 -1
  131. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  132. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  133. package/dist/es/STS.js.map +0 -1
  134. package/dist/es/STSClient.js.map +0 -1
  135. package/dist/es/commands/AssumeRoleCommand.js +0 -150
  136. package/dist/es/commands/AssumeRoleCommand.js.map +0 -1
  137. package/dist/es/commands/AssumeRoleWithSAMLCommand.js +0 -196
  138. package/dist/es/commands/AssumeRoleWithSAMLCommand.js.map +0 -1
  139. package/dist/es/commands/AssumeRoleWithWebIdentityCommand.js +0 -200
  140. package/dist/es/commands/AssumeRoleWithWebIdentityCommand.js.map +0 -1
  141. package/dist/es/commands/DecodeAuthorizationMessageCommand.js +0 -102
  142. package/dist/es/commands/DecodeAuthorizationMessageCommand.js.map +0 -1
  143. package/dist/es/commands/GetAccessKeyInfoCommand.js +0 -84
  144. package/dist/es/commands/GetAccessKeyInfoCommand.js.map +0 -1
  145. package/dist/es/commands/GetCallerIdentityCommand.js.map +0 -1
  146. package/dist/es/commands/GetFederationTokenCommand.js +0 -205
  147. package/dist/es/commands/GetFederationTokenCommand.js.map +0 -1
  148. package/dist/es/commands/GetSessionTokenCommand.js +0 -118
  149. package/dist/es/commands/GetSessionTokenCommand.js.map +0 -1
  150. package/dist/es/defaultRoleAssumers.js +0 -33
  151. package/dist/es/defaultRoleAssumers.js.map +0 -1
  152. package/dist/es/defaultRoleAssumers.spec.js +0 -142
  153. package/dist/es/defaultRoleAssumers.spec.js.map +0 -1
  154. package/dist/es/defaultStsRoleAssumers.js.map +0 -1
  155. package/dist/es/endpoints.js.map +0 -1
  156. package/dist/es/index.js +0 -13
  157. package/dist/es/index.js.map +0 -1
  158. package/dist/es/models/index.js +0 -2
  159. package/dist/es/models/index.js.map +0 -1
  160. package/dist/es/models/models_0.js.map +0 -1
  161. package/dist/es/package.json +0 -93
  162. package/dist/es/protocols/Aws_query.js.map +0 -1
  163. package/dist/es/runtimeConfig.browser.js.map +0 -1
  164. package/dist/es/runtimeConfig.js.map +0 -1
  165. package/dist/es/runtimeConfig.native.js.map +0 -1
  166. package/dist/es/runtimeConfig.shared.js.map +0 -1
  167. package/dist/types/defaultRoleAssumers.spec.d.ts +0 -1
  168. package/dist/types/ts3.4/STS.d.ts +0 -666
  169. package/dist/types/ts3.4/commands/AssumeRoleCommand.d.ts +0 -118
  170. package/dist/types/ts3.4/commands/AssumeRoleWithSAMLCommand.d.ts +0 -166
  171. package/dist/types/ts3.4/commands/AssumeRoleWithWebIdentityCommand.d.ts +0 -170
  172. package/dist/types/ts3.4/commands/DecodeAuthorizationMessageCommand.d.ts +0 -70
  173. package/dist/types/ts3.4/commands/GetAccessKeyInfoCommand.d.ts +0 -52
  174. package/dist/types/ts3.4/commands/GetCallerIdentityCommand.d.ts +0 -44
  175. package/dist/types/ts3.4/commands/GetFederationTokenCommand.d.ts +0 -173
  176. package/dist/types/ts3.4/commands/GetSessionTokenCommand.d.ts +0 -86
  177. package/dist/types/ts3.4/defaultRoleAssumers.d.ts +0 -19
  178. package/dist/types/ts3.4/defaultRoleAssumers.spec.d.ts +0 -1
  179. package/dist/types/ts3.4/models/models_0.d.ts +0 -1192
  180. package/endpoints.ts +0 -91
  181. package/jest.config.js +0 -4
  182. package/models/models_0.ts +0 -1361
  183. package/protocols/Aws_query.ts +0 -1513
  184. package/runtimeConfig.browser.ts +0 -40
  185. package/runtimeConfig.native.ts +0 -16
  186. package/runtimeConfig.shared.ts +0 -16
  187. package/runtimeConfig.ts +0 -45
  188. package/tsconfig.es.json +0 -12
  189. package/tsconfig.json +0 -32
@@ -1,1361 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>The identifiers for the temporary security credentials that the operation
5
- * returns.</p>
6
- */
7
- export interface AssumedRoleUser {
8
- /**
9
- * <p>A unique identifier that contains the role ID and the role session name of the role that
10
- * is being assumed. The role ID is generated by Amazon Web Services when the role is created.</p>
11
- */
12
- AssumedRoleId: string | undefined;
13
-
14
- /**
15
- * <p>The ARN of the temporary security credentials that are returned from the <a>AssumeRole</a> action. For more information about ARNs and how to use them in
16
- * policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the
17
- * <i>IAM User Guide</i>.</p>
18
- */
19
- Arn: string | undefined;
20
- }
21
-
22
- export namespace AssumedRoleUser {
23
- /**
24
- * @internal
25
- */
26
- export const filterSensitiveLog = (obj: AssumedRoleUser): any => ({
27
- ...obj,
28
- });
29
- }
30
-
31
- /**
32
- * <p>A reference to the IAM managed policy that is passed as a session policy for a role
33
- * session or a federated user session.</p>
34
- */
35
- export interface PolicyDescriptorType {
36
- /**
37
- * <p>The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy
38
- * for the role. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services
39
- * Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
40
- */
41
- arn?: string;
42
- }
43
-
44
- export namespace PolicyDescriptorType {
45
- /**
46
- * @internal
47
- */
48
- export const filterSensitiveLog = (obj: PolicyDescriptorType): any => ({
49
- ...obj,
50
- });
51
- }
52
-
53
- /**
54
- * <p>You can pass custom key-value pair attributes when you assume a role or federate a user.
55
- * These are called session tags. You can then use the session tags to control access to
56
- * resources. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Tagging STS Sessions</a> in the
57
- * <i>IAM User Guide</i>.</p>
58
- */
59
- export interface Tag {
60
- /**
61
- * <p>The key for a session tag.</p>
62
- * <p>You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128
63
- * characters. For these and additional limits, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
64
- * and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
65
- */
66
- Key: string | undefined;
67
-
68
- /**
69
- * <p>The value for a session tag.</p>
70
- * <p>You can pass up to 50 session tags. The plain text session tag values can’t exceed 256
71
- * characters. For these and additional limits, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
72
- * and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
73
- */
74
- Value: string | undefined;
75
- }
76
-
77
- export namespace Tag {
78
- /**
79
- * @internal
80
- */
81
- export const filterSensitiveLog = (obj: Tag): any => ({
82
- ...obj,
83
- });
84
- }
85
-
86
- export interface AssumeRoleRequest {
87
- /**
88
- * <p>The Amazon Resource Name (ARN) of the role to assume.</p>
89
- */
90
- RoleArn: string | undefined;
91
-
92
- /**
93
- * <p>An identifier for the assumed role session.</p>
94
- * <p>Use the role session name to uniquely identify a session when the same role is assumed
95
- * by different principals or for different reasons. In cross-account scenarios, the role
96
- * session name is visible to, and can be logged by the account that owns the role. The role
97
- * session name is also used in the ARN of the assumed role principal. This means that
98
- * subsequent cross-account API requests that use the temporary security credentials will
99
- * expose the role session name to the external account in their CloudTrail logs.</p>
100
- * <p>The regex used to validate this parameter is a string of characters
101
- * consisting of upper- and lower-case alphanumeric characters with no spaces. You can
102
- * also include underscores or any of the following characters: =,.@-</p>
103
- */
104
- RoleSessionName: string | undefined;
105
-
106
- /**
107
- * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as
108
- * managed session policies. The policies must exist in the same account as the role.</p>
109
- * <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the
110
- * plaintext that you use for both inline and managed session policies can't exceed 2,048
111
- * characters. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services
112
- * Service Namespaces</a> in the Amazon Web Services General Reference.</p>
113
- * <note>
114
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
115
- * packed binary format that has a separate limit. Your request can fail for this limit
116
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
117
- * response element indicates by percentage how close the policies and tags for your
118
- * request are to the upper size limit.
119
- * </p>
120
- * </note>
121
- *
122
- * <p>Passing policies to this operation returns new
123
- * temporary credentials. The resulting session's permissions are the intersection of the
124
- * role's identity-based policy and the session policies. You can use the role's temporary
125
- * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
126
- * the role. You cannot use session policies to grant more permissions than those allowed
127
- * by the identity-based policy of the role that is being assumed. For more information, see
128
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
129
- * Policies</a> in the <i>IAM User Guide</i>.</p>
130
- */
131
- PolicyArns?: PolicyDescriptorType[];
132
-
133
- /**
134
- * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
135
- * <p>This parameter is optional. Passing policies to this operation returns new
136
- * temporary credentials. The resulting session's permissions are the intersection of the
137
- * role's identity-based policy and the session policies. You can use the role's temporary
138
- * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
139
- * the role. You cannot use session policies to grant more permissions than those allowed
140
- * by the identity-based policy of the role that is being assumed. For more information, see
141
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
142
- * Policies</a> in the <i>IAM User Guide</i>.</p>
143
- * <p>The plaintext that you use for both inline and managed session policies can't exceed
144
- * 2,048 characters. The JSON policy characters can be any ASCII character from the space
145
- * character to the end of the valid character list (\u0020 through \u00FF). It can also
146
- * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
147
- * characters.</p>
148
- * <note>
149
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
150
- * packed binary format that has a separate limit. Your request can fail for this limit
151
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
152
- * response element indicates by percentage how close the policies and tags for your
153
- * request are to the upper size limit.
154
- * </p>
155
- * </note>
156
- */
157
- Policy?: string;
158
-
159
- /**
160
- * <p>The duration, in seconds, of the role session. The value specified can can range from
161
- * 900 seconds (15 minutes) up to the maximum session duration that is set for the role. The
162
- * maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a
163
- * value higher than this setting or the administrator setting (whichever is lower), the
164
- * operation fails. For example, if you specify a session duration of 12 hours, but your
165
- * administrator set the maximum session duration to 6 hours, your operation fails. To learn
166
- * 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
167
- * Maximum Session Duration Setting for a Role</a> in the
168
- * <i>IAM User Guide</i>.</p>
169
- * <p>By default, the value is set to <code>3600</code> seconds. </p>
170
- * <note>
171
- * <p>The <code>DurationSeconds</code> parameter is separate from the duration of a console
172
- * session that you might request using the returned credentials. The request to the
173
- * federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
174
- * parameter that specifies the maximum length of the console session. For more
175
- * information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
176
- * that Enables Federated Users to Access the Management Console</a> in the
177
- * <i>IAM User Guide</i>.</p>
178
- * </note>
179
- */
180
- DurationSeconds?: number;
181
-
182
- /**
183
- * <p>A list of session tags that you want to pass. Each session tag consists of a key name
184
- * and an associated value. For more information about session tags, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Tagging STS
185
- * Sessions</a> in the <i>IAM User Guide</i>.</p>
186
- * <p>This parameter is optional. You can pass up to 50 session tags. The plaintext session
187
- * tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these
188
- * and additional limits, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
189
- * and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
190
- *
191
- * <note>
192
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
193
- * packed binary format that has a separate limit. Your request can fail for this limit
194
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
195
- * response element indicates by percentage how close the policies and tags for your
196
- * request are to the upper size limit.
197
- * </p>
198
- * </note>
199
- * <p>You can pass a session tag with the same key as a tag that is already
200
- * attached to the role. When you do, session tags override a role tag with the same key. </p>
201
- * <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
202
- * cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
203
- * that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the
204
- * <code>department</code>=<code>engineering</code> session tag. <code>Department</code>
205
- * and <code>department</code> are not saved as separate tags, and the session tag passed in
206
- * the request takes precedence over the role tag.</p>
207
- * <p>Additionally, if you used temporary credentials to perform this operation, the new
208
- * session inherits any transitive session tags from the calling session. If you pass a
209
- * session tag with the same key as an inherited tag, the operation fails. To view the
210
- * inherited tags for a session, see the CloudTrail logs. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/session-tags.html#id_session-tags_ctlogs">Viewing Session Tags in CloudTrail</a> in the
211
- * <i>IAM User Guide</i>.</p>
212
- */
213
- Tags?: Tag[];
214
-
215
- /**
216
- * <p>A list of keys for session tags that you want to set as transitive. If you set a tag key
217
- * as transitive, the corresponding key and value passes to subsequent sessions in a role
218
- * chain. 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
219
- * with Session Tags</a> in the <i>IAM User Guide</i>.</p>
220
- * <p>This parameter is optional. When you set session tags as transitive, the session policy
221
- * and session tags packed binary limit is not affected.</p>
222
- * <p>If you choose not to specify a transitive tag key, then no tags are passed from this
223
- * session to any subsequent sessions.</p>
224
- */
225
- TransitiveTagKeys?: string[];
226
-
227
- /**
228
- * <p>A unique identifier that might be required when you assume a role in another account. If
229
- * the administrator of the account to which the role belongs provided you with an external
230
- * ID, then provide that value in the <code>ExternalId</code> parameter. This value can be any
231
- * string, such as a passphrase or account number. A cross-account role is usually set up to
232
- * trust everyone in an account. Therefore, the administrator of the trusting account might
233
- * send an external ID to the administrator of the trusted account. That way, only someone
234
- * with the ID can assume the role, rather than everyone in the account. For more information
235
- * about the external ID, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to Use an External ID
236
- * When Granting Access to Your Amazon Web Services Resources to a Third Party</a> in the
237
- * <i>IAM User Guide</i>.</p>
238
- * <p>The regex used to validate this parameter is a string of
239
- * characters consisting of upper- and lower-case alphanumeric characters with no spaces.
240
- * You can also include underscores or any of the following characters: =,.@:/-</p>
241
- */
242
- ExternalId?: string;
243
-
244
- /**
245
- * <p>The identification number of the MFA device that is associated with the user who is
246
- * making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role
247
- * being assumed includes a condition that requires MFA authentication. The value is either
248
- * the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon
249
- * Resource Name (ARN) for a virtual device (such as
250
- * <code>arn:aws:iam::123456789012:mfa/user</code>).</p>
251
- * <p>The regex used to validate this parameter is a string of characters
252
- * consisting of upper- and lower-case alphanumeric characters with no spaces. You can
253
- * also include underscores or any of the following characters: =,.@-</p>
254
- */
255
- SerialNumber?: string;
256
-
257
- /**
258
- * <p>The value provided by the MFA device, if the trust policy of the role being assumed
259
- * requires MFA. (In other words, if the policy includes a condition that tests for MFA). If
260
- * the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or
261
- * expired, the <code>AssumeRole</code> call returns an "access denied" error.</p>
262
- * <p>The format for this parameter, as described by its regex pattern, is a sequence of six
263
- * numeric digits.</p>
264
- */
265
- TokenCode?: string;
266
-
267
- /**
268
- * <p>The source identity specified by the principal that is calling the
269
- * <code>AssumeRole</code> operation.</p>
270
- * <p>You can require users to specify a source identity when they assume a role. You do this
271
- * by using the <code>sts:SourceIdentity</code> condition key in a role trust policy. You can
272
- * use source identity information in CloudTrail logs to determine who took actions with a role.
273
- * You can use the <code>aws:SourceIdentity</code> condition key to further control access to
274
- * Amazon Web Services resources based on the value of source identity. For more information about using
275
- * source identity, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">Monitor and control
276
- * actions taken with assumed roles</a> in the
277
- * <i>IAM User Guide</i>.</p>
278
- * <p>The regex used to validate this parameter is a string of characters consisting of upper-
279
- * and lower-case alphanumeric characters with no spaces. You can also include underscores or
280
- * any of the following characters: =,.@-. You cannot use a value that begins with the text
281
- * <code>aws:</code>. This prefix is reserved for Amazon Web Services internal
282
- * use.</p>
283
- */
284
- SourceIdentity?: string;
285
- }
286
-
287
- export namespace AssumeRoleRequest {
288
- /**
289
- * @internal
290
- */
291
- export const filterSensitiveLog = (obj: AssumeRoleRequest): any => ({
292
- ...obj,
293
- });
294
- }
295
-
296
- /**
297
- * <p>Amazon Web Services credentials for API authentication.</p>
298
- */
299
- export interface Credentials {
300
- /**
301
- * <p>The access key ID that identifies the temporary security credentials.</p>
302
- */
303
- AccessKeyId: string | undefined;
304
-
305
- /**
306
- * <p>The secret access key that can be used to sign requests.</p>
307
- */
308
- SecretAccessKey: string | undefined;
309
-
310
- /**
311
- * <p>The token that users must pass to the service API to use the temporary
312
- * credentials.</p>
313
- */
314
- SessionToken: string | undefined;
315
-
316
- /**
317
- * <p>The date on which the current credentials expire.</p>
318
- */
319
- Expiration: Date | undefined;
320
- }
321
-
322
- export namespace Credentials {
323
- /**
324
- * @internal
325
- */
326
- export const filterSensitiveLog = (obj: Credentials): any => ({
327
- ...obj,
328
- });
329
- }
330
-
331
- /**
332
- * <p>Contains the response to a successful <a>AssumeRole</a> request, including
333
- * temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
334
- */
335
- export interface AssumeRoleResponse {
336
- /**
337
- * <p>The temporary security credentials, which include an access key ID, a secret access key,
338
- * and a security (or session) token.</p>
339
- * <note>
340
- * <p>The size of the security token that STS API operations return is not fixed. We
341
- * strongly recommend that you make no assumptions about the maximum size.</p>
342
- * </note>
343
- */
344
- Credentials?: Credentials;
345
-
346
- /**
347
- * <p>The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you
348
- * can use to refer to the resulting temporary security credentials. For example, you can
349
- * reference these credentials as a principal in a resource-based policy by using the ARN or
350
- * assumed role ID. The ARN and ID include the <code>RoleSessionName</code> that you specified
351
- * when you called <code>AssumeRole</code>. </p>
352
- */
353
- AssumedRoleUser?: AssumedRoleUser;
354
-
355
- /**
356
- * <p>A percentage value that indicates the packed size of the session policies and session
357
- * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
358
- * which means the policies and tags exceeded the allowed space.</p>
359
- */
360
- PackedPolicySize?: number;
361
-
362
- /**
363
- * <p>The source identity specified by the principal that is calling the
364
- * <code>AssumeRole</code> operation.</p>
365
- * <p>You can require users to specify a source identity when they assume a role. You do this
366
- * by using the <code>sts:SourceIdentity</code> condition key in a role trust policy. You can
367
- * use source identity information in CloudTrail logs to determine who took actions with a role.
368
- * You can use the <code>aws:SourceIdentity</code> condition key to further control access to
369
- * Amazon Web Services resources based on the value of source identity. For more information about using
370
- * source identity, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">Monitor and control
371
- * actions taken with assumed roles</a> in the
372
- * <i>IAM User Guide</i>.</p>
373
- * <p>The regex used to validate this parameter is a string of characters consisting of upper-
374
- * and lower-case alphanumeric characters with no spaces. You can also include underscores or
375
- * any of the following characters: =,.@-</p>
376
- */
377
- SourceIdentity?: string;
378
- }
379
-
380
- export namespace AssumeRoleResponse {
381
- /**
382
- * @internal
383
- */
384
- export const filterSensitiveLog = (obj: AssumeRoleResponse): any => ({
385
- ...obj,
386
- });
387
- }
388
-
389
- /**
390
- * <p>The web identity token that was passed is expired or is not valid. Get a new identity
391
- * token from the identity provider and then retry the request.</p>
392
- */
393
- export interface ExpiredTokenException extends __SmithyException, $MetadataBearer {
394
- name: "ExpiredTokenException";
395
- $fault: "client";
396
- message?: string;
397
- }
398
-
399
- export namespace ExpiredTokenException {
400
- /**
401
- * @internal
402
- */
403
- export const filterSensitiveLog = (obj: ExpiredTokenException): any => ({
404
- ...obj,
405
- });
406
- }
407
-
408
- /**
409
- * <p>The request was rejected because the policy document was malformed. The error message
410
- * describes the specific error.</p>
411
- */
412
- export interface MalformedPolicyDocumentException extends __SmithyException, $MetadataBearer {
413
- name: "MalformedPolicyDocumentException";
414
- $fault: "client";
415
- message?: string;
416
- }
417
-
418
- export namespace MalformedPolicyDocumentException {
419
- /**
420
- * @internal
421
- */
422
- export const filterSensitiveLog = (obj: MalformedPolicyDocumentException): any => ({
423
- ...obj,
424
- });
425
- }
426
-
427
- /**
428
- * <p>The request was rejected because the total packed size of the session policies and
429
- * session tags combined was too large. An Amazon Web Services conversion compresses the session policy
430
- * document, session policy ARNs, and session tags into a packed binary format that has a
431
- * separate limit. The error message indicates by percentage how close the policies and
432
- * 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
433
- * the <i>IAM User Guide</i>.</p>
434
- * <p>You could receive this error even though you meet other defined session policy and
435
- * session tag limits. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">IAM and STS Entity
436
- * Character Limits</a> in the <i>IAM User Guide</i>.</p>
437
- */
438
- export interface PackedPolicyTooLargeException extends __SmithyException, $MetadataBearer {
439
- name: "PackedPolicyTooLargeException";
440
- $fault: "client";
441
- message?: string;
442
- }
443
-
444
- export namespace PackedPolicyTooLargeException {
445
- /**
446
- * @internal
447
- */
448
- export const filterSensitiveLog = (obj: PackedPolicyTooLargeException): any => ({
449
- ...obj,
450
- });
451
- }
452
-
453
- /**
454
- * <p>STS is not activated in the requested region for the account that is being asked to
455
- * generate credentials. The account administrator must use the IAM console to activate STS
456
- * 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
457
- * Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>IAM User
458
- * Guide</i>.</p>
459
- */
460
- export interface RegionDisabledException extends __SmithyException, $MetadataBearer {
461
- name: "RegionDisabledException";
462
- $fault: "client";
463
- message?: string;
464
- }
465
-
466
- export namespace RegionDisabledException {
467
- /**
468
- * @internal
469
- */
470
- export const filterSensitiveLog = (obj: RegionDisabledException): any => ({
471
- ...obj,
472
- });
473
- }
474
-
475
- export interface AssumeRoleWithSAMLRequest {
476
- /**
477
- * <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
478
- */
479
- RoleArn: string | undefined;
480
-
481
- /**
482
- * <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the
483
- * IdP.</p>
484
- */
485
- PrincipalArn: string | undefined;
486
-
487
- /**
488
- * <p>The base64 encoded SAML authentication response provided by the IdP.</p>
489
- * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and
490
- * Adding Claims</a> in the <i>IAM User Guide</i>. </p>
491
- */
492
- SAMLAssertion: string | undefined;
493
-
494
- /**
495
- * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as
496
- * managed session policies. The policies must exist in the same account as the role.</p>
497
- * <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the
498
- * plaintext that you use for both inline and managed session policies can't exceed 2,048
499
- * characters. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services
500
- * Service Namespaces</a> in the Amazon Web Services General Reference.</p>
501
- * <note>
502
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
503
- * packed binary format that has a separate limit. Your request can fail for this limit
504
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
505
- * response element indicates by percentage how close the policies and tags for your
506
- * request are to the upper size limit.
507
- * </p>
508
- * </note>
509
- *
510
- * <p>Passing policies to this operation returns new
511
- * temporary credentials. The resulting session's permissions are the intersection of the
512
- * role's identity-based policy and the session policies. You can use the role's temporary
513
- * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
514
- * the role. You cannot use session policies to grant more permissions than those allowed
515
- * by the identity-based policy of the role that is being assumed. For more information, see
516
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
517
- * Policies</a> in the <i>IAM User Guide</i>.</p>
518
- */
519
- PolicyArns?: PolicyDescriptorType[];
520
-
521
- /**
522
- * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
523
- * <p>This parameter is optional. Passing policies to this operation returns new
524
- * temporary credentials. The resulting session's permissions are the intersection of the
525
- * role's identity-based policy and the session policies. You can use the role's temporary
526
- * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
527
- * the role. You cannot use session policies to grant more permissions than those allowed
528
- * by the identity-based policy of the role that is being assumed. For more information, see
529
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
530
- * Policies</a> in the <i>IAM User Guide</i>. </p>
531
- * <p>The plaintext that you use for both inline and managed session policies can't exceed
532
- * 2,048 characters. The JSON policy characters can be any ASCII character from the space
533
- * character to the end of the valid character list (\u0020 through \u00FF). It can also
534
- * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
535
- * characters.</p>
536
- * <note>
537
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
538
- * packed binary format that has a separate limit. Your request can fail for this limit
539
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
540
- * response element indicates by percentage how close the policies and tags for your
541
- * request are to the upper size limit.
542
- * </p>
543
- * </note>
544
- */
545
- Policy?: string;
546
-
547
- /**
548
- * <p>The duration, in seconds, of the role session. Your role session lasts for the duration
549
- * that you specify for the <code>DurationSeconds</code> parameter, or until the time
550
- * specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value,
551
- * whichever is shorter. You can provide a <code>DurationSeconds</code> value from 900 seconds
552
- * (15 minutes) up to the maximum session duration setting for the role. This setting can have
553
- * a value from 1 hour to 12 hours. If you specify a value higher than this setting, the
554
- * operation fails. For example, if you specify a session duration of 12 hours, but your
555
- * administrator set the maximum session duration to 6 hours, your operation fails. To learn
556
- * 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
557
- * Maximum Session Duration Setting for a Role</a> in the
558
- * <i>IAM User Guide</i>.</p>
559
- * <p>By default, the value is set to <code>3600</code> seconds. </p>
560
- * <note>
561
- * <p>The <code>DurationSeconds</code> parameter is separate from the duration of a console
562
- * session that you might request using the returned credentials. The request to the
563
- * federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
564
- * parameter that specifies the maximum length of the console session. For more
565
- * information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
566
- * that Enables Federated Users to Access the Management Console</a> in the
567
- * <i>IAM User Guide</i>.</p>
568
- * </note>
569
- */
570
- DurationSeconds?: number;
571
- }
572
-
573
- export namespace AssumeRoleWithSAMLRequest {
574
- /**
575
- * @internal
576
- */
577
- export const filterSensitiveLog = (obj: AssumeRoleWithSAMLRequest): any => ({
578
- ...obj,
579
- });
580
- }
581
-
582
- /**
583
- * <p>Contains the response to a successful <a>AssumeRoleWithSAML</a> request,
584
- * including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
585
- */
586
- export interface AssumeRoleWithSAMLResponse {
587
- /**
588
- * <p>The temporary security credentials, which include an access key ID, a secret access key,
589
- * and a security (or session) token.</p>
590
- * <note>
591
- * <p>The size of the security token that STS API operations return is not fixed. We
592
- * strongly recommend that you make no assumptions about the maximum size.</p>
593
- * </note>
594
- */
595
- Credentials?: Credentials;
596
-
597
- /**
598
- * <p>The identifiers for the temporary security credentials that the operation
599
- * returns.</p>
600
- */
601
- AssumedRoleUser?: AssumedRoleUser;
602
-
603
- /**
604
- * <p>A percentage value that indicates the packed size of the session policies and session
605
- * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
606
- * which means the policies and tags exceeded the allowed space.</p>
607
- */
608
- PackedPolicySize?: number;
609
-
610
- /**
611
- * <p>The value of the <code>NameID</code> element in the <code>Subject</code> element of the
612
- * SAML assertion.</p>
613
- */
614
- Subject?: string;
615
-
616
- /**
617
- * <p> The format of the name ID, as defined by the <code>Format</code> attribute in the
618
- * <code>NameID</code> element of the SAML assertion. Typical examples of the format are
619
- * <code>transient</code> or <code>persistent</code>. </p>
620
- * <p> If the format includes the prefix
621
- * <code>urn:oasis:names:tc:SAML:2.0:nameid-format</code>, that prefix is removed. For
622
- * example, <code>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</code> is returned as
623
- * <code>transient</code>. If the format includes any other prefix, the format is returned
624
- * with no modifications.</p>
625
- */
626
- SubjectType?: string;
627
-
628
- /**
629
- * <p>The value of the <code>Issuer</code> element of the SAML assertion.</p>
630
- */
631
- Issuer?: string;
632
-
633
- /**
634
- * <p> The value of the <code>Recipient</code> attribute of the
635
- * <code>SubjectConfirmationData</code> element of the SAML assertion. </p>
636
- */
637
- Audience?: string;
638
-
639
- /**
640
- * <p>A hash value based on the concatenation of the following:</p>
641
- * <ul>
642
- * <li>
643
- * <p>The <code>Issuer</code> response value.</p>
644
- * </li>
645
- * <li>
646
- * <p>The Amazon Web Services account ID.</p>
647
- * </li>
648
- * <li>
649
- * <p>The friendly name (the last part of the ARN) of the SAML provider in IAM.</p>
650
- * </li>
651
- * </ul>
652
- * <p>The combination of <code>NameQualifier</code> and <code>Subject</code> can be used to
653
- * uniquely identify a federated user.</p>
654
- * <p>The following pseudocode shows how the hash value is calculated:</p>
655
- * <p>
656
- * <code>BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )</code>
657
- * </p>
658
- */
659
- NameQualifier?: string;
660
-
661
- /**
662
- * <p>The value in the <code>SourceIdentity</code> attribute in the SAML assertion. </p>
663
- * <p>You can require users to set a source identity value when they assume a role. You do
664
- * this by using the <code>sts:SourceIdentity</code> condition key in a role trust policy.
665
- * That way, actions that are taken with the role are associated with that user. After the
666
- * source identity is set, the value cannot be changed. It is present in the request for all
667
- * actions that are taken by the role and persists across <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining">chained
668
- * role</a> sessions. You can configure your SAML identity provider to use an attribute
669
- * associated with your users, like user name or email, as the source identity when calling
670
- * <code>AssumeRoleWithSAML</code>. You do this by adding an attribute to the SAML
671
- * assertion. For more information about using source identity, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">Monitor and control
672
- * actions taken with assumed roles</a> in the
673
- * <i>IAM User Guide</i>.</p>
674
- * <p>The regex used to validate this parameter is a string of characters
675
- * consisting of upper- and lower-case alphanumeric characters with no spaces. You can
676
- * also include underscores or any of the following characters: =,.@-</p>
677
- */
678
- SourceIdentity?: string;
679
- }
680
-
681
- export namespace AssumeRoleWithSAMLResponse {
682
- /**
683
- * @internal
684
- */
685
- export const filterSensitiveLog = (obj: AssumeRoleWithSAMLResponse): any => ({
686
- ...obj,
687
- });
688
- }
689
-
690
- /**
691
- * <p>The identity provider (IdP) reported that authentication failed. This might be because
692
- * the claim is invalid.</p>
693
- * <p>If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it
694
- * can also mean that the claim has expired or has been explicitly revoked. </p>
695
- */
696
- export interface IDPRejectedClaimException extends __SmithyException, $MetadataBearer {
697
- name: "IDPRejectedClaimException";
698
- $fault: "client";
699
- message?: string;
700
- }
701
-
702
- export namespace IDPRejectedClaimException {
703
- /**
704
- * @internal
705
- */
706
- export const filterSensitiveLog = (obj: IDPRejectedClaimException): any => ({
707
- ...obj,
708
- });
709
- }
710
-
711
- /**
712
- * <p>The web identity token that was passed could not be validated by Amazon Web Services. Get a new
713
- * identity token from the identity provider and then retry the request.</p>
714
- */
715
- export interface InvalidIdentityTokenException extends __SmithyException, $MetadataBearer {
716
- name: "InvalidIdentityTokenException";
717
- $fault: "client";
718
- message?: string;
719
- }
720
-
721
- export namespace InvalidIdentityTokenException {
722
- /**
723
- * @internal
724
- */
725
- export const filterSensitiveLog = (obj: InvalidIdentityTokenException): any => ({
726
- ...obj,
727
- });
728
- }
729
-
730
- export interface AssumeRoleWithWebIdentityRequest {
731
- /**
732
- * <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p>
733
- */
734
- RoleArn: string | undefined;
735
-
736
- /**
737
- * <p>An identifier for the assumed role session. Typically, you pass the name or identifier
738
- * that is associated with the user who is using your application. That way, the temporary
739
- * security credentials that your application will use are associated with that user. This
740
- * session name is included as part of the ARN and assumed role ID in the
741
- * <code>AssumedRoleUser</code> response element.</p>
742
- * <p>The regex used to validate this parameter is a string of characters
743
- * consisting of upper- and lower-case alphanumeric characters with no spaces. You can
744
- * also include underscores or any of the following characters: =,.@-</p>
745
- */
746
- RoleSessionName: string | undefined;
747
-
748
- /**
749
- * <p>The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity
750
- * provider. Your application must get this token by authenticating the user who is using your
751
- * application with a web identity provider before the application makes an
752
- * <code>AssumeRoleWithWebIdentity</code> call. </p>
753
- */
754
- WebIdentityToken: string | undefined;
755
-
756
- /**
757
- * <p>The fully qualified host component of the domain name of the identity provider.</p>
758
- * <p>Specify this value only for OAuth 2.0 access tokens. Currently
759
- * <code>www.amazon.com</code> and <code>graph.facebook.com</code> are the only supported
760
- * identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port
761
- * numbers.</p>
762
- * <p>Do not specify this value for OpenID Connect ID tokens.</p>
763
- */
764
- ProviderId?: string;
765
-
766
- /**
767
- * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as
768
- * managed session policies. The policies must exist in the same account as the role.</p>
769
- * <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the
770
- * plaintext that you use for both inline and managed session policies can't exceed 2,048
771
- * characters. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services
772
- * Service Namespaces</a> in the Amazon Web Services General Reference.</p>
773
- * <note>
774
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
775
- * packed binary format that has a separate limit. Your request can fail for this limit
776
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
777
- * response element indicates by percentage how close the policies and tags for your
778
- * request are to the upper size limit.
779
- * </p>
780
- * </note>
781
- *
782
- * <p>Passing policies to this operation returns new
783
- * temporary credentials. The resulting session's permissions are the intersection of the
784
- * role's identity-based policy and the session policies. You can use the role's temporary
785
- * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
786
- * the role. You cannot use session policies to grant more permissions than those allowed
787
- * by the identity-based policy of the role that is being assumed. For more information, see
788
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
789
- * Policies</a> in the <i>IAM User Guide</i>.</p>
790
- */
791
- PolicyArns?: PolicyDescriptorType[];
792
-
793
- /**
794
- * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
795
- * <p>This parameter is optional. Passing policies to this operation returns new
796
- * temporary credentials. The resulting session's permissions are the intersection of the
797
- * role's identity-based policy and the session policies. You can use the role's temporary
798
- * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
799
- * the role. You cannot use session policies to grant more permissions than those allowed
800
- * by the identity-based policy of the role that is being assumed. For more information, see
801
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
802
- * Policies</a> in the <i>IAM User Guide</i>.</p>
803
- * <p>The plaintext that you use for both inline and managed session policies can't exceed
804
- * 2,048 characters. The JSON policy characters can be any ASCII character from the space
805
- * character to the end of the valid character list (\u0020 through \u00FF). It can also
806
- * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
807
- * characters.</p>
808
- * <note>
809
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
810
- * packed binary format that has a separate limit. Your request can fail for this limit
811
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
812
- * response element indicates by percentage how close the policies and tags for your
813
- * request are to the upper size limit.
814
- * </p>
815
- * </note>
816
- */
817
- Policy?: string;
818
-
819
- /**
820
- * <p>The duration, in seconds, of the role session. The value can range from 900 seconds (15
821
- * minutes) up to the maximum session duration setting for the role. This setting can have a
822
- * value from 1 hour to 12 hours. If you specify a value higher than this setting, the
823
- * operation fails. For example, if you specify a session duration of 12 hours, but your
824
- * administrator set the maximum session duration to 6 hours, your operation fails. To learn
825
- * 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
826
- * Maximum Session Duration Setting for a Role</a> in the
827
- * <i>IAM User Guide</i>.</p>
828
- * <p>By default, the value is set to <code>3600</code> seconds. </p>
829
- * <note>
830
- * <p>The <code>DurationSeconds</code> parameter is separate from the duration of a console
831
- * session that you might request using the returned credentials. The request to the
832
- * federation endpoint for a console sign-in token takes a <code>SessionDuration</code>
833
- * parameter that specifies the maximum length of the console session. For more
834
- * information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL
835
- * that Enables Federated Users to Access the Management Console</a> in the
836
- * <i>IAM User Guide</i>.</p>
837
- * </note>
838
- */
839
- DurationSeconds?: number;
840
- }
841
-
842
- export namespace AssumeRoleWithWebIdentityRequest {
843
- /**
844
- * @internal
845
- */
846
- export const filterSensitiveLog = (obj: AssumeRoleWithWebIdentityRequest): any => ({
847
- ...obj,
848
- });
849
- }
850
-
851
- /**
852
- * <p>Contains the response to a successful <a>AssumeRoleWithWebIdentity</a>
853
- * request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
854
- */
855
- export interface AssumeRoleWithWebIdentityResponse {
856
- /**
857
- * <p>The temporary security credentials, which include an access key ID, a secret access key,
858
- * and a security token.</p>
859
- * <note>
860
- * <p>The size of the security token that STS API operations return is not fixed. We
861
- * strongly recommend that you make no assumptions about the maximum size.</p>
862
- * </note>
863
- */
864
- Credentials?: Credentials;
865
-
866
- /**
867
- * <p>The unique user identifier that is returned by the identity provider. This identifier is
868
- * associated with the <code>WebIdentityToken</code> that was submitted with the
869
- * <code>AssumeRoleWithWebIdentity</code> call. The identifier is typically unique to the
870
- * user and the application that acquired the <code>WebIdentityToken</code> (pairwise
871
- * identifier). For OpenID Connect ID tokens, this field contains the value returned by the
872
- * identity provider as the token's <code>sub</code> (Subject) claim. </p>
873
- */
874
- SubjectFromWebIdentityToken?: string;
875
-
876
- /**
877
- * <p>The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you
878
- * can use to refer to the resulting temporary security credentials. For example, you can
879
- * reference these credentials as a principal in a resource-based policy by using the ARN or
880
- * assumed role ID. The ARN and ID include the <code>RoleSessionName</code> that you specified
881
- * when you called <code>AssumeRole</code>. </p>
882
- */
883
- AssumedRoleUser?: AssumedRoleUser;
884
-
885
- /**
886
- * <p>A percentage value that indicates the packed size of the session policies and session
887
- * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
888
- * which means the policies and tags exceeded the allowed space.</p>
889
- */
890
- PackedPolicySize?: number;
891
-
892
- /**
893
- * <p> The issuing authority of the web identity token presented. For OpenID Connect ID
894
- * tokens, this contains the value of the <code>iss</code> field. For OAuth 2.0 access tokens,
895
- * this contains the value of the <code>ProviderId</code> parameter that was passed in the
896
- * <code>AssumeRoleWithWebIdentity</code> request.</p>
897
- */
898
- Provider?: string;
899
-
900
- /**
901
- * <p>The intended audience (also known as client ID) of the web identity token. This is
902
- * traditionally the client identifier issued to the application that requested the web
903
- * identity token.</p>
904
- */
905
- Audience?: string;
906
-
907
- /**
908
- * <p>The value of the source identity that is returned in the JSON web token (JWT) from the
909
- * identity provider.</p>
910
- * <p>You can require users to set a source identity value when they assume a role. You do
911
- * this by using the <code>sts:SourceIdentity</code> condition key in a role trust policy.
912
- * That way, actions that are taken with the role are associated with that user. After the
913
- * source identity is set, the value cannot be changed. It is present in the request for all
914
- * actions that are taken by the role and persists across <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining">chained
915
- * role</a> sessions. You can configure your identity provider to use an attribute
916
- * associated with your users, like user name or email, as the source identity when calling
917
- * <code>AssumeRoleWithWebIdentity</code>. You do this by adding a claim to the JSON web
918
- * token. To learn more about OIDC tokens and claims, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html">Using Tokens with User Pools</a> in the <i>Amazon Cognito Developer Guide</i>.
919
- * For more information about using source identity, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">Monitor and control
920
- * actions taken with assumed roles</a> in the
921
- * <i>IAM User Guide</i>.</p>
922
- * <p>The regex used to validate this parameter is a string of characters
923
- * consisting of upper- and lower-case alphanumeric characters with no spaces. You can
924
- * also include underscores or any of the following characters: =,.@-</p>
925
- */
926
- SourceIdentity?: string;
927
- }
928
-
929
- export namespace AssumeRoleWithWebIdentityResponse {
930
- /**
931
- * @internal
932
- */
933
- export const filterSensitiveLog = (obj: AssumeRoleWithWebIdentityResponse): any => ({
934
- ...obj,
935
- });
936
- }
937
-
938
- /**
939
- * <p>The request could not be fulfilled because the identity provider (IDP) that
940
- * was asked to verify the incoming identity token could not be reached. This is often a
941
- * transient error caused by network conditions. Retry the request a limited number of
942
- * times so that you don't exceed the request rate. If the error persists, the
943
- * identity provider might be down or not responding.</p>
944
- */
945
- export interface IDPCommunicationErrorException extends __SmithyException, $MetadataBearer {
946
- name: "IDPCommunicationErrorException";
947
- $fault: "client";
948
- message?: string;
949
- }
950
-
951
- export namespace IDPCommunicationErrorException {
952
- /**
953
- * @internal
954
- */
955
- export const filterSensitiveLog = (obj: IDPCommunicationErrorException): any => ({
956
- ...obj,
957
- });
958
- }
959
-
960
- export interface DecodeAuthorizationMessageRequest {
961
- /**
962
- * <p>The encoded message that was returned with the response.</p>
963
- */
964
- EncodedMessage: string | undefined;
965
- }
966
-
967
- export namespace DecodeAuthorizationMessageRequest {
968
- /**
969
- * @internal
970
- */
971
- export const filterSensitiveLog = (obj: DecodeAuthorizationMessageRequest): any => ({
972
- ...obj,
973
- });
974
- }
975
-
976
- /**
977
- * <p>A document that contains additional information about the authorization status of a
978
- * request from an encoded message that is returned in response to an Amazon Web Services request.</p>
979
- */
980
- export interface DecodeAuthorizationMessageResponse {
981
- /**
982
- * <p>An XML document that contains the decoded message.</p>
983
- */
984
- DecodedMessage?: string;
985
- }
986
-
987
- export namespace DecodeAuthorizationMessageResponse {
988
- /**
989
- * @internal
990
- */
991
- export const filterSensitiveLog = (obj: DecodeAuthorizationMessageResponse): any => ({
992
- ...obj,
993
- });
994
- }
995
-
996
- /**
997
- * <p>The error returned if the message passed to <code>DecodeAuthorizationMessage</code>
998
- * was invalid. This can happen if the token contains invalid characters, such as
999
- * linebreaks. </p>
1000
- */
1001
- export interface InvalidAuthorizationMessageException extends __SmithyException, $MetadataBearer {
1002
- name: "InvalidAuthorizationMessageException";
1003
- $fault: "client";
1004
- message?: string;
1005
- }
1006
-
1007
- export namespace InvalidAuthorizationMessageException {
1008
- /**
1009
- * @internal
1010
- */
1011
- export const filterSensitiveLog = (obj: InvalidAuthorizationMessageException): any => ({
1012
- ...obj,
1013
- });
1014
- }
1015
-
1016
- export interface GetAccessKeyInfoRequest {
1017
- /**
1018
- * <p>The identifier of an access key.</p>
1019
- * <p>This parameter allows (through its regex pattern) a string of characters that can
1020
- * consist of any upper- or lowercase letter or digit.</p>
1021
- */
1022
- AccessKeyId: string | undefined;
1023
- }
1024
-
1025
- export namespace GetAccessKeyInfoRequest {
1026
- /**
1027
- * @internal
1028
- */
1029
- export const filterSensitiveLog = (obj: GetAccessKeyInfoRequest): any => ({
1030
- ...obj,
1031
- });
1032
- }
1033
-
1034
- export interface GetAccessKeyInfoResponse {
1035
- /**
1036
- * <p>The number used to identify the Amazon Web Services account.</p>
1037
- */
1038
- Account?: string;
1039
- }
1040
-
1041
- export namespace GetAccessKeyInfoResponse {
1042
- /**
1043
- * @internal
1044
- */
1045
- export const filterSensitiveLog = (obj: GetAccessKeyInfoResponse): any => ({
1046
- ...obj,
1047
- });
1048
- }
1049
-
1050
- export interface GetCallerIdentityRequest {}
1051
-
1052
- export namespace GetCallerIdentityRequest {
1053
- /**
1054
- * @internal
1055
- */
1056
- export const filterSensitiveLog = (obj: GetCallerIdentityRequest): any => ({
1057
- ...obj,
1058
- });
1059
- }
1060
-
1061
- /**
1062
- * <p>Contains the response to a successful <a>GetCallerIdentity</a> request,
1063
- * including information about the entity making the request.</p>
1064
- */
1065
- export interface GetCallerIdentityResponse {
1066
- /**
1067
- * <p>The unique identifier of the calling entity. The exact value depends on the type of
1068
- * entity that is making the call. The values returned are those listed in the <b>aws:userid</b> column in the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable">Principal
1069
- * table</a> found on the <b>Policy Variables</b> reference
1070
- * page in the <i>IAM User Guide</i>.</p>
1071
- */
1072
- UserId?: string;
1073
-
1074
- /**
1075
- * <p>The Amazon Web Services account ID number of the account that owns or contains the calling
1076
- * entity.</p>
1077
- */
1078
- Account?: string;
1079
-
1080
- /**
1081
- * <p>The Amazon Web Services ARN associated with the calling entity.</p>
1082
- */
1083
- Arn?: string;
1084
- }
1085
-
1086
- export namespace GetCallerIdentityResponse {
1087
- /**
1088
- * @internal
1089
- */
1090
- export const filterSensitiveLog = (obj: GetCallerIdentityResponse): any => ({
1091
- ...obj,
1092
- });
1093
- }
1094
-
1095
- export interface GetFederationTokenRequest {
1096
- /**
1097
- * <p>The name of the federated user. The name is used as an identifier for the temporary
1098
- * security credentials (such as <code>Bob</code>). For example, you can reference the
1099
- * federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.</p>
1100
- * <p>The regex used to validate this parameter is a string of characters
1101
- * consisting of upper- and lower-case alphanumeric characters with no spaces. You can
1102
- * also include underscores or any of the following characters: =,.@-</p>
1103
- */
1104
- Name: string | undefined;
1105
-
1106
- /**
1107
- * <p>An IAM policy in JSON format that you want to use as an inline session policy.</p>
1108
- * <p>You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to
1109
- * this operation. You can pass a single JSON policy document to use as an inline session
1110
- * policy. You can also specify up to 10 managed policies to use as managed session
1111
- * policies.</p>
1112
- * <p>This parameter is optional. However, if you do not pass any session policies, then the
1113
- * resulting federated user session has no permissions.</p>
1114
- * <p>When you pass session policies, the session permissions are the intersection of the
1115
- * IAM user policies and the session policies that you pass. This gives you a way to further
1116
- * restrict the permissions for a federated user. You cannot use session policies to grant
1117
- * more permissions than those that are defined in the permissions policy of the IAM user.
1118
- * For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in
1119
- * the <i>IAM User Guide</i>.</p>
1120
- * <p>The resulting credentials can be used to access a resource that has a resource-based
1121
- * policy. If that policy specifically references the federated user session in the
1122
- * <code>Principal</code> element of the policy, the session has the permissions allowed by
1123
- * the policy. These permissions are granted in addition to the permissions that are granted
1124
- * by the session policies.</p>
1125
- * <p>The plaintext that you use for both inline and managed session policies can't exceed
1126
- * 2,048 characters. The JSON policy characters can be any ASCII character from the space
1127
- * character to the end of the valid character list (\u0020 through \u00FF). It can also
1128
- * include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D)
1129
- * characters.</p>
1130
- * <note>
1131
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
1132
- * packed binary format that has a separate limit. Your request can fail for this limit
1133
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
1134
- * response element indicates by percentage how close the policies and tags for your
1135
- * request are to the upper size limit.
1136
- * </p>
1137
- * </note>
1138
- */
1139
- Policy?: string;
1140
-
1141
- /**
1142
- * <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a
1143
- * managed session policy. The policies must exist in the same account as the IAM user that
1144
- * is requesting federated access.</p>
1145
- * <p>You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to
1146
- * this operation. You can pass a single JSON policy document to use as an inline session
1147
- * policy. You can also specify up to 10 managed policies to use as managed session policies.
1148
- * The plaintext that you use for both inline and managed session policies can't exceed 2,048
1149
- * characters. You can provide up to 10 managed policy ARNs. For more information about ARNs,
1150
- * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
1151
- * Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the Amazon Web Services General Reference.</p>
1152
- * <p>This parameter is optional. However, if you do not pass any session policies, then the
1153
- * resulting federated user session has no permissions.</p>
1154
- * <p>When you pass session policies, the session permissions are the intersection of the
1155
- * IAM user policies and the session policies that you pass. This gives you a way to further
1156
- * restrict the permissions for a federated user. You cannot use session policies to grant
1157
- * more permissions than those that are defined in the permissions policy of the IAM user.
1158
- * For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in
1159
- * the <i>IAM User Guide</i>.</p>
1160
- * <p>The resulting credentials can be used to access a resource that has a resource-based
1161
- * policy. If that policy specifically references the federated user session in the
1162
- * <code>Principal</code> element of the policy, the session has the permissions allowed by
1163
- * the policy. These permissions are granted in addition to the permissions that are granted
1164
- * by the session policies.</p>
1165
- * <note>
1166
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
1167
- * packed binary format that has a separate limit. Your request can fail for this limit
1168
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
1169
- * response element indicates by percentage how close the policies and tags for your
1170
- * request are to the upper size limit.
1171
- * </p>
1172
- * </note>
1173
- */
1174
- PolicyArns?: PolicyDescriptorType[];
1175
-
1176
- /**
1177
- * <p>The duration, in seconds, that the session should last. Acceptable durations for
1178
- * federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with
1179
- * 43,200 seconds (12 hours) as the default. Sessions obtained using Amazon Web Services account root user
1180
- * credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified
1181
- * duration is longer than one hour, the session obtained by using root user credentials
1182
- * defaults to one hour.</p>
1183
- */
1184
- DurationSeconds?: number;
1185
-
1186
- /**
1187
- * <p>A list of session tags. Each session tag consists of a key name and an associated value.
1188
- * For more information about session tags, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Passing Session Tags in STS</a> in the
1189
- * <i>IAM User Guide</i>.</p>
1190
- * <p>This parameter is optional. You can pass up to 50 session tags. The plaintext session
1191
- * tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these
1192
- * and additional limits, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-limits.html#reference_iam-limits-entity-length">IAM
1193
- * and STS Character Limits</a> in the <i>IAM User Guide</i>.</p>
1194
- *
1195
- * <note>
1196
- * <p>An Amazon Web Services conversion compresses the passed session policies and session tags into a
1197
- * packed binary format that has a separate limit. Your request can fail for this limit
1198
- * even if your plaintext meets the other requirements. The <code>PackedPolicySize</code>
1199
- * response element indicates by percentage how close the policies and tags for your
1200
- * request are to the upper size limit.
1201
- * </p>
1202
- * </note>
1203
- * <p>You can pass a session tag with the same key as a tag that is already
1204
- * attached to the user you are federating. When you do, session tags override a user tag with
1205
- * the same key. </p>
1206
- * <p>Tag key–value pairs are not case sensitive, but case is preserved. This means that you
1207
- * cannot have separate <code>Department</code> and <code>department</code> tag keys. Assume
1208
- * that the role has the <code>Department</code>=<code>Marketing</code> tag and you pass the
1209
- * <code>department</code>=<code>engineering</code> session tag. <code>Department</code>
1210
- * and <code>department</code> are not saved as separate tags, and the session tag passed in
1211
- * the request takes precedence over the role tag.</p>
1212
- */
1213
- Tags?: Tag[];
1214
- }
1215
-
1216
- export namespace GetFederationTokenRequest {
1217
- /**
1218
- * @internal
1219
- */
1220
- export const filterSensitiveLog = (obj: GetFederationTokenRequest): any => ({
1221
- ...obj,
1222
- });
1223
- }
1224
-
1225
- /**
1226
- * <p>Identifiers for the federated user that is associated with the credentials.</p>
1227
- */
1228
- export interface FederatedUser {
1229
- /**
1230
- * <p>The string that identifies the federated user associated with the credentials, similar
1231
- * to the unique ID of an IAM user.</p>
1232
- */
1233
- FederatedUserId: string | undefined;
1234
-
1235
- /**
1236
- * <p>The ARN that specifies the federated user that is associated with the credentials. For
1237
- * more information about ARNs and how to use them in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM
1238
- * Identifiers</a> in the <i>IAM User Guide</i>. </p>
1239
- */
1240
- Arn: string | undefined;
1241
- }
1242
-
1243
- export namespace FederatedUser {
1244
- /**
1245
- * @internal
1246
- */
1247
- export const filterSensitiveLog = (obj: FederatedUser): any => ({
1248
- ...obj,
1249
- });
1250
- }
1251
-
1252
- /**
1253
- * <p>Contains the response to a successful <a>GetFederationToken</a> request,
1254
- * including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
1255
- */
1256
- export interface GetFederationTokenResponse {
1257
- /**
1258
- * <p>The temporary security credentials, which include an access key ID, a secret access key,
1259
- * and a security (or session) token.</p>
1260
- * <note>
1261
- * <p>The size of the security token that STS API operations return is not fixed. We
1262
- * strongly recommend that you make no assumptions about the maximum size.</p>
1263
- * </note>
1264
- */
1265
- Credentials?: Credentials;
1266
-
1267
- /**
1268
- * <p>Identifiers for the federated user associated with the credentials (such as
1269
- * <code>arn:aws:sts::123456789012:federated-user/Bob</code> or
1270
- * <code>123456789012:Bob</code>). You can use the federated user's ARN in your
1271
- * resource-based policies, such as an Amazon S3 bucket policy. </p>
1272
- */
1273
- FederatedUser?: FederatedUser;
1274
-
1275
- /**
1276
- * <p>A percentage value that indicates the packed size of the session policies and session
1277
- * tags combined passed in the request. The request fails if the packed size is greater than 100 percent,
1278
- * which means the policies and tags exceeded the allowed space.</p>
1279
- */
1280
- PackedPolicySize?: number;
1281
- }
1282
-
1283
- export namespace GetFederationTokenResponse {
1284
- /**
1285
- * @internal
1286
- */
1287
- export const filterSensitiveLog = (obj: GetFederationTokenResponse): any => ({
1288
- ...obj,
1289
- });
1290
- }
1291
-
1292
- export interface GetSessionTokenRequest {
1293
- /**
1294
- * <p>The duration, in seconds, that the credentials should remain valid. Acceptable
1295
- * durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds
1296
- * (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account
1297
- * owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is
1298
- * longer than one hour, the session for Amazon Web Services account owners defaults to one hour.</p>
1299
- */
1300
- DurationSeconds?: number;
1301
-
1302
- /**
1303
- * <p>The identification number of the MFA device that is associated with the IAM user who
1304
- * is making the <code>GetSessionToken</code> call. Specify this value if the IAM user
1305
- * has a policy that requires MFA authentication. The value is either the serial number for
1306
- * a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN)
1307
- * for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can
1308
- * find the device for an IAM user by going to the Management Console and viewing the user's
1309
- * security credentials. </p>
1310
- * <p>The regex used to validate this parameter is a string of
1311
- * characters consisting of upper- and lower-case alphanumeric characters with no spaces.
1312
- * You can also include underscores or any of the following characters: =,.@:/-</p>
1313
- */
1314
- SerialNumber?: string;
1315
-
1316
- /**
1317
- * <p>The value provided by the MFA device, if MFA is required. If any policy requires the
1318
- * IAM user to submit an MFA code, specify this value. If MFA authentication is required,
1319
- * the user must provide a code when requesting a set of temporary security credentials. A
1320
- * user who fails to provide the code receives an "access denied" response when requesting
1321
- * resources that require MFA authentication.</p>
1322
- * <p>The format for this parameter, as described by its regex pattern, is a sequence of six
1323
- * numeric digits.</p>
1324
- */
1325
- TokenCode?: string;
1326
- }
1327
-
1328
- export namespace GetSessionTokenRequest {
1329
- /**
1330
- * @internal
1331
- */
1332
- export const filterSensitiveLog = (obj: GetSessionTokenRequest): any => ({
1333
- ...obj,
1334
- });
1335
- }
1336
-
1337
- /**
1338
- * <p>Contains the response to a successful <a>GetSessionToken</a> request,
1339
- * including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests. </p>
1340
- */
1341
- export interface GetSessionTokenResponse {
1342
- /**
1343
- * <p>The temporary security credentials, which include an access key ID, a secret access
1344
- * key, and a security (or session) token.</p>
1345
- *
1346
- * <note>
1347
- * <p>The size of the security token that STS API operations return is not fixed. We
1348
- * strongly recommend that you make no assumptions about the maximum size.</p>
1349
- * </note>
1350
- */
1351
- Credentials?: Credentials;
1352
- }
1353
-
1354
- export namespace GetSessionTokenResponse {
1355
- /**
1356
- * @internal
1357
- */
1358
- export const filterSensitiveLog = (obj: GetSessionTokenResponse): any => ({
1359
- ...obj,
1360
- });
1361
- }