fix(dynamodbstreams): support ShardFilter on DescribeStream #13670
+46
−1
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.
Motivation
The DynamoDB Streams
DescribeStreamAPI accepts an optionalShardFilterparameter (e.g.Type: CHILD_SHARDS,ShardId) but LocalStack ignored it and always returned all shards. Callers (e.g. stream consumers that need to discover child shards after a parent shard closes) could not use the API as documented by AWS.This PR implements support for the
CHILD_SHARDSShardFilter type so that whenShardFilteris provided withType: CHILD_SHARDSand aShardId, the response contains only shards whoseParentShardIdmatches the given shard ID.Changes
localstack-core/localstack/services/dynamodbstreams/provider.pydescribe_stream, after applyingExclusiveStartShardIdpagination, applyShardFilterwhen present.ShardFilter.TypeisCHILD_SHARDSandShardFilter.ShardIdis set, filter the returned shards to only those whoseParentShardIdequals the given shard ID.Tests
tests/aws/services/dynamodbstreams/test_dynamodb_streams.pytest_describe_stream_with_shard_filter(@markers.aws.only_localstack):describe_streamwithout filter to get initial shards.describe_streamwithShardFilter={"Type": "CHILD_SHARDS", "ShardId": parent_shard_id}.ParentShardIdequals the given ID (or an empty list when there are no children).Related