Class: Aws::Kinesis::Types::SubscribeToShardInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_arn ⇒ String

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Returns:

  • (String) 


2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2712

class SubscribeToShardInput < Struct.new(
  :consumer_arn,
  :stream_id,
  :shard_id,
  :starting_position)
  SENSITIVE = []
  include Aws::Structure
end

#shard_id ⇒ String

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Returns:

  • (String) 


2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2712

class SubscribeToShardInput < Struct.new(
  :consumer_arn,
  :stream_id,
  :shard_id,
  :starting_position)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position ⇒ Types::StartingPosition

The starting position in the data stream from which to start streaming.

Returns:



2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2712

class SubscribeToShardInput < Struct.new(
  :consumer_arn,
  :stream_id,
  :shard_id,
  :starting_position)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ String

Not Implemented. Reserved for future use.

Returns:

  • (String) 


2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2712

class SubscribeToShardInput < Struct.new(
  :consumer_arn,
  :stream_id,
  :shard_id,
  :starting_position)
  SENSITIVE = []
  include Aws::Structure
end