Repository navigation
Update API reference to render sync clients - #149
Merged
Merged
Conversation
jonathan343
previously approved these changes
Nov 18, 2026
jonathan343
left a comment
Contributor
There was a problem hiding this comment.
These changes look great! I have some minor feedback based on reading through the docs:
- We should spell out the full CRT name
AWS Common Runtime (CRT)and link to its docs/marketing page if one exists. People probably don't know what it is. - Now that we document two clients, we should change the sub-heading to
ClientsfromClient - I know this PR didn't add it. But I think the announcmenent banner can be improved to:
Developer Preview: This SDK is for evaluation and testing only. APIs might change before general availability, so pin your package versions. For production workloads, use Boto3.
If it's too long, we can cut the "APIs might change before general availability, so pin your package versions." piece for now. Tbh the ; looks weird to me for some reason.
arandito
marked this pull request as ready for review
November 18, 2026 14:11
kuhe
previously approved these changes
Nov 18, 2026
Contributor
Author
|
@jonathan343 Addressed your feedback in latest commit. Had to shorten your recommendation in the banner but I kept it in the overview warning. |
This file contains hidden or 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
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.
Description
The API reference currently only documents the async clients. This change documents the client modes side by side. They share the same models, so each service still has a single page.
request,plugins, and**kwargs. The Input section shows the dictionary and model in Dictionary/Model tabs, and says which dictionaries only the async client accepts.resolve().awscrtextra and theAWSCRTHTTPClienttransport.LINK FOR RENDERED PREVIEW: https://arandito.github.io/aws-sdk-python/
Testing
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.