smithy4s.com.amazonaws.kinesis.EnhancedMetrics.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 enhanced metrics types.
  * @param ShardLevelMetrics
  *   List of shard-level metrics.
  *            The following are the valid shard-level metrics. The value "ALL" enhances
  *               every metric.
  *            
  *               
  *                  
  *                     IncomingBytes
  *                  
  *               
  *               
  *                  
  *                     IncomingRecords
  *                  
  *               
  *               
  *                  
  *                     OutgoingBytes
  *                  
  *               
  *               
  *                  
  *                     OutgoingRecords
  *                  
  *               
  *               
  *                  
  *                     WriteProvisionedThroughputExceeded
  *                  
  *               
  *               
  *                  
  *                     ReadProvisionedThroughputExceeded
  *                  
  *               
  *               
  *                  
  *                     IteratorAgeMilliseconds
  *                  
  *               
  *               
  *                  
  *                     ALL
  *                  
  *               
  *            
  *            For more information, see Monitoring the Amazon
  *                   Kinesis Data Streams Service with Amazon CloudWatch in the Amazon
  *                   Kinesis Data Streams Developer Guide.
  */
final case class EnhancedMetrics(shardLevelMetrics: Option[List[MetricsName]] = None)

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

  val hints: Hints = Hints(
    smithy.api.Documentation("Represents enhanced metrics types."),
  ).lazily

  // constructor using the original order from the spec
  private def make(shardLevelMetrics: Option[List[MetricsName]]): EnhancedMetrics = EnhancedMetrics(shardLevelMetrics)

  implicit val schema: Schema[EnhancedMetrics] = struct(
    MetricsNameList.underlyingSchema.optional[EnhancedMetrics]("ShardLevelMetrics", _.shardLevelMetrics).addHints(smithy.api.Documentation("List of shard-level metrics.
\n         The following are the valid shard-level metrics. The value \"ALL\" enhances\n            every metric.
\n         \n            \n               \n                  IncomingBytes\n               
\n            
\n            \n               \n                  IncomingRecords\n               
\n            
\n            \n               \n                  OutgoingBytes\n               
\n            
\n            \n               \n                  OutgoingRecords\n               
\n            
\n            \n               \n                  WriteProvisionedThroughputExceeded\n               
\n            
\n            \n               \n                  ReadProvisionedThroughputExceeded\n               
\n            
\n            \n               \n                  IteratorAgeMilliseconds\n               
\n            
\n            \n               \n                  ALL\n               
\n            
\n         
\n         For more information, see Monitoring the Amazon\n                Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n                Kinesis Data Streams Developer Guide.")),
  )(make).withId(id).addHints(hints)
}