You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kinesis::Types::ListShardsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::ListShardsInput
- Defined in:
- (unknown)
Overview
When passing ListShardsInput as input to an Aws::Client method, you can use a vanilla Hash:
{
stream_name: "StreamName",
next_token: "NextToken",
exclusive_start_shard_id: "ShardId",
max_results: 1,
stream_creation_timestamp: Time.now,
shard_filter: {
type: "AFTER_SHARD_ID", # required, accepts AFTER_SHARD_ID, AT_TRIM_HORIZON, FROM_TRIM_HORIZON, AT_LATEST, AT_TIMESTAMP, FROM_TIMESTAMP
shard_id: "ShardId",
timestamp: Time.now,
},
}
Instance Attribute Summary collapse
-
#exclusive_start_shard_id ⇒ String
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows
ExclusiveStartShardId
. -
#max_results ⇒ Integer
The maximum number of shards to return in a single call to
ListShards
. -
#next_token ⇒ String
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 forMaxResults
that is less than the number of shards in the data stream, the response includes a pagination token namedNextToken
. -
#shard_filter ⇒ Types::ShardFilter
-
#stream_creation_timestamp ⇒ Time
Specify this input parameter to distinguish data streams that have the same name.
-
#stream_name ⇒ String
The name of the data stream whose shards you want to list.
Instance Attribute Details
#exclusive_start_shard_id ⇒ String
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
.
#max_results ⇒ Integer
The maximum number of shards to return in a single call to ListShards
.
The minimum value you can specify for this parameter is 1, and the
maximum is 10,000, which is also the default.
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.
#next_token ⇒ String
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.
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
.
#shard_filter ⇒ Types::ShardFilter
#stream_creation_timestamp ⇒ Time
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.
#stream_name ⇒ String
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken
parameter.