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

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

{
  consumer_arn: "ConsumerARN", # required
  shard_id: "ShardId", # required
  starting_position: { # required
    type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    sequence_number: "SequenceNumber",
    timestamp: Time.now,
  },
}

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) 


2328
2329
2330
2331
2332
2333
2334
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2328

class SubscribeToShardInput < Struct.new(
  :consumer_arn,
  :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) 


2328
2329
2330
2331
2332
2333
2334
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2328

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

#starting_position ⇒ Types::StartingPosition

Returns:



2328
2329
2330
2331
2332
2333
2334
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2328

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