Class: Aws::Kinesis::Types::DescribeStreamInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::DescribeStreamInput
- Defined in:
- gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb
Overview
Represents the input for DescribeStream
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#exclusive_start_shard_id ⇒ String
The shard ID of the shard to start with.
-
#limit ⇒ Integer
The maximum number of shards to return in a single call.
-
#stream_arn ⇒ String
The ARN of the stream.
-
#stream_name ⇒ String
The name of the stream to describe.
Instance Attribute Details
#exclusive_start_shard_id ⇒ String
The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the
stream starting with the shard whose ID immediately follows
ExclusiveStartShardId
.
If you don't specify this parameter, the default behavior for
DescribeStream
is to describe the stream starting with the first
shard in the stream.
379 380 381 382 383 384 385 386 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 379 class DescribeStreamInput < Struct.new( :stream_name, :limit, :exclusive_start_shard_id, :stream_arn) SENSITIVE = [] include Aws::Structure end |
#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 results are returned.
379 380 381 382 383 384 385 386 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 379 class DescribeStreamInput < Struct.new( :stream_name, :limit, :exclusive_start_shard_id, :stream_arn) SENSITIVE = [] include Aws::Structure end |
#stream_arn ⇒ String
The ARN of the stream.
379 380 381 382 383 384 385 386 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 379 class DescribeStreamInput < Struct.new( :stream_name, :limit, :exclusive_start_shard_id, :stream_arn) SENSITIVE = [] include Aws::Structure end |
#stream_name ⇒ String
The name of the stream to describe.
379 380 381 382 383 384 385 386 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 379 class DescribeStreamInput < Struct.new( :stream_name, :limit, :exclusive_start_shard_id, :stream_arn) SENSITIVE = [] include Aws::Structure end |