# PipeSourceKinesisStreamParameters
<a name="API_PipeSourceKinesisStreamParameters"></a>

The parameters for using a Kinesis stream as a source.

## Contents
<a name="API_PipeSourceKinesisStreamParameters_Contents"></a>

 ** StartingPosition **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-StartingPosition"></a>
The position in a stream from which to start reading.  
Type: String  
Valid Values: `TRIM_HORIZON | LATEST | AT_TIMESTAMP`   
Required: Yes

 ** BatchSize **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-BatchSize"></a>
The maximum number of records to include in each batch.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10000.  
Required: No

 ** DeadLetterConfig **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-DeadLetterConfig"></a>
Define the target queue to send dead-letter queue events to.  
Type: [DeadLetterConfig](API_DeadLetterConfig.md) object  
Required: No

 ** MaximumBatchingWindowInSeconds **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-MaximumBatchingWindowInSeconds"></a>
The maximum length of a time to wait for events.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 300.  
Required: No

 ** MaximumRecordAgeInSeconds **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-MaximumRecordAgeInSeconds"></a>
Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.   
Type: Integer  
Valid Range: Minimum value of -1. Maximum value of 604800.  
Required: No

 ** MaximumRetryAttempts **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-MaximumRetryAttempts"></a>
Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.  
Type: Integer  
Valid Range: Minimum value of -1. Maximum value of 10000.  
Required: No

 ** OnPartialBatchItemFailure **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-OnPartialBatchItemFailure"></a>
Define how to handle item process failures. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.  
Type: String  
Valid Values: `AUTOMATIC_BISECT`   
Required: No

 ** ParallelizationFactor **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-ParallelizationFactor"></a>
The number of batches to process concurrently from each shard. The default value is 1.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** StartingPositionTimestamp **   <a name="eventbridge-Type-PipeSourceKinesisStreamParameters-StartingPositionTimestamp"></a>
With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds.  
Type: Timestamp  
Required: No

## See Also
<a name="API_PipeSourceKinesisStreamParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/pipes-2015-10-07/PipeSourceKinesisStreamParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/pipes-2015-10-07/PipeSourceKinesisStreamParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/pipes-2015-10-07/PipeSourceKinesisStreamParameters)