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

Class: Aws::Kinesis::Types::DescribeStreamInput

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 DescribeStreamInput data as a hash:

{
  stream_name: "StreamName", # required
  limit: 1,
  exclusive_start_shard_id: "ShardId",
}

Represents the input for DescribeStream.

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_start_shard_idString

The shard ID of the shard to start with.

Returns:

  • (String)


169
170
171
172
173
174
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 169

class DescribeStreamInput < Struct.new(
  :stream_name,
  :limit,
  :exclusive_start_shard_id)
  include Aws::Structure
end

#limitInteger

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

Returns:

  • (Integer)


169
170
171
172
173
174
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 169

class DescribeStreamInput < Struct.new(
  :stream_name,
  :limit,
  :exclusive_start_shard_id)
  include Aws::Structure
end

#stream_nameString

The name of the stream to describe.

Returns:

  • (String)


169
170
171
172
173
174
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 169

class DescribeStreamInput < Struct.new(
  :stream_name,
  :limit,
  :exclusive_start_shard_id)
  include Aws::Structure
end