smithy4s.com.amazonaws.kinesis.DisableEnhancedMonitoringInput.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_sjs1_2.13 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 input for DisableEnhancedMonitoring.
  * @param StreamName
  *   The name of the Kinesis data stream for which to disable enhanced monitoring.
  * @param ShardLevelMetrics
  *   List of shard-level metrics to disable.
  *            The following are the valid shard-level metrics. The value "ALL" disables
  *               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 DisableEnhancedMonitoringInput(shardLevelMetrics: List[MetricsName], streamName: Option[StreamName] = None, streamARN: Option[StreamARN] = None)

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

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

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

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