scala.com.amazonaws.kinesis.ListShardsInput.scala Maven / Gradle / Ivy
Show all versions of kinesis4cats-smithy4s-client_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 stream.
* @param MaxResults
* The maximum number of shards to return in a single call to ListShards.
* The maximum number of shards to return in a single call. The default value is 1000. If
* you specify a value greater than 1000, at most 1000 results are returned.
* When the number of shards to be listed is greater than the value of
* MaxResults, the response contains a NextToken value that
* you can use in a subsequent call to ListShards to list the next set of
* shards.
* @param ExclusiveStartShardId
* Specify this parameter to indicate that you want to list the shards starting with the
* shard whose ID immediately follows ExclusiveStartShardId.
* If you don't specify this parameter, the default behavior is for
* ListShards to list the shards starting with the first one in the
* stream.
* You cannot specify this parameter if you specify NextToken.
* @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 shards for.
* You cannot specify this parameter if you specify the NextToken
* parameter.
* @param StreamName
* The name of the data stream whose shards you want to list.
* You cannot specify this parameter if you specify the NextToken
* parameter.
* @param NextToken
* When the number of shards in 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 shards in the data stream,
* the response includes a pagination token named NextToken. You can specify
* this NextToken value in a subsequent call to ListShards to
* list the next set of shards.
* 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 shards 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
* ListShards operation.
*
* Tokens expire after 300 seconds. When you obtain a value for
* NextToken in the response to a call to ListShards, you
* have 300 seconds to use that value. If you specify an expired token in a call to
* ListShards, you get ExpiredNextTokenException.
*
* @param ShardFilter
* Enables you to filter out the response of the ListShards API. You can
* only specify one filter at a time.
* If you use the ShardFilter parameter when invoking the ListShards API,
* the Type is the required property and must be specified. If you specify the
* AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or
* AT_LATEST types, you do not need to specify either the
* ShardId or the Timestamp optional properties.
* If you specify the AFTER_SHARD_ID type, you must also provide the value
* for the optional ShardId property. The ShardId property is
* identical in fuctionality to the ExclusiveStartShardId parameter of the
* ListShards API. When ShardId property is specified, the
* response includes the shards starting with the shard whose ID immediately follows the
* ShardId that you provided.
* If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type,
* you must also provide the value for the optional Timestamp property. If you
* specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp
* are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the
* provided timestamp to TIP are returned.
*/
final case class ListShardsInput(streamName: Option[StreamName] = None, nextToken: Option[NextToken] = None, exclusiveStartShardId: Option[ShardId] = None, maxResults: Option[ListShardsInputLimit] = None, streamCreationTimestamp: Option[Timestamp] = None, shardFilter: Option[ShardFilter] = None, streamARN: Option[StreamARN] = None)
object ListShardsInput extends ShapeTag.Companion[ListShardsInput] {
val id: ShapeId = ShapeId("com.amazonaws.kinesis", "ListShardsInput")
val hints: Hints = Hints(
smithy.api.Input(),
)
implicit val schema: Schema[ListShardsInput] = struct(
StreamName.schema.optional[ListShardsInput]("StreamName", _.streamName).addHints(smithy.api.Documentation("The name of the data stream whose shards you want to list.
\n You cannot specify this parameter if you specify the NextToken\n parameter.
")),
NextToken.schema.optional[ListShardsInput]("NextToken", _.nextToken).addHints(smithy.api.Documentation("When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.
\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 shards 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 ListShards operation.
\n \n Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.
\n ")),
ShardId.schema.optional[ListShardsInput]("ExclusiveStartShardId", _.exclusiveStartShardId).addHints(smithy.api.Documentation("Specify this parameter to indicate that you want to list the shards starting with the\n shard whose ID immediately follows ExclusiveStartShardId.
\n If you don\'t specify this parameter, the default behavior is for\n ListShards to list the shards starting with the first one in the\n stream.
\n You cannot specify this parameter if you specify NextToken.
")),
ListShardsInputLimit.schema.optional[ListShardsInput]("MaxResults", _.maxResults).addHints(smithy.api.Documentation("The maximum number of shards to return in a single call to ListShards.\n The maximum number of shards to return in a single call. The default value is 1000. If\n you specify a value greater than 1000, at most 1000 results are returned.
\n When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.
")),
timestamp.optional[ListShardsInput]("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 shards for.
\n You cannot specify this parameter if you specify the NextToken\n parameter.
")),
ShardFilter.schema.optional[ListShardsInput]("ShardFilter", _.shardFilter).addHints(smithy.api.Documentation("Enables you to filter out the response of the ListShards API. You can\n only specify one filter at a time.
\n If you use the ShardFilter parameter when invoking the ListShards API,\n the Type is the required property and must be specified. If you specify the\n AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or\n AT_LATEST types, you do not need to specify either the\n ShardId or the Timestamp optional properties.
\n If you specify the AFTER_SHARD_ID type, you must also provide the value\n for the optional ShardId property. The ShardId property is\n identical in fuctionality to the ExclusiveStartShardId parameter of the\n ListShards API. When ShardId property is specified, the\n response includes the shards starting with the shard whose ID immediately follows the\n ShardId that you provided.
\n If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type,\n you must also provide the value for the optional Timestamp property. If you\n specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp\n are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the\n provided timestamp to TIP are returned.
")),
StreamARN.schema.optional[ListShardsInput]("StreamARN", _.streamARN).addHints(smithy.api.Documentation("The ARN of the stream.
")),
){
ListShardsInput.apply
}.withId(id).addHints(hints)
}