smithy4s.com.amazonaws.kinesis.DescribeStreamSummaryInput.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 StreamName
  *   The name of the stream to describe.
  * @param StreamARN
  *   The ARN of the stream.
  */
final case class DescribeStreamSummaryInput(streamName: Option[StreamName] = None, streamARN: Option[StreamARN] = None)

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

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

  // constructor using the original order from the spec
  private def make(streamName: Option[StreamName], streamARN: Option[StreamARN]): DescribeStreamSummaryInput = DescribeStreamSummaryInput(streamName, streamARN)

  implicit val schema: Schema[DescribeStreamSummaryInput] = struct(
    StreamName.schema.optional[DescribeStreamSummaryInput]("StreamName", _.streamName).addHints(smithy.api.Documentation("The name of the stream to describe.")),
    StreamARN.schema.optional[DescribeStreamSummaryInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.")),
  )(make).withId(id).addHints(hints)
}