putRecord method

Future<PutRecordOutput> putRecord({ required Uint8List data, required String partitionKey, required String streamName, String? explicitHashKey, String? sequenceNumberForOrdering, })

Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide. If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

May throw ResourceNotFoundException. May throw InvalidArgumentException. May throw ProvisionedThroughputExceededException. May throw KMSDisabledException. May throw KMSInvalidStateException. May throw KMSAccessDeniedException. May throw KMSNotFoundException. May throw KMSOptInRequired. May throw KMSThrottlingException.

Parameter data : 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 MiB).

Parameter partitionKey : 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.

Parameter streamName : The name of the stream to put the data record into.

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

Parameter sequenceNumberForOrdering : 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.

Implementation

Future<PutRecordOutput> putRecord({
  required Uint8List data,
  required String partitionKey,
  required String streamName,
  String? explicitHashKey,
  String? sequenceNumberForOrdering,
}) async {
  ArgumentError.checkNotNull(data, 'data');
  ArgumentError.checkNotNull(partitionKey, 'partitionKey');
  _s.validateStringLength(
    'partitionKey',
    partitionKey,
    1,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(streamName, 'streamName');
  _s.validateStringLength(
    'streamName',
    streamName,
    1,
    128,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Kinesis_20131202.PutRecord'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Data': base64Encode(data),
      'PartitionKey': partitionKey,
      'StreamName': streamName,
      if (explicitHashKey != null) 'ExplicitHashKey': explicitHashKey,
      if (sequenceNumberForOrdering != null)
        'SequenceNumberForOrdering': sequenceNumberForOrdering,
    },
  );

  return PutRecordOutput.fromJson(jsonResponse.body);
}