smithy4s.com.amazonaws.kinesis.RegisterStreamConsumerInput.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kinesis4cats-smithy4s-client_2.13 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 StreamARN
  *   The ARN of the Kinesis data stream that you want to register the consumer with. For
  *               more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service
  *               Namespaces.
  * @param ConsumerName
  *   For a given Kinesis data stream, each consumer must have a unique name. However,
  *               consumer names don't have to be unique across data streams.
  */
final case class RegisterStreamConsumerInput(streamARN: StreamARN, consumerName: ConsumerName)

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

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

  // constructor using the original order from the spec
  private def make(streamARN: StreamARN, consumerName: ConsumerName): RegisterStreamConsumerInput = RegisterStreamConsumerInput(streamARN, consumerName)

  implicit val schema: Schema[RegisterStreamConsumerInput] = struct(
    StreamARN.schema.required[RegisterStreamConsumerInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the Kinesis data stream that you want to register the consumer with. For\n            more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n            Namespaces.")),
    ConsumerName.schema.required[RegisterStreamConsumerInput]("ConsumerName", _.consumerName).addHints(smithy.api.Documentation("For a given Kinesis data stream, each consumer must have a unique name. However,\n            consumer names don\'t have to be unique across data streams.")),
  )(make).withId(id).addHints(hints)
}