aws.kinesis.stream.put_record

The aws.kinesis.stream.put_record command is used to put a record into a Kinesis data stream.

TR50 Request

{
  "cmd" : {
    "command" : "aws.kinesis.stream.put_record",
    "params" : {
      "region" : "XXXXXXX",
      "streamName" : "XXXXXXX",
      "partitionKey" : "XXXXXXX",
      "payload": {},
      "hasKey": "XXXXXXX",
      "sequenceNumber": "XXXXXXX"
    }
  }
}

Request Parameters

Name

Type

Required

Description

region

String

 

Region of the AWS instance, such as us-east-1.

streamName

String

Yes

The name of the stream into which to insert the data record.

partitionKey

String

Yes

Determines which shard in the stream the data record is assigned to.

payload

Array

Yes

The data blob to put into the record.

hashKey

String

 

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

sequenceNumber

String

 

Guarantees strictly increasing sequence numbers for puts from the same client and to the same partition key.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message are returned.

{
  "cmd": {
    "success": true
  }
}