From 9cc76fdff6c91fa16b9f606f05c73a2440f52d42 Mon Sep 17 00:00:00 2001 From: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Date: Tue, 12 Nov 2024 09:25:23 -0600 Subject: [PATCH 1/2] Adding better description to the get_records function. --- python/example_code/kinesis/streams/kinesis_stream.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/python/example_code/kinesis/streams/kinesis_stream.py b/python/example_code/kinesis/streams/kinesis_stream.py index 852a816ed50..8c503a4385f 100644 --- a/python/example_code/kinesis/streams/kinesis_stream.py +++ b/python/example_code/kinesis/streams/kinesis_stream.py @@ -130,8 +130,10 @@ def get_records(self, max_records): """ Gets records from the stream. This function is a generator that first gets a shard iterator for the stream, then uses the shard iterator to get records - in batches from the stream. Each batch of records is yielded back to the - caller until the specified maximum number of records has been retrieved. + in batches from the stream. The shard iterator can be accessed through the + 'details' property, which is populated using the 'describe' function of this class. + Each batch of records is yielded back to the caller until the specified + maximum number of records has been retrieved. :param max_records: The maximum number of records to retrieve. :return: Yields the current batch of retrieved records. From 7437a052ee3818dcd7cfc9b46a0ba93595ab3a59 Mon Sep 17 00:00:00 2001 From: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com> Date: Tue, 12 Nov 2024 10:05:06 -0600 Subject: [PATCH 2/2] Update metadata. --- .doc_gen/metadata/kinesis_metadata.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.doc_gen/metadata/kinesis_metadata.yaml b/.doc_gen/metadata/kinesis_metadata.yaml index 2b6bedac05f..ce2e79dcfcd 100644 --- a/.doc_gen/metadata/kinesis_metadata.yaml +++ b/.doc_gen/metadata/kinesis_metadata.yaml @@ -265,6 +265,7 @@ kinesis_GetRecords: snippet_tags: - python.example_code.kinesis.KinesisStream.class - python.example_code.kinesis.GetRecords + - python.example_code.kinesis.DescribeStream SAP ABAP: versions: - sdk_version: 1