Python: Update comments for Kinesis GetRecords (awsdocs#7058)

* Adding better description to the get_records function.
shepazon · Nov 13, 2024 · 10b28f4 · 10b28f4
1 parent 9a68be0
commit 10b28f4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git 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

diff --git 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.