You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: supplemental-docs/CLIENTS.md
+40-3Lines changed: 40 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -147,10 +147,14 @@ const client = new S3Client({
147
147
### Custom Endpoint `endpoint`
148
148
149
149
Each SDK client, by default, resolves the target endpoint with rule-based system
150
-
whose base template for any given operation is included in the service model or schema.
151
-
At runtime any and all inputs are potentially read to resolve the final endpoint.
150
+
described by the service model.
152
151
153
-
Inputs used to resolve the endpoint for an operation include the region, FIPS/dual-stack options as mentioned above, and in some cases even request-specific parameters.
152
+
- Refer to https://smithy.io/2.0/additional-specs/rules-engine/specification.html
153
+
154
+
At runtime many sources of data are read to resolve the final endpoint.
155
+
156
+
Sources include the region, FIPS/dual-stack options as mentioned further below,
157
+
the operation, and in some cases even request-specific parameters.
154
158
155
159
You may override all that logic by providing a custom endpoint to the Client
156
160
constructor. The simplest form is a URL string.
@@ -182,6 +186,39 @@ new S3Client({
182
186
For more information about these structural alternative endpoint types,
183
187
use your IDE's type hints or refer to the API documentation linked above.
184
188
189
+
#### Retrieving the endpoint without making a request
190
+
191
+
If you would like to know the endpoint of an SDK operation without making a request,
192
+
you can make ad hoc use of our internal endpoint resolver.
193
+
194
+
**This interface is not public/stable**. Do not use this in production, or be prepared
195
+
to verify it every time you upgrade the SDK version.
196
+
197
+
```ts
198
+
// Example: resolving an endpoint without a request.
0 commit comments