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

/** @param Consumers
  *   An array of JSON objects. Each object represents one registered consumer.
  * @param NextToken
  *   When the number of consumers that are registered with the data stream is greater than
  *               the default value for the MaxResults parameter, or if you explicitly
  *               specify a value for MaxResults that is less than the number of registered
  *               consumers, the response includes a pagination token named NextToken. You
  *               can specify this NextToken value in a subsequent call to
  *                   ListStreamConsumers to list the next set of registered consumers. For
  *               more information about the use of this pagination token when calling the
  *                   ListStreamConsumers operation, see NextToken.
  *            
  *               Tokens expire after 300 seconds. When you obtain a value for
  *                       NextToken in the response to a call to
  *                       ListStreamConsumers, you have 300 seconds to use that value. If you
  *                   specify an expired token in a call to ListStreamConsumers, you get
  *                       ExpiredNextTokenException.
  *            
  */
final case class ListStreamConsumersOutput(consumers: Option[List[Consumer]] = None, nextToken: Option[NextToken] = None)

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

  val hints: Hints = Hints(
    smithy.api.Output(),
  ).lazily

  // constructor using the original order from the spec
  private def make(consumers: Option[List[Consumer]], nextToken: Option[NextToken]): ListStreamConsumersOutput = ListStreamConsumersOutput(consumers, nextToken)

  implicit val schema: Schema[ListStreamConsumersOutput] = struct(
    ConsumerList.underlyingSchema.optional[ListStreamConsumersOutput]("Consumers", _.consumers).addHints(smithy.api.Documentation("An array of JSON objects. Each object represents one registered consumer.")),
    NextToken.schema.optional[ListStreamConsumersOutput]("NextToken", _.nextToken).addHints(smithy.api.Documentation("When the number of consumers that are registered with the data stream is greater than\n            the default value for the MaxResults parameter, or if you explicitly\n            specify a value for MaxResults that is less than the number of registered\n            consumers, the response includes a pagination token named NextToken. You\n            can specify this NextToken value in a subsequent call to\n                ListStreamConsumers to list the next set of registered consumers. For\n            more information about the use of this pagination token when calling the\n                ListStreamConsumers operation, see NextToken.
\n         \n            Tokens expire after 300 seconds. When you obtain a value for\n                    NextToken in the response to a call to\n                    ListStreamConsumers, you have 300 seconds to use that value. If you\n                specify an expired token in a call to ListStreamConsumers, you get\n                    ExpiredNextTokenException.
\n         ")),
  )(make).withId(id).addHints(hints)
}