Document build_full_result contract and log dropped members - #3767
Open
jonathan343 wants to merge 1 commit into
Open
Document build_full_result contract and log dropped members#3767jonathan343 wants to merge 1 commit into
jonathan343 wants to merge 1 commit into
Conversation
build_full_result only aggregates result_keys and non_aggregate_keys; other top-level output members are silently dropped. Document this and emit a DEBUG log naming dropped members so callers can spot missing fields instead of debugging a mystery.
Alan4506
reviewed
Aug 11, 2026
Contributor
There was a problem hiding this comment.
Thanks @jonathan343! LGTM overall but I have a question. Please see my comment below.
| if dropped: | ||
| log.debug( | ||
| "The following top-level output members are not " | ||
| "accounted for in the pagination config and were dropped " |
Contributor
There was a problem hiding this comment.
Nit: I'm wondering if the wording "not accounted for in the pagination config" is accurate or not. For example, IAM ListUsers declares IsTruncated as more_results in its pagination config, but since it never lands in the merged result, the log shows:
The following top-level output members are not accounted for in the
pagination config and were dropped from build_full_result: IsTruncated.
Iterate the pages directly if you need these values.
I agree that IsTruncated is dropped from build_full_result, but it is indeed accounted for in the paginator config, right?
Correct me if my understanding is wrong.
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
2 participants
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.
Summary
PageIterator.build_full_result()silently drops any top-level output member that isn't aresult_keyornon_aggregate_key. This PR adds a docstring describing the aggregation contract and a DEBUG log naming dropped members, so users who hit a missing field get a breadcrumb instead of debugging a silent omission.Background
build_full_result()collapses a paginated response into a single dict, aggregating onlyresult_keyvalues (summed across pages) and members listed innon_aggregate_keys(supplied per-service viapaginators-1.sdk-extras.jsonoverlays). Everything else is dropped from the final response. We maintained those overlays strictly because AWS CLI v1 shared our release stack and enforced pagination validation due to it's auto-pagination requirements. CLI v1 now vendors its own botocore, so this improves the experience for the remaining directbuild_full_result()callers without requiring per-service customizations.Customer experience
No behavior change. A user hitting a missing field in the future now gets a DEBUG breadcrumb (visible under
boto3.set_stream_logger('')) naming the dropped members.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.