Module: Aws::Kinesis::Types

Defined in:

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

Defined Under Namespace

Classes: AccessDeniedException, AddTagsToStreamInput, ChildShard, Consumer, ConsumerDescription, CreateStreamInput, DecreaseStreamRetentionPeriodInput, DeleteResourcePolicyInput, DeleteStreamInput, DeregisterStreamConsumerInput, DescribeLimitsOutput, DescribeStreamConsumerInput, DescribeStreamConsumerOutput, DescribeStreamInput, DescribeStreamOutput, DescribeStreamSummaryInput, DescribeStreamSummaryOutput, DisableEnhancedMonitoringInput, EnableEnhancedMonitoringInput, EnhancedMetrics, EnhancedMonitoringOutput, ExpiredIteratorException, ExpiredNextTokenException, GetRecordsInput, GetRecordsOutput, GetResourcePolicyInput, GetResourcePolicyOutput, GetShardIteratorInput, GetShardIteratorOutput, HashKeyRange, IncreaseStreamRetentionPeriodInput, InternalFailureException, InvalidArgumentException, KMSAccessDeniedException, KMSDisabledException, KMSInvalidStateException, KMSNotFoundException, KMSOptInRequired, KMSThrottlingException, LimitExceededException, ListShardsInput, ListShardsOutput, ListStreamConsumersInput, ListStreamConsumersOutput, ListStreamsInput, ListStreamsOutput, ListTagsForResourceInput, ListTagsForResourceOutput, ListTagsForStreamInput, ListTagsForStreamOutput, MergeShardsInput, ProvisionedThroughputExceededException, PutRecordInput, PutRecordOutput, PutRecordsInput, PutRecordsOutput, PutRecordsRequestEntry, PutRecordsResultEntry, PutResourcePolicyInput, Record, RegisterStreamConsumerInput, RegisterStreamConsumerOutput, RemoveTagsFromStreamInput, ResourceInUseException, ResourceNotFoundException, SequenceNumberRange, Shard, ShardFilter, SplitShardInput, StartStreamEncryptionInput, StartingPosition, StopStreamEncryptionInput, StreamDescription, StreamDescriptionSummary, StreamModeDetails, StreamSummary, SubscribeToShardEvent, SubscribeToShardEventStream, SubscribeToShardInput, SubscribeToShardOutput, Tag, TagResourceInput, UntagResourceInput, UpdateMaxRecordSizeInput, UpdateShardCountInput, UpdateShardCountOutput, UpdateStreamModeInput, ValidationException

Instance Attribute Summary

• #child_shards ⇒ Array<Types::ChildShard>

  The list of the child shards of the current shard, returned only at the end of the current shard.

• #continuation_sequence_number ⇒ String

  Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

• #message ⇒ String

  A message that provides information about the error.

• #millis_behind_latest ⇒ Integer

  The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is.

• #records ⇒ Array<Types::Record>

Instance Attribute Details

#child_shards ⇒ Array<Types::ChildShard>

The list of the child shards of the current shard, returned only at the end of the current shard.

Returns:

• (Array<Types::ChildShard>)

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

class SubscribeToShardEvent < Struct.new(
  :records,
  :continuation_sequence_number,
  :millis_behind_latest,
  :child_shards,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#continuation_sequence_number ⇒ String

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Returns:

• (String)

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

class SubscribeToShardEvent < Struct.new(
  :records,
  :continuation_sequence_number,
  :millis_behind_latest,
  :child_shards,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

A message that provides information about the error.

Returns:

• (String)

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

class InternalFailureException < Struct.new(
  :message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#millis_behind_latest ⇒ Integer

The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

Returns:

• (Integer)

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

class SubscribeToShardEvent < Struct.new(
  :records,
  :continuation_sequence_number,
  :millis_behind_latest,
  :child_shards,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#records ⇒ Array<Types::Record>

Returns:

• (Array<Types::Record>)

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

class SubscribeToShardEvent < Struct.new(
  :records,
  :continuation_sequence_number,
  :millis_behind_latest,
  :child_shards,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end