AWS Kinesis

Put records

Write multiple data records into a Kinesis data stream in a single call.

Inputs

Expand All

Field

Type

Description

region [required]

enum

default: us-east-1

streamName [required]

string

records [required]

[object]

An array of records to put in the stream. For more information see the PutRecordsRequestEntry type documentation.

data [required]

explicitHashKey

string

partitionKey [required]

string

Outputs

Expand All

Field

Type

Description

recordsWritten [required]

[object]

An array of successfully and unsuccessfully processed record results. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

SequenceNumber

string

The sequence number for an individual record result.

ShardId

string

The shard ID for an individual record result.

ErrorCode

string

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

ErrorMessage

string

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

failedRecordCount

number

The number of unsuccessfully processed records in a PutRecords request.

encryptionType

string

The encryption type used on the records. This parameter can be one of the following values:
NONE: Do not encrypt the records.
KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.

amzRequestId [required]

string