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

/** Represents the output for PutRecord.
  * @param ShardId
  *   The shard ID of the shard where the data record was placed.
  * @param SequenceNumber
  *   The sequence number identifier that was assigned to the put data record. The sequence
  *               number for the record is unique across all records in the stream. A sequence number is
  *               the identifier associated with every record put into the stream.
  * @param EncryptionType
  *   The encryption type to use on the record. This parameter can be one of the following
  *               values:
  *            
  *               
  *                  
  *                     NONE: Do not encrypt the records in the stream.
  *               
  *               
  *                  
  *                     KMS: Use server-side encryption on the records in the stream
  *                       using a customer-managed Amazon Web Services KMS key.
  *               
  *            
  */
final case class PutRecordOutput(shardId: ShardId, sequenceNumber: SequenceNumber, encryptionType: Option[EncryptionType] = None)

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

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

  // constructor using the original order from the spec
  private def make(shardId: ShardId, sequenceNumber: SequenceNumber, encryptionType: Option[EncryptionType]): PutRecordOutput = PutRecordOutput(shardId, sequenceNumber, encryptionType)

  implicit val schema: Schema[PutRecordOutput] = struct(
    ShardId.schema.required[PutRecordOutput]("ShardId", _.shardId).addHints(smithy.api.Documentation("The shard ID of the shard where the data record was placed.")),
    SequenceNumber.schema.required[PutRecordOutput]("SequenceNumber", _.sequenceNumber).addHints(smithy.api.Documentation("The sequence number identifier that was assigned to the put data record. The sequence\n            number for the record is unique across all records in the stream. A sequence number is\n            the identifier associated with every record put into the stream.")),
    EncryptionType.schema.optional[PutRecordOutput]("EncryptionType", _.encryptionType).addHints(smithy.api.Documentation("The encryption type to use on the record. This parameter can be one of the following\n            values:
\n         \n            \n               \n                  NONE: Do not encrypt the records in the stream.
\n            
\n            \n               \n                  KMS: Use server-side encryption on the records in the stream\n                    using a customer-managed Amazon Web Services KMS key.
\n            
\n         ")),
  )(make).withId(id).addHints(hints)
}