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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeStreamInput as input to an Aws::Client method, you can use a vanilla Hash:

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

Represents the input for DescribeStream.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#exclusive_start_shard_id ⇒ String

The shard ID of the shard to start with.

Returns:

  • (String) —

    The shard ID of the shard to start with.

#limit ⇒ Integer

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) —

    The maximum number of shards to return in a single call.

#stream_name ⇒ String

The name of the stream to describe.

Returns:

  • (String) —

    The name of the stream to describe.