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

Go to download
package com.amazonaws.kinesis

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

/** Represents the input for DescribeStream.
  * @param StreamName
  *   The name of the stream to describe.
  * @param Limit
  *   The maximum number of shards to return in a single call. The default value is 100. If
  *               you specify a value greater than 100, at most 100 results are returned.
  * @param ExclusiveStartShardId
  *   The shard ID of the shard to start with.
  *            Specify this parameter to indicate that you want to describe the stream starting with
  *               the shard whose ID immediately follows ExclusiveStartShardId.
  *            If you don't specify this parameter, the default behavior for
  *                   DescribeStream is to describe the stream starting with the first shard
  *               in the stream.
  * @param StreamARN
  *   The ARN of the stream.
  */
final case class DescribeStreamInput(streamName: Option[StreamName] = None, limit: Option[DescribeStreamInputLimit] = None, exclusiveStartShardId: Option[ShardId] = None, streamARN: Option[StreamARN] = None)

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

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

  // constructor using the original order from the spec
  private def make(streamName: Option[StreamName], limit: Option[DescribeStreamInputLimit], exclusiveStartShardId: Option[ShardId], streamARN: Option[StreamARN]): DescribeStreamInput = DescribeStreamInput(streamName, limit, exclusiveStartShardId, streamARN)

  implicit val schema: Schema[DescribeStreamInput] = struct(
    StreamName.schema.optional[DescribeStreamInput]("StreamName", _.streamName).addHints(smithy.api.Documentation("The name of the stream to describe.")),
    DescribeStreamInputLimit.schema.optional[DescribeStreamInput]("Limit", _.limit).addHints(smithy.api.Documentation("The maximum number of shards to return in a single call. The default value is 100. If\n            you specify a value greater than 100, at most 100 results are returned.")),
    ShardId.schema.optional[DescribeStreamInput]("ExclusiveStartShardId", _.exclusiveStartShardId).addHints(smithy.api.Documentation("The shard ID of the shard to start with.
\n         Specify this parameter to indicate that you want to describe the stream starting with\n            the shard whose ID immediately follows ExclusiveStartShardId.
\n         If you don\'t specify this parameter, the default behavior for\n                DescribeStream is to describe the stream starting with the first shard\n            in the stream.")),
    StreamARN.schema.optional[DescribeStreamInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.")),
  )(make).withId(id).addHints(hints)
}