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

/** Represents the output for DescribeStream.
  * @param StreamDescription
  *   The current status of the stream, the stream Amazon Resource Name (ARN), an array of
  *               shard objects that comprise the stream, and whether there are more shards
  *               available.
  */
final case class DescribeStreamOutput(streamDescription: StreamDescription)

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

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

  // constructor using the original order from the spec
  private def make(streamDescription: StreamDescription): DescribeStreamOutput = DescribeStreamOutput(streamDescription)

  implicit val schema: Schema[DescribeStreamOutput] = struct(
    StreamDescription.schema.required[DescribeStreamOutput]("StreamDescription", _.streamDescription).addHints(smithy.api.Documentation("The current status of the stream, the stream Amazon Resource Name (ARN), an array of\n            shard objects that comprise the stream, and whether there are more shards\n            available.")),
  )(make).withId(id).addHints(hints)
}