Class: Aws::Kinesis::Types::GetRecordsOutput

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::GetRecordsOutput

Defined in:

(unknown)

Overview

Represents the output for GetRecords.

Returned by:

• Client#get_records

See Also:

• AWS API Documentation

Instance Attribute Summary

• #child_shards ⇒ Array<Types::ChildShard>
• #millis_behind_latest ⇒ Integer

  The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is.

• #next_shard_iterator ⇒ String

  The next position in the shard from which to start sequentially reading data records.

• #records ⇒ Array<Types::Record>

  The data records retrieved from the shard.

Instance Attribute Details

#child_shards ⇒ Array<Types::ChildShard>

Returns:

• (Array<Types::ChildShard>)

#millis_behind_latest ⇒ Integer

The number of milliseconds the GetRecords response is 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) —

  The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is.

#next_shard_iterator ⇒ String

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Returns:

• (String) —

  The next position in the shard from which to start sequentially reading data records.

#records ⇒ Array<Types::Record>

The data records retrieved from the shard.

Returns:

• (Array<Types::Record>) —

  The data records retrieved from the shard.