smithy4s.com.amazonaws.kinesis.ListStreamConsumersInput.scala Maven / Gradle / Ivy
Show all versions of kinesis4cats-smithy4s-client_sjs1_3 Show documentation
package com.amazonaws.kinesis
import smithy4s.Hints
import smithy4s.Schema
import smithy4s.ShapeId
import smithy4s.ShapeTag
import smithy4s.Timestamp
import smithy4s.schema.Schema.struct
import smithy4s.schema.Schema.timestamp
/** @param StreamARN
* The ARN of the Kinesis data stream for which you want to list the registered
* consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service
* Namespaces.
* @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 consumers
* that are registered with the data stream, 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.
* Don't specify StreamName or StreamCreationTimestamp if you
* specify NextToken because the latter unambiguously identifies the
* stream.
* You can optionally specify a value for the MaxResults parameter when you
* specify NextToken. If you specify a MaxResults value that is
* less than the number of consumers that the operation returns if you don't specify
* MaxResults, the response will contain a new NextToken
* value. You can use the new NextToken value in a subsequent call to the
* ListStreamConsumers operation to list the next set of consumers.
*
* 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.
*
* @param MaxResults
* The maximum number of consumers that you want a single call of
* ListStreamConsumers to return. The default value is 100. If you specify
* a value greater than 100, at most 100 results are returned.
* @param StreamCreationTimestamp
* Specify this input parameter to distinguish data streams that have the same name. For
* example, if you create a data stream and then delete it, and you later create another
* data stream with the same name, you can use this input parameter to specify which of the
* two streams you want to list the consumers for.
* You can't specify this parameter if you specify the NextToken parameter.
*/
final case class ListStreamConsumersInput(streamARN: StreamARN, nextToken: Option[NextToken] = None, maxResults: Option[ListStreamConsumersInputLimit] = None, streamCreationTimestamp: Option[Timestamp] = None)
object ListStreamConsumersInput extends ShapeTag.Companion[ListStreamConsumersInput] {
val id: ShapeId = ShapeId("com.amazonaws.kinesis", "ListStreamConsumersInput")
val hints: Hints = Hints(
smithy.api.Input(),
).lazily
// constructor using the original order from the spec
private def make(streamARN: StreamARN, nextToken: Option[NextToken], maxResults: Option[ListStreamConsumersInputLimit], streamCreationTimestamp: Option[Timestamp]): ListStreamConsumersInput = ListStreamConsumersInput(streamARN, nextToken, maxResults, streamCreationTimestamp)
implicit val schema: Schema[ListStreamConsumersInput] = struct(
StreamARN.schema.required[ListStreamConsumersInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the Kinesis data stream for which you want to list the registered\n consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.
")),
NextToken.schema.optional[ListStreamConsumersInput]("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 consumers\n that are registered with the data stream, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a\n subsequent call to ListStreamConsumers to list the next set of registered\n consumers.
\n Don\'t specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.
\n You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of consumers that the operation returns if you don\'t specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListStreamConsumers operation to list the next set of consumers.
\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 ")),
ListStreamConsumersInputLimit.schema.optional[ListStreamConsumersInput]("MaxResults", _.maxResults).addHints(smithy.api.Documentation("The maximum number of consumers that you want a single call of\n ListStreamConsumers to return. The default value is 100. If you specify\n a value greater than 100, at most 100 results are returned.
")),
timestamp.optional[ListStreamConsumersInput]("StreamCreationTimestamp", _.streamCreationTimestamp).addHints(smithy.api.Documentation("Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the consumers for.
\n You can\'t specify this parameter if you specify the NextToken parameter.
")),
)(make).withId(id).addHints(hints)
}