smithy4s.com.amazonaws.kinesis.GetShardIteratorOutput.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_sjs1_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 output for GetShardIterator.
  * @param ShardIterator
  *   The position in the shard from which to start reading data records sequentially. A
  *               shard iterator specifies this position using the sequence number of a data record in a
  *               shard.
  */
final case class GetShardIteratorOutput(shardIterator: Option[ShardIterator] = None)

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

  val hints: Hints = Hints(
    smithy.api.Documentation("Represents the output for GetShardIterator."),
    smithy.api.Output(),
  ).lazily

  // constructor using the original order from the spec
  private def make(shardIterator: Option[ShardIterator]): GetShardIteratorOutput = GetShardIteratorOutput(shardIterator)

  implicit val schema: Schema[GetShardIteratorOutput] = struct(
    ShardIterator.schema.optional[GetShardIteratorOutput]("ShardIterator", _.shardIterator).addHints(smithy.api.Documentation("The position in the shard from which to start reading data records sequentially. A\n            shard iterator specifies this position using the sequence number of a data record in a\n            shard.")),
  )(make).withId(id).addHints(hints)
}