scala.com.amazonaws.kinesis.GetRecordsInput.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kinesis4cats-smithy4s-client_3 Show documentation

Cats tooling for the Smithy4s Kinesis Client

There is a newer version: 0.0.32

Show newest version

package com.amazonaws.kinesis

import smithy4s.Hints
import smithy4s.Schema
import smithy4s.ShapeId
import smithy4s.ShapeTag
import smithy4s.schema.Schema.struct

/** Represents the input for GetRecords.
  * @param ShardIterator
  *   The position in the shard from which you want to start sequentially reading data
  *               records. A shard iterator specifies this position using the sequence number of a data
  *               record in the shard.
  * @param Limit
  *   The maximum number of records to return. Specify a value of up to 10,000. If you
  *               specify a value that is greater than 10,000, GetRecords throws
  *                   InvalidArgumentException. The default value is 10,000.
  * @param StreamARN
  *   The ARN of the stream.
  */
final case class GetRecordsInput(shardIterator: ShardIterator, limit: Option[GetRecordsInputLimit] = None, streamARN: Option[StreamARN] = None)

object GetRecordsInput extends ShapeTag.Companion[GetRecordsInput] {
  val id: ShapeId = ShapeId("com.amazonaws.kinesis", "GetRecordsInput")

  val hints: Hints = Hints(
    smithy.api.Documentation("Represents the input for GetRecords."),
    smithy.api.Input(),
  )

  implicit val schema: Schema[GetRecordsInput] = struct(
    ShardIterator.schema.required[GetRecordsInput]("ShardIterator", _.shardIterator).addHints(smithy.api.Documentation("The position in the shard from which you want to start sequentially reading data\n            records. A shard iterator specifies this position using the sequence number of a data\n            record in the shard.")),
    GetRecordsInputLimit.schema.optional[GetRecordsInput]("Limit", _.limit).addHints(smithy.api.Documentation("The maximum number of records to return. Specify a value of up to 10,000. If you\n            specify a value that is greater than 10,000, GetRecords throws\n                InvalidArgumentException. The default value is 10,000.")),
    StreamARN.schema.optional[GetRecordsInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.")),
  ){
    GetRecordsInput.apply
  }.withId(id).addHints(hints)
}