Skip to content

Commit 10b28f4

Browse files
authored
Python: Update comments for Kinesis GetRecords (#7058)
* Adding better description to the get_records function.
1 parent 9a68be0 commit 10b28f4

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

.doc_gen/metadata/kinesis_metadata.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,7 @@ kinesis_GetRecords:
265265
snippet_tags:
266266
- python.example_code.kinesis.KinesisStream.class
267267
- python.example_code.kinesis.GetRecords
268+
- python.example_code.kinesis.DescribeStream
268269
SAP ABAP:
269270
versions:
270271
- sdk_version: 1

python/example_code/kinesis/streams/kinesis_stream.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,10 @@ def get_records(self, max_records):
130130
"""
131131
Gets records from the stream. This function is a generator that first gets
132132
a shard iterator for the stream, then uses the shard iterator to get records
133-
in batches from the stream. Each batch of records is yielded back to the
134-
caller until the specified maximum number of records has been retrieved.
133+
in batches from the stream. The shard iterator can be accessed through the
134+
'details' property, which is populated using the 'describe' function of this class.
135+
Each batch of records is yielded back to the caller until the specified
136+
maximum number of records has been retrieved.
135137
136138
:param max_records: The maximum number of records to retrieve.
137139
:return: Yields the current batch of retrieved records.

0 commit comments

Comments
 (0)