smithy4s.com.amazonaws.kinesis.DecreaseStreamRetentionPeriodInput.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 DecreaseStreamRetentionPeriod.
  * @param StreamName
  *   The name of the stream to modify.
  * @param RetentionPeriodHours
  *   The new retention period of the stream, in hours. Must be less than the current
  *               retention period.
  * @param StreamARN
  *   The ARN of the stream.
  */
final case class DecreaseStreamRetentionPeriodInput(retentionPeriodHours: RetentionPeriodHours, streamName: Option[StreamName] = None, streamARN: Option[StreamARN] = None)

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

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

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

  implicit val schema: Schema[DecreaseStreamRetentionPeriodInput] = struct(
    StreamName.schema.optional[DecreaseStreamRetentionPeriodInput]("StreamName", _.streamName).addHints(smithy.api.Documentation("The name of the stream to modify.")),
    RetentionPeriodHours.schema.required[DecreaseStreamRetentionPeriodInput]("RetentionPeriodHours", _.retentionPeriodHours).addHints(smithy.api.Documentation("The new retention period of the stream, in hours. Must be less than the current\n            retention period.")),
    StreamARN.schema.optional[DecreaseStreamRetentionPeriodInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.")),
  )(make).withId(id).addHints(hints)
}