Class GetShardIteratorRequest
Gets an iterator that marks a position in a shard, to read records from (DynamoDB Streams GetShardIterator).
public sealed record GetShardIteratorRequest : IEquatable<GetShardIteratorRequest>
- Inheritance
-
GetShardIteratorRequest
- Implements
- Inherited Members
Remarks
The iterator is valid for 15 minutes. After that GetRecords fails with ExpiredIteratorException and a new
iterator is needed: take one with AfterSequenceNumber and the sequence number of the last record
processed. Requesting a position older than the 24 hours of retention fails with TrimmedDataAccessException.
Constructors
GetShardIteratorRequest()
public GetShardIteratorRequest()
Properties
SequenceNumber
Gets the sequence number to start at or after. Required for AtSequenceNumber and AfterSequenceNumber, and not allowed for the other types.
public string? SequenceNumber { get; init; }
Property Value
ShardId
Gets the identifier of the shard.
public required string ShardId { get; init; }
Property Value
ShardIteratorType
Gets where in the shard reading starts.
public required ShardIteratorType ShardIteratorType { get; init; }
Property Value
StreamArn
Gets the ARN of the stream.
public required string StreamArn { get; init; }
Property Value
Methods
Equals(GetShardIteratorRequest?)
public bool Equals(GetShardIteratorRequest? other)
Parameters
otherGetShardIteratorRequest
Returns
Equals(object?)
public override bool Equals(object? obj)
Parameters
objobject
Returns
GetHashCode()
public override int GetHashCode()
Returns
ToString()
public override string ToString()
Returns
Operators
operator ==(GetShardIteratorRequest?, GetShardIteratorRequest?)
public static bool operator ==(GetShardIteratorRequest? left, GetShardIteratorRequest? right)
Parameters
leftGetShardIteratorRequestrightGetShardIteratorRequest
Returns
operator !=(GetShardIteratorRequest?, GetShardIteratorRequest?)
public static bool operator !=(GetShardIteratorRequest? left, GetShardIteratorRequest? right)
Parameters
leftGetShardIteratorRequestrightGetShardIteratorRequest