update devguide for endpointsv2 #2205
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lucix-aws
commented
Jul 25, 2023
| * `EndpointResolverV2` | ||
| * `BaseEndpoint` | ||
|
|
||
| ## V1: `EndpointResolver` |
There was a problem hiding this comment.
question: Should we move v2 to the top? Inclined to say yes given it's what we want people to use (it effectively supercedes v1 as we know).
isaiahvita
approved these changes
Jul 25, 2023
| ## Customization | ||
|
|
||
| There are two "versions" of endpoint resolution config within the SDK. | ||
| behavior of endpoint resolution within the SDK: |
There was a problem hiding this comment.
prob typo: within the SDK used twice in awkward phrasing
| resolved endpoint. You can prevent the SDK from mutating your custom endpoints by setting | ||
| [HostnameImmutable]({{< apiref "aws#Endpoint.HostnameImmutable" >}}) to`true`. For example: | ||
| Some service clients, such as {{% alias service=S3 %}}, may modify the endpoint | ||
| returned by the resolver for certain service operations. For example, the {{% |
There was a problem hiding this comment.
nit: remove the in For example, the Amazon S3
| In resolution v2, `EndpointResolverV2` is the definitive mechanism through | ||
| which endpoint resolution occurs. The resolver's `ResolveEndpoint` method is | ||
| invoked as part of the workflow for every request you make in the SDK. The | ||
| `Endpoint` value returned by the resolver is used **as-is** when making the |
There was a problem hiding this comment.
i think what you mean here is the hostname value given in Endpoint right? because the path may get altered after endpoint resolution but before request execution. for example, the in S3 GetObject requests, the Key value will be added to the path during serialization
| * `EndpointResolverV2` | ||
| * `BaseEndpoint` | ||
|
|
||
| ## V1: `EndpointResolver` |
aajtodd
approved these changes
Jul 25, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For changes to files under the
/codegen/aws-modelsfolder, and manual edits to autogenerated code (e.g./service/s3/api.go) please create an Issue instead of a PR for those type of changes.If the PR addresses an existing bug or feature, please reference it here.
To help speed up the process and reduce the time to merge please ensure that
Allow edits by maintainersis checked before submitting your PR. This will allow the project maintainers to make minor adjustments or improvements to the submitted PR, allow us to reduce the roundtrip time for merging your request.