smithy4s.com.amazonaws.kinesis.EnableEnhancedMonitoringInput.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 EnableEnhancedMonitoring.
  * @param StreamName
  *   The name of the stream for which to enable enhanced monitoring.
  * @param ShardLevelMetrics
  *   List of shard-level metrics to enable.
  *            The following are the valid shard-level metrics. The value "ALL" enables
  *               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.
  * @param StreamARN
  *   The ARN of the stream.
  */
final case class EnableEnhancedMonitoringInput(shardLevelMetrics: List[MetricsName], streamName: Option[StreamName] = None, streamARN: Option[StreamARN] = None)

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

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

  // constructor using the original order from the spec
  private def make(streamName: Option[StreamName], shardLevelMetrics: List[MetricsName], streamARN: Option[StreamARN]): EnableEnhancedMonitoringInput = EnableEnhancedMonitoringInput(shardLevelMetrics, streamName, streamARN)

  implicit val schema: Schema[EnableEnhancedMonitoringInput] = struct(
    StreamName.schema.optional[EnableEnhancedMonitoringInput]("StreamName", _.streamName).addHints(smithy.api.Documentation("The name of the stream for which to enable enhanced monitoring.")),
    MetricsNameList.underlyingSchema.required[EnableEnhancedMonitoringInput]("ShardLevelMetrics", _.shardLevelMetrics).addHints(smithy.api.Documentation("List of shard-level metrics to enable.
\n         The following are the valid shard-level metrics. The value \"ALL\" enables\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.")),
    StreamARN.schema.optional[EnableEnhancedMonitoringInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.")),
  )(make).withId(id).addHints(hints)
}