Class: Aws::Kinesis::Types::ListShardsOutput

Inherits:

Struct

Object
Struct
Aws::Kinesis::Types::ListShardsOutput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-kinesis/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

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 for `MaxResults` that is less than the number of shards in the data stream, the response includes a pagination token named `NextToken`.
#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.

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`.

Returns:

(String)

# File 'lib/aws-sdk-kinesis/types.rb', line 1161

class ListShardsOutput < Struct.new(
  :shards,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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.