# PutRecords

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.AmazonKinesis/tree/main/Frends.AmazonKinesis.PutRecords>

{% tabs %}
{% tab title="Parameter: Input" %}

| Name                       | Description                                                                                                                                                                                                                                                                                                             |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| StreamName : `String`      | <p>The name of the Kinesis Data Stream to which the records will be sent.</p><p><br>Default: <code>-</code><br>Example: <code>MyLogStream</code></p>                                                                                                                                                                    |
| Records : `List<LogEntry>` | <p>A list of data records to be sent. Each record requires a payload (Data) and a PartitionKey.</p><p>Maximum 500 records per request. Total size of all records must not exceed 10 MB.</p><p><br>Default: <code>-</code><br>Example: <code>\[ { "Data": "Log message", "PartitionKey": "ProcessID\_123" } ]</code></p> |
| {% endtab %}               |                                                                                                                                                                                                                                                                                                                         |

{% tab title="Parameter: Connection" %}

| Name                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 🗝AwsAccessKeyId : `String`     | <p>AWS Access Key ID.</p><p><br>Default: <code>-</code><br>Example: <code>AKIAQWERTY...</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| 🗝AwsSecretAccessKey : `String` | <p>AWS Secret Access Key.</p><p><br>Default: <code>-</code><br>Example: <code>TVh5hgd3uGY...</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Region : `Region`               | <p>AWS Kinesis stream region.</p><p>Possible values:</p><ul><li><code>AfSouth1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>ApEast1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>ApNortheast1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>ApNortheast2</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>ApNortheast3</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>ApSouth1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>ApSoutheast1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>ApSoutheast2</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>CaCentral1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>CnNorth1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>CnNorthWest1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>EuCentral1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>EuNorth1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>EuSouth1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>EuWest1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>EuWest2</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>EuWest3</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>MeSouth1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>SaEast1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>UsEast1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>UsEast2</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>UsWest1</code>:</li></ul><p>AWS Kinesis stream region.</p><ul><li><code>UsWest2</code>:</li></ul><p>AWS Kinesis stream region.</p><p><br>Default: <code>14</code><br>Example: <code>eu-west-1</code></p> |
| {% endtab %}                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

{% tab title="Parameter: Options" %}

| Name                             | Description                                                                                                                    |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Custom error message</code></p> |
| {% endtab %}                     |                                                                                                                                |

{% tab title="Result: Result" %}

| Name                           | Description                                                                                                                                                                                                                                                                                |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Success : `Boolean`            | <p>Indicates if the task completed successfully.<br>Example: <code>true</code></p>                                                                                                                                                                                                         |
| Entries : `List<RecordResult>` | <p>A list of results for each individual record sent. Use this to inspect which specific records succeeded or failed.<br>Example: <code>\[ { "IsSuccessful": true, "ShardId": "shard-001" }, { "IsSuccessful": false, "ErrorCode": "ProvisionedThroughputExceededException" } ]</code></p> |
| FailedRecordCount : `Int32`    | <p>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.<br>Example: <code>1</code></p>                                                                                                                       |
| Error : `Error`                | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, Exception AdditionalInfo }</code></p>                                                                                                                                                             |
| {% endtab %}                   |                                                                                                                                                                                                                                                                                            |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2026-02-25

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}