smithy4s.com.amazonaws.kinesis.SubscribeToShardInput.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

The newest version!

package com.amazonaws.kinesis

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

/** @param ConsumerARN
  *   For this parameter, use the value you obtained when you called RegisterStreamConsumer.
  * @param ShardId
  *   The ID of the shard you want to subscribe to. To see a list of all the shards for a
  *               given stream, use ListShards.
  * @param StartingPosition
  *   The starting position in the data stream from which to start streaming.
  */
final case class SubscribeToShardInput(consumerARN: ConsumerARN, shardId: ShardId, startingPosition: StartingPosition)

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

  val hints: Hints = Hints(
    smithy.api.Input(),
  ).lazily

  // constructor using the original order from the spec
  private def make(consumerARN: ConsumerARN, shardId: ShardId, startingPosition: StartingPosition): SubscribeToShardInput = SubscribeToShardInput(consumerARN, shardId, startingPosition)

  implicit val schema: Schema[SubscribeToShardInput] = struct(
    ConsumerARN.schema.required[SubscribeToShardInput]("ConsumerARN", _.consumerARN).addHints(smithy.api.Documentation("For this parameter, use the value you obtained when you called RegisterStreamConsumer.")),
    ShardId.schema.required[SubscribeToShardInput]("ShardId", _.shardId).addHints(smithy.api.Documentation("The ID of the shard you want to subscribe to. To see a list of all the shards for a\n            given stream, use ListShards.")),
    StartingPosition.schema.required[SubscribeToShardInput]("StartingPosition", _.startingPosition).addHints(smithy.api.Documentation("The starting position in the data stream from which to start streaming.")),
  )(make).withId(id).addHints(hints)
}