AWSKinesisGetShardIteratorInput

@interface AWSKinesisGetShardIteratorInput

Represents the input for GetShardIterator.

Required parameters: [StreamName, ShardId, ShardIteratorType]

  • The shard ID of the Kinesis Data Streams shard to get the iterator for.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable shardId;

    Swift

    var shardId: String? { get set }
  • Determines how the shard iterator is used to start reading data records from the shard.

    The following are the valid Amazon Kinesis shard iterator types:

    • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

    • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

    • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

    • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

    • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        AWSKinesisShardIteratorType shardIteratorType;

    Swift

    var shardIteratorType: AWSKinesisShardIteratorType { get set }
  • The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSString *_Nullable startingSequenceNumber;

    Swift

    var startingSequenceNumber: String? { get set }
  • The name of the Amazon Kinesis data stream.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable streamName;

    Swift

    var streamName: String? { get set }
  • The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSDate *_Nullable timestamp;

    Swift

    var timestamp: Date? { get set }