Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated Kinesis docs.

  • Loading branch information...
commit b11adbaffd9da92052a71be7c45cdedba7eac046 1 parent 0f35924
@toastdriven toastdriven authored
Showing with 14 additions and 11 deletions.
  1. +14 −11 boto/kinesis/layer1.py
View
25 boto/kinesis/layer1.py
@@ -532,11 +532,10 @@ def put_record(self, stream_name, data, partition_key,
placed and the sequence number that was assigned to the data
record.
- The `SequenceNumberForOrdering` sets the initial sequence
- number for the partition key. Later `PutRecord` requests to
- the same partition key (from the same client) will
- automatically increase from `SequenceNumberForOrdering`,
- ensuring strict sequential ordering.
+ Sequence numbers generally increase over time. To guarantee
+ strictly increasing ordering, use the
+ `SequenceNumberForOrdering` parameter. For more information,
+ see the `Amazon Kinesis Developer Guide`_.
If a `PutRecord` request cannot be processed because of
insufficient provisioned throughput on the shard involved in
@@ -550,8 +549,10 @@ def put_record(self, stream_name, data, partition_key,
:param stream_name: The name of the stream to put the data record into.
:type data: blob
- :param data: The data blob to put into the record, which will be Base64
- encoded. The maximum size of the data blob is 50 kilobytes (KB).
+ :param data: The data blob to put into the record, which is
+ Base64-encoded when the blob is serialized.
+ The maximum size of the data blob (the payload after
+ Base64-decoding) is 50 kilobytes (KB)
Set `b64_encode` to disable automatic Base64 encoding.
:type partition_key: string
@@ -571,10 +572,12 @@ def put_record(self, stream_name, data, partition_key,
partition key hash.
:type sequence_number_for_ordering: string
- :param sequence_number_for_ordering: The sequence number to use as the
- initial number for the partition key. Subsequent calls to
- `PutRecord` from the same client and for the same partition key
- will increase from the `SequenceNumberForOrdering` value.
+ :param sequence_number_for_ordering: Guarantees strictly increasing
+ sequence numbers, for puts from the same client and to the same
+ partition key. Usage: set the `SequenceNumberForOrdering` of record
+ n to the sequence number of record n-1 (as returned in the
+ PutRecordResult when putting record n-1 ). If this parameter is not
+ set, records will be coarsely ordered based on arrival time.
:type b64_encode: boolean
:param b64_encode: Whether to Base64 encode `data`. Can be set to
Please sign in to comment.
Something went wrong with that request. Please try again.