You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Kinesis::Types::ListShardsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass ListShardsInput data as a hash:

{
  stream_name: "StreamName",
  next_token: "NextToken",
  exclusive_start_shard_id: "ShardId",
  max_results: 1,
  stream_creation_timestamp: Time.now,
}

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_start_shard_idString

The ID of the shard to start the list with.

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.

Returns:

  • (String)


663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 663

class ListShardsInput < Struct.new(
  :stream_name,
  :next_token,
  :exclusive_start_shard_id,
  :max_results,
  :stream_creation_timestamp)
  include Aws::Structure
end

#max_resultsInteger

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 1,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.

Returns:

  • (Integer)


663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 663

class ListShardsInput < Struct.new(
  :stream_name,
  :next_token,
  :exclusive_start_shard_id,
  :max_results,
  :stream_creation_timestamp)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 663

class ListShardsInput < Struct.new(
  :stream_name,
  :next_token,
  :exclusive_start_shard_id,
  :max_results,
  :stream_creation_timestamp)
  include Aws::Structure
end

#stream_creation_timestampTime

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.

Returns:

  • (Time)


663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 663

class ListShardsInput < Struct.new(
  :stream_name,
  :next_token,
  :exclusive_start_shard_id,
  :max_results,
  :stream_creation_timestamp)
  include Aws::Structure
end

#stream_nameString

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

Returns:

  • (String)


663
664
665
666
667
668
669
670
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 663

class ListShardsInput < Struct.new(
  :stream_name,
  :next_token,
  :exclusive_start_shard_id,
  :max_results,
  :stream_creation_timestamp)
  include Aws::Structure
end