@aws-sdk/nested-clients 3.730.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (159) hide show
  1. package/README.md +13 -0
  2. package/dist-cjs/index.js +2 -0
  3. package/dist-cjs/submodules/sso-oidc/auth/httpAuthSchemeProvider.js +56 -0
  4. package/dist-cjs/submodules/sso-oidc/endpoint/endpointResolver.js +18 -0
  5. package/dist-cjs/submodules/sso-oidc/endpoint/ruleset.js +106 -0
  6. package/dist-cjs/submodules/sso-oidc/index.js +804 -0
  7. package/dist-cjs/submodules/sso-oidc/runtimeConfig.browser.js +38 -0
  8. package/dist-cjs/submodules/sso-oidc/runtimeConfig.js +50 -0
  9. package/dist-cjs/submodules/sso-oidc/runtimeConfig.native.js +15 -0
  10. package/dist-cjs/submodules/sso-oidc/runtimeConfig.shared.js +40 -0
  11. package/dist-cjs/submodules/sts/STSClient.js +51 -0
  12. package/dist-cjs/submodules/sts/auth/httpAuthExtensionConfiguration.js +43 -0
  13. package/dist-cjs/submodules/sts/auth/httpAuthSchemeProvider.js +63 -0
  14. package/dist-cjs/submodules/sts/endpoint/EndpointParameters.js +20 -0
  15. package/dist-cjs/submodules/sts/endpoint/endpointResolver.js +18 -0
  16. package/dist-cjs/submodules/sts/endpoint/ruleset.js +145 -0
  17. package/dist-cjs/submodules/sts/index.js +950 -0
  18. package/dist-cjs/submodules/sts/runtimeConfig.browser.js +39 -0
  19. package/dist-cjs/submodules/sts/runtimeConfig.js +64 -0
  20. package/dist-cjs/submodules/sts/runtimeConfig.native.js +15 -0
  21. package/dist-cjs/submodules/sts/runtimeConfig.shared.js +40 -0
  22. package/dist-cjs/submodules/sts/runtimeExtensions.js +25 -0
  23. package/dist-es/index.js +1 -0
  24. package/dist-es/submodules/sso-oidc/SSOOIDC.js +9 -0
  25. package/dist-es/submodules/sso-oidc/SSOOIDCClient.js +47 -0
  26. package/dist-es/submodules/sso-oidc/auth/httpAuthExtensionConfiguration.js +38 -0
  27. package/dist-es/submodules/sso-oidc/auth/httpAuthSchemeProvider.js +50 -0
  28. package/dist-es/submodules/sso-oidc/commands/CreateTokenCommand.js +23 -0
  29. package/dist-es/submodules/sso-oidc/commands/index.js +1 -0
  30. package/dist-es/submodules/sso-oidc/endpoint/EndpointParameters.js +14 -0
  31. package/dist-es/submodules/sso-oidc/endpoint/endpointResolver.js +14 -0
  32. package/dist-es/submodules/sso-oidc/endpoint/ruleset.js +103 -0
  33. package/dist-es/submodules/sso-oidc/extensionConfiguration.js +1 -0
  34. package/dist-es/submodules/sso-oidc/index.js +5 -0
  35. package/dist-es/submodules/sso-oidc/models/SSOOIDCServiceException.js +8 -0
  36. package/dist-es/submodules/sso-oidc/models/index.js +1 -0
  37. package/dist-es/submodules/sso-oidc/models/models_0.js +190 -0
  38. package/dist-es/submodules/sso-oidc/protocols/Aws_restJson1.js +255 -0
  39. package/dist-es/submodules/sso-oidc/runtimeConfig.browser.js +33 -0
  40. package/dist-es/submodules/sso-oidc/runtimeConfig.js +45 -0
  41. package/dist-es/submodules/sso-oidc/runtimeConfig.native.js +11 -0
  42. package/dist-es/submodules/sso-oidc/runtimeConfig.shared.js +36 -0
  43. package/dist-es/submodules/sso-oidc/runtimeExtensions.js +21 -0
  44. package/dist-es/submodules/sts/STS.js +11 -0
  45. package/dist-es/submodules/sts/STSClient.js +47 -0
  46. package/dist-es/submodules/sts/auth/httpAuthExtensionConfiguration.js +38 -0
  47. package/dist-es/submodules/sts/auth/httpAuthSchemeProvider.js +56 -0
  48. package/dist-es/submodules/sts/commands/AssumeRoleCommand.js +23 -0
  49. package/dist-es/submodules/sts/commands/AssumeRoleWithWebIdentityCommand.js +23 -0
  50. package/dist-es/submodules/sts/commands/index.js +2 -0
  51. package/dist-es/submodules/sts/defaultRoleAssumers.js +22 -0
  52. package/dist-es/submodules/sts/defaultStsRoleAssumers.js +93 -0
  53. package/dist-es/submodules/sts/endpoint/EndpointParameters.js +16 -0
  54. package/dist-es/submodules/sts/endpoint/endpointResolver.js +14 -0
  55. package/dist-es/submodules/sts/endpoint/ruleset.js +142 -0
  56. package/dist-es/submodules/sts/extensionConfiguration.js +1 -0
  57. package/dist-es/submodules/sts/index.js +6 -0
  58. package/dist-es/submodules/sts/models/STSServiceException.js +8 -0
  59. package/dist-es/submodules/sts/models/index.js +1 -0
  60. package/dist-es/submodules/sts/models/models_0.js +102 -0
  61. package/dist-es/submodules/sts/protocols/Aws_query.js +528 -0
  62. package/dist-es/submodules/sts/runtimeConfig.browser.js +34 -0
  63. package/dist-es/submodules/sts/runtimeConfig.js +59 -0
  64. package/dist-es/submodules/sts/runtimeConfig.native.js +11 -0
  65. package/dist-es/submodules/sts/runtimeConfig.shared.js +36 -0
  66. package/dist-es/submodules/sts/runtimeExtensions.js +21 -0
  67. package/dist-types/index.d.ts +6 -0
  68. package/dist-types/submodules/sso-oidc/SSOOIDC.d.ts +54 -0
  69. package/dist-types/submodules/sso-oidc/SSOOIDCClient.d.ts +219 -0
  70. package/dist-types/submodules/sso-oidc/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  71. package/dist-types/submodules/sso-oidc/auth/httpAuthSchemeProvider.d.ts +61 -0
  72. package/dist-types/submodules/sso-oidc/commands/CreateTokenCommand.d.ts +128 -0
  73. package/dist-types/submodules/sso-oidc/commands/index.d.ts +1 -0
  74. package/dist-types/submodules/sso-oidc/endpoint/EndpointParameters.d.ts +40 -0
  75. package/dist-types/submodules/sso-oidc/endpoint/endpointResolver.d.ts +5 -0
  76. package/dist-types/submodules/sso-oidc/endpoint/ruleset.d.ts +2 -0
  77. package/dist-types/submodules/sso-oidc/extensionConfiguration.d.ts +9 -0
  78. package/dist-types/submodules/sso-oidc/index.d.ts +50 -0
  79. package/dist-types/submodules/sso-oidc/models/SSOOIDCServiceException.d.ts +14 -0
  80. package/dist-types/submodules/sso-oidc/models/index.d.ts +1 -0
  81. package/dist-types/submodules/sso-oidc/models/models_0.d.ts +396 -0
  82. package/dist-types/submodules/sso-oidc/protocols/Aws_restJson1.d.ts +11 -0
  83. package/dist-types/submodules/sso-oidc/runtimeConfig.browser.d.ts +56 -0
  84. package/dist-types/submodules/sso-oidc/runtimeConfig.d.ts +56 -0
  85. package/dist-types/submodules/sso-oidc/runtimeConfig.native.d.ts +55 -0
  86. package/dist-types/submodules/sso-oidc/runtimeConfig.shared.d.ts +32 -0
  87. package/dist-types/submodules/sso-oidc/runtimeExtensions.d.ts +17 -0
  88. package/dist-types/submodules/sts/STS.d.ts +27 -0
  89. package/dist-types/submodules/sts/STSClient.d.ts +192 -0
  90. package/dist-types/submodules/sts/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  91. package/dist-types/submodules/sts/auth/httpAuthSchemeProvider.d.ts +71 -0
  92. package/dist-types/submodules/sts/commands/AssumeRoleCommand.d.ts +222 -0
  93. package/dist-types/submodules/sts/commands/AssumeRoleWithWebIdentityCommand.d.ts +254 -0
  94. package/dist-types/submodules/sts/commands/index.d.ts +2 -0
  95. package/dist-types/submodules/sts/defaultRoleAssumers.d.ts +23 -0
  96. package/dist-types/submodules/sts/defaultStsRoleAssumers.d.ts +43 -0
  97. package/dist-types/submodules/sts/endpoint/EndpointParameters.d.ts +46 -0
  98. package/dist-types/submodules/sts/endpoint/endpointResolver.d.ts +5 -0
  99. package/dist-types/submodules/sts/endpoint/ruleset.d.ts +2 -0
  100. package/dist-types/submodules/sts/extensionConfiguration.d.ts +9 -0
  101. package/dist-types/submodules/sts/index.d.ts +17 -0
  102. package/dist-types/submodules/sts/models/STSServiceException.d.ts +14 -0
  103. package/dist-types/submodules/sts/models/index.d.ts +1 -0
  104. package/dist-types/submodules/sts/models/models_0.d.ts +712 -0
  105. package/dist-types/submodules/sts/protocols/Aws_query.d.ts +20 -0
  106. package/dist-types/submodules/sts/runtimeConfig.browser.d.ts +58 -0
  107. package/dist-types/submodules/sts/runtimeConfig.d.ts +56 -0
  108. package/dist-types/submodules/sts/runtimeConfig.native.d.ts +57 -0
  109. package/dist-types/submodules/sts/runtimeConfig.shared.d.ts +32 -0
  110. package/dist-types/submodules/sts/runtimeExtensions.d.ts +17 -0
  111. package/dist-types/ts3.4/index.d.ts +1 -0
  112. package/dist-types/ts3.4/submodules/sso-oidc/SSOOIDC.d.ts +22 -0
  113. package/dist-types/ts3.4/submodules/sso-oidc/SSOOIDCClient.d.ts +121 -0
  114. package/dist-types/ts3.4/submodules/sso-oidc/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  115. package/dist-types/ts3.4/submodules/sso-oidc/auth/httpAuthSchemeProvider.d.ts +44 -0
  116. package/dist-types/ts3.4/submodules/sso-oidc/commands/CreateTokenCommand.d.ts +43 -0
  117. package/dist-types/ts3.4/submodules/sso-oidc/commands/index.d.ts +1 -0
  118. package/dist-types/ts3.4/submodules/sso-oidc/endpoint/EndpointParameters.d.ts +51 -0
  119. package/dist-types/ts3.4/submodules/sso-oidc/endpoint/endpointResolver.d.ts +8 -0
  120. package/dist-types/ts3.4/submodules/sso-oidc/endpoint/ruleset.d.ts +2 -0
  121. package/dist-types/ts3.4/submodules/sso-oidc/extensionConfiguration.d.ts +9 -0
  122. package/dist-types/ts3.4/submodules/sso-oidc/index.d.ts +8 -0
  123. package/dist-types/ts3.4/submodules/sso-oidc/models/SSOOIDCServiceException.d.ts +9 -0
  124. package/dist-types/ts3.4/submodules/sso-oidc/models/index.d.ts +1 -0
  125. package/dist-types/ts3.4/submodules/sso-oidc/models/models_0.d.ts +123 -0
  126. package/dist-types/ts3.4/submodules/sso-oidc/protocols/Aws_restJson1.d.ts +17 -0
  127. package/dist-types/ts3.4/submodules/sso-oidc/runtimeConfig.browser.d.ts +116 -0
  128. package/dist-types/ts3.4/submodules/sso-oidc/runtimeConfig.d.ts +113 -0
  129. package/dist-types/ts3.4/submodules/sso-oidc/runtimeConfig.native.d.ts +120 -0
  130. package/dist-types/ts3.4/submodules/sso-oidc/runtimeConfig.shared.d.ts +49 -0
  131. package/dist-types/ts3.4/submodules/sso-oidc/runtimeExtensions.d.ts +11 -0
  132. package/dist-types/ts3.4/submodules/sts/STS.d.ts +39 -0
  133. package/dist-types/ts3.4/submodules/sts/STSClient.d.ts +128 -0
  134. package/dist-types/ts3.4/submodules/sts/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  135. package/dist-types/ts3.4/submodules/sts/auth/httpAuthSchemeProvider.d.ts +54 -0
  136. package/dist-types/ts3.4/submodules/sts/commands/AssumeRoleCommand.d.ts +47 -0
  137. package/dist-types/ts3.4/submodules/sts/commands/AssumeRoleWithWebIdentityCommand.d.ts +51 -0
  138. package/dist-types/ts3.4/submodules/sts/commands/index.d.ts +2 -0
  139. package/dist-types/ts3.4/submodules/sts/defaultRoleAssumers.d.ts +19 -0
  140. package/dist-types/ts3.4/submodules/sts/defaultStsRoleAssumers.d.ts +33 -0
  141. package/dist-types/ts3.4/submodules/sts/endpoint/EndpointParameters.d.ts +57 -0
  142. package/dist-types/ts3.4/submodules/sts/endpoint/endpointResolver.d.ts +8 -0
  143. package/dist-types/ts3.4/submodules/sts/endpoint/ruleset.d.ts +2 -0
  144. package/dist-types/ts3.4/submodules/sts/extensionConfiguration.d.ts +9 -0
  145. package/dist-types/ts3.4/submodules/sts/index.d.ts +9 -0
  146. package/dist-types/ts3.4/submodules/sts/models/STSServiceException.d.ts +9 -0
  147. package/dist-types/ts3.4/submodules/sts/models/index.d.ts +1 -0
  148. package/dist-types/ts3.4/submodules/sts/models/models_0.d.ts +123 -0
  149. package/dist-types/ts3.4/submodules/sts/protocols/Aws_query.d.ts +29 -0
  150. package/dist-types/ts3.4/submodules/sts/runtimeConfig.browser.d.ts +127 -0
  151. package/dist-types/ts3.4/submodules/sts/runtimeConfig.d.ts +111 -0
  152. package/dist-types/ts3.4/submodules/sts/runtimeConfig.native.d.ts +131 -0
  153. package/dist-types/ts3.4/submodules/sts/runtimeConfig.shared.d.ts +51 -0
  154. package/dist-types/ts3.4/submodules/sts/runtimeExtensions.d.ts +11 -0
  155. package/package.json +115 -0
  156. package/sso-oidc.d.ts +7 -0
  157. package/sso-oidc.js +5 -0
  158. package/sts.d.ts +7 -0
  159. package/sts.js +5 -0
