For the complete documentation index, see llms.txt. This page is also available as Markdown.

PutRecords

Frends Task for sending data records to an Amazon Kinesis Data Stream.

Task version: 1.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

StreamName : String

The name of the Kinesis Data Stream to which the records will be sent.

Default: - Example: MyLogStream

Records : List<LogEntry>

A list of data records to be sent. Each record requires a payload (Data) and a PartitionKey.

Maximum 500 records per request. Total size of all records must not exceed 10 MB.

Default: - Example: [ { "Data": "Log message", "PartitionKey": "ProcessID_123" } ]

Name
Description

🗝AwsAccessKeyId : String

AWS Access Key ID.

Default: - Example: AKIAQWERTY...

🗝AwsSecretAccessKey : String

AWS Secret Access Key.

Default: - Example: TVh5hgd3uGY...

Region : Region

AWS Kinesis stream region.

Possible values:

  • AfSouth1: AWS Kinesis stream region.

  • ApEast1: AWS Kinesis stream region.

  • ApNortheast1: AWS Kinesis stream region.

  • ApNortheast2: AWS Kinesis stream region.

  • ApNortheast3: AWS Kinesis stream region.

  • ApSouth1: AWS Kinesis stream region.

  • ApSoutheast1: AWS Kinesis stream region.

  • ApSoutheast2: AWS Kinesis stream region.

  • CaCentral1: AWS Kinesis stream region.

  • CnNorth1: AWS Kinesis stream region.

  • CnNorthWest1: AWS Kinesis stream region.

  • EuCentral1: AWS Kinesis stream region.

  • EuNorth1: AWS Kinesis stream region.

  • EuSouth1: AWS Kinesis stream region.

  • EuWest1: AWS Kinesis stream region.

  • EuWest2: AWS Kinesis stream region.

  • EuWest3: AWS Kinesis stream region.

  • MeSouth1: AWS Kinesis stream region.

  • SaEast1: AWS Kinesis stream region.

  • UsEast1: AWS Kinesis stream region.

  • UsEast2: AWS Kinesis stream region.

  • UsWest1: AWS Kinesis stream region.

  • UsWest2: AWS Kinesis stream region.

Default: 14 Example: eu-west-1

Name
Description

ThrowErrorOnFailure : Boolean

Whether to throw an error on failure.

Default: True Example: true

ErrorMessageOnFailure : String

Overrides the error message on failure.

Default: - Example: Custom error message

Task Result

Name
Description

Success : Boolean

Indicates if the task completed successfully. Example: true

Entries : List<RecordResult>

A list of results for each individual record sent. Use this to inspect which specific records succeeded or failed. Example: [ { "IsSuccessful": true, "ShardId": "shard-001" }, { "IsSuccessful": false, "ErrorCode": "ProvisionedThroughputExceededException" } ]

FailedRecordCount : Int32

The total number of records that failed to be written to the stream. If this is greater than 0, the overall Success will be false. Example: 1

Error : Error

Error that occurred during task execution. Example: object { string Message, Exception AdditionalInfo }

Task Changelog

Changelog for Task Frends.AmazonKinesis.PutRecords.

[1.0.0] - 2026-02-25

Added

  • Initial implementation

Last updated

Was this helpful?