You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kinesis::Types::ListShardsOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::ListShardsOutput
- Defined in:
- (unknown)
Overview
Returned by:
Instance Attribute Summary collapse
-
#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
. -
#shards ⇒ Array<Types::Shard>
An array of JSON objects.
Instance Attribute Details
#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. For more information about
the use of this pagination token when calling the ListShards
operation, see ListShardsInput$NextToken.
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
.
#shards ⇒ Array<Types::Shard>
An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard\'s parent, and the shard that\'s adjacent to the shard\'s parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.