@@ -0,0 +1,192 @@
1
+ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
2
+ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
3
+ import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
4
+ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
5
+ import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
6
+ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http";
7
+ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
8
+ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
+ import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
+ import { AssumeRoleCommandInput, AssumeRoleCommandOutput } from "./commands/AssumeRoleCommand";
11
+ import { AssumeRoleWithWebIdentityCommandInput, AssumeRoleWithWebIdentityCommandOutput } from "./commands/AssumeRoleWithWebIdentityCommand";
12
+ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
13
+ import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
14
+ export { __Client };
15
+ /**
16
+ * @public
17
+ */
18
+ export type ServiceInputTypes = AssumeRoleCommandInput | AssumeRoleWithWebIdentityCommandInput;
19
+ /**
20
+ * @public
21
+ */
22
+ export type ServiceOutputTypes = AssumeRoleCommandOutput | AssumeRoleWithWebIdentityCommandOutput;
23
+ /**
24
+ * @public
25
+ */
26
+ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
27
+ /**
28
+ * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
29
+ */
30
+ requestHandler?: __HttpHandlerUserInput;
31
+ /**
32
+ * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
33
+ * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
34
+ * @internal
35
+ */
36
+ sha256?: __ChecksumConstructor | __HashConstructor;
37
+ /**
38
+ * The function that will be used to convert strings into HTTP endpoints.
39
+ * @internal
40
+ */
41
+ urlParser?: __UrlParser;
42
+ /**
43
+ * A function that can calculate the length of a request body.
44
+ * @internal
45
+ */
46
+ bodyLengthChecker?: __BodyLengthCalculator;
47
+ /**
48
+ * A function that converts a stream into an array of bytes.
49
+ * @internal
50
+ */
51
+ streamCollector?: __StreamCollector;
52
+ /**
53
+ * The function that will be used to convert a base64-encoded string to a byte array.
54
+ * @internal
55
+ */
56
+ base64Decoder?: __Decoder;
57
+ /**
58
+ * The function that will be used to convert binary data to a base64-encoded string.
59
+ * @internal
60
+ */
61
+ base64Encoder?: __Encoder;
62
+ /**
63
+ * The function that will be used to convert a UTF8-encoded string to a byte array.
64
+ * @internal
65
+ */
66
+ utf8Decoder?: __Decoder;
67
+ /**
68
+ * The function that will be used to convert binary data to a UTF-8 encoded string.
69
+ * @internal
70
+ */
71
+ utf8Encoder?: __Encoder;
72
+ /**
73
+ * The runtime environment.
74
+ * @internal
75
+ */
76
+ runtime?: string;
77
+ /**
78
+ * Disable dynamically changing the endpoint of the client based on the hostPrefix
79
+ * trait of an operation.
80
+ */
81
+ disableHostPrefix?: boolean;
82
+ /**
83
+ * Unique service identifier.
84
+ * @internal
85
+ */
86
+ serviceId?: string;
87
+ /**
88
+ * Enables IPv6/IPv4 dualstack endpoint.
89
+ */
90
+ useDualstackEndpoint?: boolean | __Provider<boolean>;
91
+ /**
92
+ * Enables FIPS compatible endpoints.
93
+ */
94
+ useFipsEndpoint?: boolean | __Provider<boolean>;
95
+ /**
96
+ * The AWS region to which this client will send requests
97
+ */
98
+ region?: string | __Provider<string>;
99
+ /**
100
+ * Setting a client profile is similar to setting a value for the
101
+ * AWS_PROFILE environment variable. Setting a profile on a client
102
+ * in code only affects the single client instance, unlike AWS_PROFILE.
103
+ *
104
+ * When set, and only for environments where an AWS configuration
105
+ * file exists, fields configurable by this file will be retrieved
106
+ * from the specified profile within that file.
107
+ * Conflicting code configuration and environment variables will
108
+ * still have higher priority.
109
+ *
110
+ * For client credential resolution that involves checking the AWS
111
+ * configuration file, the client's profile (this value) will be
112
+ * used unless a different profile is set in the credential
113
+ * provider options.
114
+ *
115
+ */
116
+ profile?: string;
117
+ /**
118
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
119
+ * @internal
120
+ */
121
+ defaultUserAgentProvider?: Provider<__UserAgent>;
122
+ /**
123
+ * Default credentials provider; Not available in browser runtime.
124
+ * @deprecated
125
+ * @internal
126
+ */
127
+ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
128
+ /**
129
+ * Value for how many times a request will be made at most in case of retry.
130
+ */
131
+ maxAttempts?: number | __Provider<number>;
132
+ /**
133
+ * Specifies which retry algorithm to use.
134
+ * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
135
+ *
136
+ */
137
+ retryMode?: string | __Provider<string>;
138
+ /**
139
+ * Optional logger for logging debug/info/warn/error.
140
+ */
141
+ logger?: __Logger;
142
+ /**
143
+ * Optional extensions
144
+ */
145
+ extensions?: RuntimeExtension[];
146
+ /**
147
+ * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
148
+ */
149
+ defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
150
+ }
151
+ /**
152
+ * @public
153
+ */
154
+ export type STSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & RetryInputConfig & RegionInputConfig & HostHeaderInputConfig & EndpointInputConfig<EndpointParameters> & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
155
+ /**
156
+ * @public
157
+ *
158
+ * The configuration interface of STSClient class constructor that set the region, credentials and other options.
159
+ */
160
+ export interface STSClientConfig extends STSClientConfigType {
161
+ }
162
+ /**
163
+ * @public
164
+ */
165
+ export type STSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & UserAgentResolvedConfig & RetryResolvedConfig & RegionResolvedConfig & HostHeaderResolvedConfig & EndpointResolvedConfig<EndpointParameters> & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
166
+ /**
167
+ * @public
168
+ *
169
+ * The resolved configuration interface of STSClient class. This is resolved and normalized from the {@link STSClientConfig | constructor configuration interface}.
170
+ */
171
+ export interface STSClientResolvedConfig extends STSClientResolvedConfigType {
172
+ }
173
+ /**
174
+ * <fullname>Security Token Service</fullname>
175
+ * <p>Security Token Service (STS) enables you to request temporary, limited-privilege
176
+ * credentials for users. This guide provides descriptions of the STS API. For
177
+ * more information about using this service, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>.</p>
178
+ * @public
179
+ */
180
+ export declare class STSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig> {
181
+ /**
182
+ * The resolved configuration of STSClient class. This is resolved and normalized from the {@link STSClientConfig | constructor configuration interface}.
183
+ */
184
+ readonly config: STSClientResolvedConfig;
185
+ constructor(...[configuration]: __CheckOptionalClientConfig<STSClientConfig>);
186
+ /**
187
+ * Destroy underlying resources, like sockets. It's usually not necessary to do this.
188
+ * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
189
+ * Otherwise, sockets might stay open for quite a long time before the server terminates them.
190
+ */
191
+ destroy(): void;
192
+ }
@@ -0,0 +1,29 @@
1
+ import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
2
+ import { STSHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
3
+ /**
4
+ * @internal
5
+ */
6
+ export interface HttpAuthExtensionConfiguration {
7
+ setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
8
+ httpAuthSchemes(): HttpAuthScheme[];
9
+ setHttpAuthSchemeProvider(httpAuthSchemeProvider: STSHttpAuthSchemeProvider): void;
10
+ httpAuthSchemeProvider(): STSHttpAuthSchemeProvider;
11
+ setCredentials(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider): void;
12
+ credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider | undefined;
13
+ }
14
+ /**
15
+ * @internal
16
+ */
17
+ export type HttpAuthRuntimeConfig = Partial<{
18
+ httpAuthSchemes: HttpAuthScheme[];
19
+ httpAuthSchemeProvider: STSHttpAuthSchemeProvider;
20
+ credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
21
+ }>;
22
+ /**
23
+ * @internal
24
+ */
25
+ export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
26
+ /**
27
+ * @internal
28
+ */
29
+ export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;
@@ -0,0 +1,71 @@
1
+ import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
2
+ import { Client, HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider } from "@smithy/types";
3
+ import { STSClientResolvedConfig } from "../STSClient";
4
+ /**
5
+ * @internal
6
+ */
7
+ export interface STSHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
8
+ region?: string;
9
+ }
10
+ /**
11
+ * @internal
12
+ */
13
+ export interface STSHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<STSClientResolvedConfig, HandlerExecutionContext, STSHttpAuthSchemeParameters, object> {
14
+ }
15
+ /**
16
+ * @internal
17
+ */
18
+ export declare const defaultSTSHttpAuthSchemeParametersProvider: (config: STSClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<STSHttpAuthSchemeParameters>;
19
+ /**
20
+ * @internal
21
+ */
22
+ export interface STSHttpAuthSchemeProvider extends HttpAuthSchemeProvider<STSHttpAuthSchemeParameters> {
23
+ }
24
+ /**
25
+ * @internal
26
+ */
27
+ export declare const defaultSTSHttpAuthSchemeProvider: STSHttpAuthSchemeProvider;
28
+ export interface StsAuthInputConfig {
29
+ }
30
+ export interface StsAuthResolvedConfig {
31
+ /**
32
+ * Reference to STSClient class constructor.
33
+ * @internal
34
+ */
35
+ stsClientCtor: new (clientConfig: any) => Client<any, any, any>;
36
+ }
37
+ export declare const resolveStsAuthConfig: <T>(input: T & StsAuthInputConfig) => T & StsAuthResolvedConfig;
38
+ /**
39
+ * @internal
40
+ */
41
+ export interface HttpAuthSchemeInputConfig extends StsAuthInputConfig, AwsSdkSigV4AuthInputConfig {
42
+ /**
43
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
44
+ * @internal
45
+ */
46
+ httpAuthSchemes?: HttpAuthScheme[];
47
+ /**
48
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
49
+ * @internal
50
+ */
51
+ httpAuthSchemeProvider?: STSHttpAuthSchemeProvider;
52
+ }
53
+ /**
54
+ * @internal
55
+ */
56
+ export interface HttpAuthSchemeResolvedConfig extends StsAuthResolvedConfig, AwsSdkSigV4AuthResolvedConfig {
57
+ /**
58
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
59
+ * @internal
60
+ */
61
+ readonly httpAuthSchemes: HttpAuthScheme[];
62
+ /**
63
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
64
+ * @internal
65
+ */
66
+ readonly httpAuthSchemeProvider: STSHttpAuthSchemeProvider;
67
+ }
68
+ /**
69
+ * @internal
70
+ */
71
+ export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;
@@ -0,0 +1,222 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { AssumeRoleRequest, AssumeRoleResponse } from "../models/models_0";
4
+ import { ServiceInputTypes, ServiceOutputTypes, STSClientResolvedConfig } from "../STSClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link AssumeRoleCommand}.
14
+ */
15
+ export interface AssumeRoleCommandInput extends AssumeRoleRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link AssumeRoleCommand}.
21
+ */
22
+ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataBearer {
23
+ }
24
+ declare const AssumeRoleCommand_base: {
25
+ new (input: AssumeRoleCommandInput): import("@smithy/smithy-client").CommandImpl<AssumeRoleCommandInput, AssumeRoleCommandOutput, STSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: AssumeRoleCommandInput): import("@smithy/smithy-client").CommandImpl<AssumeRoleCommandInput, AssumeRoleCommandOutput, STSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Returns a set of temporary security credentials that you can use to access Amazon Web Services
31
+ * resources. These temporary credentials consist of an access key ID, a secret access key,
32
+ * and a security token. Typically, you use <code>AssumeRole</code> within your account or for
33
+ * cross-account access. For a comparison of <code>AssumeRole</code> with other API operations
34
+ * that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security
35
+ * Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_sts-comparison.html">Compare STS
36
+ * credentials</a> in the <i>IAM User Guide</i>.</p>
37
+ * <p>
38
+ * <b>Permissions</b>
39
+ * </p>
40
+ * <p>The temporary security credentials created by <code>AssumeRole</code> can be used to
41
+ * make API calls to any Amazon Web Services service with the following exception: You cannot call the
42
+ * Amazon Web Services STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API
43
+ * operations.</p>
44
+ * <p>(Optional) You can pass inline or managed session policies to this operation. You can
45
+ * pass a single JSON policy document to use as an inline session policy. You can also specify
46
+ * up to 10 managed policy Amazon Resource Names (ARNs) to use as managed session policies.
47
+ * The plaintext that you use for both inline and managed session policies can't exceed 2,048
48
+ * characters. Passing policies to this operation returns new
49
+ * temporary credentials. The resulting session's permissions are the intersection of the
50
+ * role's identity-based policy and the session policies. You can use the role's temporary
51
+ * credentials in subsequent Amazon Web Services API calls to access resources in the account that owns
52
+ * the role. You cannot use session policies to grant more permissions than those allowed
53
+ * by the identity-based policy of the role that is being assumed. For more information, see
54
+ * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session
55
+ * Policies</a> in the <i>IAM User Guide</i>.</p>
56
+ * <p>When you create a role, you create two policies: a role trust policy that specifies
57
+ * <i>who</i> can assume the role, and a permissions policy that specifies
58
+ * <i>what</i> can be done with the role. You specify the trusted principal
59
+ * that is allowed to assume the role in the role trust policy.</p>
60
+ * <p>To assume a role from a different account, your Amazon Web Services account must be trusted by the
61
+ * role. The trust relationship is defined in the role's trust policy when the role is
62
+ * created. That trust policy states which accounts are allowed to delegate that access to
63
+ * users in the account. </p>
64
+ * <p>A user who wants to access a role in a different account must also have permissions that
65
+ * are delegated from the account administrator. The administrator must attach a policy that
66
+ * allows the user to call <code>AssumeRole</code> for the ARN of the role in the other
67
+ * account.</p>
68
+ * <p>To allow a user to assume a role in the same account, you can do either of the
69
+ * following:</p>
70
+ * <ul>
71
+ * <li>
72
+ * <p>Attach a policy to the user that allows the user to call <code>AssumeRole</code>
73
+ * (as long as the role's trust policy trusts the account).</p>
74
+ * </li>
75
+ * <li>
76
+ * <p>Add the user as a principal directly in the role's trust policy.</p>
77
+ * </li>
78
+ * </ul>
79
+ * <p>You can do either because the role’s trust policy acts as an IAM resource-based
80
+ * policy. When a resource-based policy grants access to a principal in the same account, no
81
+ * additional identity-based policy is required. For more information about trust policies and
82
+ * resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the
83
+ * <i>IAM User Guide</i>.</p>
84
+ * <p>
85
+ * <b>Tags</b>
86
+ * </p>
87
+ * <p>(Optional) You can pass tag key-value pairs to your session. These tags are called
88
+ * session tags. For more information about session tags, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html">Passing Session Tags in STS</a> in the
89
+ * <i>IAM User Guide</i>.</p>
90
+ * <p>An administrator must grant you the permissions necessary to pass session tags. The
91
+ * administrator can also create granular permissions to allow you to pass only specific
92
+ * 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
93
+ * for Attribute-Based Access Control</a> in the
94
+ * <i>IAM User Guide</i>.</p>
95
+ * <p>You can set the session tags as transitive. Transitive tags persist during role
96
+ * 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
97
+ * with Session Tags</a> in the <i>IAM User Guide</i>.</p>
98
+ * <p>
99
+ * <b>Using MFA with AssumeRole</b>
100
+ * </p>
101
+ * <p>(Optional) You can include multi-factor authentication (MFA) information when you call
102
+ * <code>AssumeRole</code>. This is useful for cross-account scenarios to ensure that the
103
+ * user that assumes the role has been authenticated with an Amazon Web Services MFA device. In that
104
+ * scenario, the trust policy of the role being assumed includes a condition that tests for
105
+ * MFA authentication. If the caller does not include valid MFA information, the request to
106
+ * assume the role is denied. The condition in a trust policy that tests for MFA
107
+ * authentication might look like the following example.</p>
108
+ * <p>
109
+ * <code>"Condition": \{"Bool": \{"aws:MultiFactorAuthPresent": true\}\}</code>
110
+ * </p>
111
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a>
112
+ * in the <i>IAM User Guide</i> guide.</p>
113
+ * <p>To use MFA with <code>AssumeRole</code>, you pass values for the
114
+ * <code>SerialNumber</code> and <code>TokenCode</code> parameters. The
115
+ * <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device.
116
+ * The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA device
117
+ * produces. </p>
118
+ * @example
119
+ * Use a bare-bones client and the command you need to make an API call.
120
+ * ```javascript
121
+ * import { STSClient, AssumeRoleCommand } from "@aws-sdk/client-sts"; // ES Modules import
122
+ * // const { STSClient, AssumeRoleCommand } = require("@aws-sdk/client-sts"); // CommonJS import
123
+ * const client = new STSClient(config);
124
+ * const input = { // AssumeRoleRequest
125
+ * RoleArn: "STRING_VALUE", // required
126
+ * RoleSessionName: "STRING_VALUE", // required
127
+ * PolicyArns: [ // policyDescriptorListType
128
+ * { // PolicyDescriptorType
129
+ * arn: "STRING_VALUE",
130
+ * },
131
+ * ],
132
+ * Policy: "STRING_VALUE",
133
+ * DurationSeconds: Number("int"),
134
+ * Tags: [ // tagListType
135
+ * { // Tag
136
+ * Key: "STRING_VALUE", // required
137
+ * Value: "STRING_VALUE", // required
138
+ * },
139
+ * ],
140
+ * TransitiveTagKeys: [ // tagKeyListType
141
+ * "STRING_VALUE",
142
+ * ],
143
+ * ExternalId: "STRING_VALUE",
144
+ * SerialNumber: "STRING_VALUE",
145
+ * TokenCode: "STRING_VALUE",
146
+ * SourceIdentity: "STRING_VALUE",
147
+ * ProvidedContexts: [ // ProvidedContextsListType
148
+ * { // ProvidedContext
149
+ * ProviderArn: "STRING_VALUE",
150
+ * ContextAssertion: "STRING_VALUE",
151
+ * },
152
+ * ],
153
+ * };
154
+ * const command = new AssumeRoleCommand(input);
155
+ * const response = await client.send(command);
156
+ * // { // AssumeRoleResponse
157
+ * // Credentials: { // Credentials
158
+ * // AccessKeyId: "STRING_VALUE", // required
159
+ * // SecretAccessKey: "STRING_VALUE", // required
160
+ * // SessionToken: "STRING_VALUE", // required
161
+ * // Expiration: new Date("TIMESTAMP"), // required
162
+ * // },
163
+ * // AssumedRoleUser: { // AssumedRoleUser
164
+ * // AssumedRoleId: "STRING_VALUE", // required
165
+ * // Arn: "STRING_VALUE", // required
166
+ * // },
167
+ * // PackedPolicySize: Number("int"),
168
+ * // SourceIdentity: "STRING_VALUE",
169
+ * // };
170
+ *
171
+ * ```
172
+ *
173
+ * @param AssumeRoleCommandInput - {@link AssumeRoleCommandInput}
174
+ * @returns {@link AssumeRoleCommandOutput}
175
+ * @see {@link AssumeRoleCommandInput} for command's `input` shape.
176
+ * @see {@link AssumeRoleCommandOutput} for command's `response` shape.
177
+ * @see {@link STSClientResolvedConfig | config} for STSClient's `config` shape.
178
+ *
179
+ * @throws {@link ExpiredTokenException} (client fault)
180
+ * <p>The web identity token that was passed is expired or is not valid. Get a new identity
181
+ * token from the identity provider and then retry the request.</p>
182
+ *
183
+ * @throws {@link MalformedPolicyDocumentException} (client fault)
184
+ * <p>The request was rejected because the policy document was malformed. The error message
185
+ * describes the specific error.</p>
186
+ *
187
+ * @throws {@link PackedPolicyTooLargeException} (client fault)
188
+ * <p>The request was rejected because the total packed size of the session policies and
189
+ * session tags combined was too large. An Amazon Web Services conversion compresses the session policy
190
+ * document, session policy ARNs, and session tags into a packed binary format that has a
191
+ * separate limit. The error message indicates by percentage how close the policies and
192
+ * 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
193
+ * the <i>IAM User Guide</i>.</p>
194
+ * <p>You could receive this error even though you meet other defined session policy and
195
+ * session tag limits. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-limits-entity-length">IAM and STS Entity Character Limits</a> in the <i>IAM User
196
+ * Guide</i>.</p>
197
+ *
198
+ * @throws {@link RegionDisabledException} (client fault)
199
+ * <p>STS is not activated in the requested region for the account that is being asked to
200
+ * generate credentials. The account administrator must use the IAM console to activate
201
+ * STS 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
202
+ * Deactivating STS in an Amazon Web Services Region</a> in the <i>IAM User
203
+ * Guide</i>.</p>
204
+ *
205
+ * @throws {@link STSServiceException}
206
+ * <p>Base exception class for all service exceptions from STS service.</p>
207
+ *
208
+ * @public
209
+ */
210
+ export declare class AssumeRoleCommand extends AssumeRoleCommand_base {
211
+ /** @internal type navigation helper, not in runtime. */
212
+ protected static __types: {
213
+ api: {
214
+ input: AssumeRoleRequest;
215
+ output: AssumeRoleResponse;
216
+ };
217
+ sdk: {
218
+ input: AssumeRoleCommandInput;
219
+ output: AssumeRoleCommandOutput;
220
+ };
221
+ };
222
+ }