Struct aws_sdk_kinesis::client::fluent_builders::GetShardIterator
source · pub struct GetShardIterator { /* private fields */ }
Expand description
Fluent builder constructing a request to GetShardIterator
.
Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.
When invoking this API, it is recommended you use the StreamARN
input parameter rather than the StreamName
input parameter.
A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.
You must specify the shard iterator type. For example, you can set the ShardIteratorType
parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER
shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER
shard iterator type, using sequence numbers returned by earlier calls to PutRecord
, PutRecords
, GetRecords
, or DescribeStream
. In the request, you can specify the shard iterator type AT_TIMESTAMP
to read records from an arbitrary point in time, TRIM_HORIZON
to cause ShardIterator
to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST
so that you always read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator
request to get the first shard iterator for use in your first GetRecords
request and for subsequent reads use the shard iterator returned by the GetRecords
request in NextShardIterator
. A new shard iterator is returned by every GetRecords
request in NextShardIterator
, which you use in the ShardIterator
parameter of the next GetRecords
request.
If a GetShardIterator
request is made too often, you receive a ProvisionedThroughputExceededException
. For more information about throughput limits, see GetRecords
, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
If the shard is closed, GetShardIterator
returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard
or MergeShards
.
GetShardIterator
has a limit of five transactions per second per account per open shard.
Implementations§
source§impl GetShardIterator
impl GetShardIterator
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<GetShardIterator, AwsResponseRetryClassifier>, SdkError<GetShardIteratorError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<GetShardIterator, AwsResponseRetryClassifier>, SdkError<GetShardIteratorError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<GetShardIteratorOutput, SdkError<GetShardIteratorError>>
pub async fn send(
self
) -> Result<GetShardIteratorOutput, SdkError<GetShardIteratorError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The name of the Amazon Kinesis data stream.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the Amazon Kinesis data stream.
sourcepub fn shard_id(self, input: impl Into<String>) -> Self
pub fn shard_id(self, input: impl Into<String>) -> Self
The shard ID of the Kinesis Data Streams shard to get the iterator for.
sourcepub fn set_shard_id(self, input: Option<String>) -> Self
pub fn set_shard_id(self, input: Option<String>) -> Self
The shard ID of the Kinesis Data Streams shard to get the iterator for.
sourcepub fn shard_iterator_type(self, input: ShardIteratorType) -> Self
pub fn shard_iterator_type(self, input: ShardIteratorType) -> Self
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.
sourcepub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self
pub fn set_shard_iterator_type(self, input: Option<ShardIteratorType>) -> Self
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.
sourcepub fn starting_sequence_number(self, input: impl Into<String>) -> Self
pub fn starting_sequence_number(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_starting_sequence_number(self, input: Option<String>) -> Self
pub fn set_starting_sequence_number(self, input: Option<String>) -> Self
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.
sourcepub fn timestamp(self, input: DateTime) -> Self
pub fn timestamp(self, input: DateTime) -> Self
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).
sourcepub fn set_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_timestamp(self, input: Option<DateTime>) -> Self
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).
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The ARN of the stream.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The ARN of the stream.
Trait Implementations§
source§impl Clone for GetShardIterator
impl Clone for GetShardIterator
source§fn clone(&self) -> GetShardIterator
fn clone(&self) -> GetShardIterator
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more