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

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::SubscribeToShardInput

Defined in:

gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #consumer_arn ⇒ String

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

• #dry_run ⇒ Boolean

  Checks if your request will succeed.

• #shard_id ⇒ String

  The ID of the shard you want to subscribe to.

• #starting_position ⇒ Types::StartingPosition

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

• #stream_id ⇒ String

  Not Implemented.

Instance Attribute Details

#consumer_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3638

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

#dry_run ⇒ Boolean

Checks if your request will succeed. DryRun is an optional parameter.

Returns:

• (Boolean)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3638

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

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3638

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

#starting_position ⇒ Types::StartingPosition

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

Returns:

• (Types::StartingPosition)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3638

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

#stream_id ⇒ String

Not Implemented. Reserved for future use.

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3638

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