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

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 the consumer is registered with. For more
  *               information, see Amazon Resource Names (ARNs) and Amazon Web Services Service
  *               Namespaces.
  * @param ConsumerName
  *   The name that you gave to the consumer.
  * @param ConsumerARN
  *   The ARN returned by Kinesis Data Streams when you registered the consumer.
  */
final case class DescribeStreamConsumerInput(streamARN: Option[StreamARN] = None, consumerName: Option[ConsumerName] = None, consumerARN: Option[ConsumerARN] = None)

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

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

  // constructor using the original order from the spec
  private def make(streamARN: Option[StreamARN], consumerName: Option[ConsumerName], consumerARN: Option[ConsumerARN]): DescribeStreamConsumerInput = DescribeStreamConsumerInput(streamARN, consumerName, consumerARN)

  implicit val schema: Schema[DescribeStreamConsumerInput] = struct(
    StreamARN.schema.optional[DescribeStreamConsumerInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the Kinesis data stream that the consumer is registered with. For more\n            information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n            Namespaces.")),
    ConsumerName.schema.optional[DescribeStreamConsumerInput]("ConsumerName", _.consumerName).addHints(smithy.api.Documentation("The name that you gave to the consumer.")),
    ConsumerARN.schema.optional[DescribeStreamConsumerInput]("ConsumerARN", _.consumerARN).addHints(smithy.api.Documentation("The ARN returned by Kinesis Data Streams when you registered the consumer.")),
  )(make).withId(id).addHints(hints)
}