You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Module: Aws::Kinesis::Types

Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Defined Under Namespace

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

Instance Attribute Summary collapse

Instance Attribute Details

#continuation_sequence_numberString

Use this as StartingSequenceNumber in the next call to SubscribeToShard.

Returns:

  • (String)


2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2121

class SubscribeToShardEvent < Struct.new(
  :records,
  :continuation_sequence_number,
  :millis_behind_latest,
  :event_type)
  include Aws::Structure
end

#messageString

A message that provides information about the error.

Returns:

  • (String)


788
789
790
791
792
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 788

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

#millis_behind_latestInteger

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)


2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2121

class SubscribeToShardEvent < Struct.new(
  :records,
  :continuation_sequence_number,
  :millis_behind_latest,
  :event_type)
  include Aws::Structure
end

#recordsArray<Types::Record>

Returns:



2121
2122
2123
2124
2125
2126
2127
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2121

class SubscribeToShardEvent < Struct.new(
  :records,
  :continuation_sequence_number,
  :millis_behind_latest,
  :event_type)
  include Aws::Structure
end