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

/** 
  *             PutRecords results.
  * @param Records
  *   An array of successfully and unsuccessfully processed record results. A record that is
  *               successfully added to a stream includes SequenceNumber and
  *                   ShardId in the result. A record that fails to be added to a stream
  *               includes ErrorCode and ErrorMessage in the result.
  * @param EncryptionType
  *   The encryption type used on the records. This parameter can be one of the following
  *               values:
  *            
  *               
  *                  
  *                     NONE: Do not encrypt the records.
  *               
  *               
  *                  
  *                     KMS: Use server-side encryption on the records using a
  *                       customer-managed Amazon Web Services KMS key.
  *               
  *            
  */
final case class PutRecordsOutput(records: List[PutRecordsResultEntry], failedRecordCount: Option[NonNegativeIntegerObject] = None, encryptionType: Option[EncryptionType] = None)

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

  val hints: Hints = Hints(
    smithy.api.Documentation("\n            PutRecords results."),
    smithy.api.Output(),
  ).lazily

  // constructor using the original order from the spec
  private def make(failedRecordCount: Option[NonNegativeIntegerObject], records: List[PutRecordsResultEntry], encryptionType: Option[EncryptionType]): PutRecordsOutput = PutRecordsOutput(records, failedRecordCount, encryptionType)

  implicit val schema: Schema[PutRecordsOutput] = struct(
    NonNegativeIntegerObject.schema.optional[PutRecordsOutput]("FailedRecordCount", _.failedRecordCount),
    PutRecordsResultEntryList.underlyingSchema.required[PutRecordsOutput]("Records", _.records).addHints(smithy.api.Documentation("An array of successfully and unsuccessfully processed record results. A record that is\n            successfully added to a stream includes SequenceNumber and\n                ShardId in the result. A record that fails to be added to a stream\n            includes ErrorCode and ErrorMessage in the result.")),
    EncryptionType.schema.optional[PutRecordsOutput]("EncryptionType", _.encryptionType).addHints(smithy.api.Documentation("The encryption type used on the records. This parameter can be one of the following\n            values:
\n         \n            \n               \n                  NONE: Do not encrypt the records.
\n            
\n            \n               \n                  KMS: Use server-side encryption on the records using a\n                    customer-managed Amazon Web Services KMS key.
\n            
\n         ")),
  )(make).withId(id).addHints(hints)
}