AWSKinesisPutRecordInput

Objective-C

@interface AWSKinesisPutRecordInput

Swift

class AWSKinesisPutRecordInput

Represents the input for PutRecord.

Required parameters: [StreamName, Data, PartitionKey]

  • The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSData *_Nullable data;

    Swift

    var data: Data? { get set }

  • The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable explicitHashKey;

    Swift

    var explicitHashKey: String? { get set }

  • Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable partitionKey;

    Swift

    var partitionKey: String? { get set }

  • 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 result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sequenceNumberForOrdering;

    Swift

    var sequenceNumberForOrdering: String? { get set }

  • The name of the stream to put the data record into.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable streamName;

    Swift

    var streamName: String? { get set }