Struct aws_sdk_dynamodbstreams::operation::get_shard_iterator::builders::GetShardIteratorFluentBuilder
source · pub struct GetShardIteratorFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetShardIterator
.
Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords
request to read the stream records from the shard.
A shard iterator expires 15 minutes after it is returned to the requester.
Implementations§
source§impl GetShardIteratorFluentBuilder
impl GetShardIteratorFluentBuilder
sourcepub fn as_input(&self) -> &GetShardIteratorInputBuilder
pub fn as_input(&self) -> &GetShardIteratorInputBuilder
Access the GetShardIterator as a reference.
sourcepub async fn send(
self
) -> Result<GetShardIteratorOutput, SdkError<GetShardIteratorError, HttpResponse>>
pub async fn send( self ) -> Result<GetShardIteratorOutput, SdkError<GetShardIteratorError, HttpResponse>>
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 async fn customize(
self
) -> Result<CustomizableOperation<GetShardIteratorOutput, GetShardIteratorError, Self>, SdkError<GetShardIteratorError>>
pub async fn customize( self ) -> Result<CustomizableOperation<GetShardIteratorOutput, GetShardIteratorError, Self>, SdkError<GetShardIteratorError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the stream.
sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the stream.
sourcepub fn shard_id(self, input: impl Into<String>) -> Self
pub fn shard_id(self, input: impl Into<String>) -> Self
The identifier of the shard. The iterator will be returned for this shard ID.
sourcepub fn set_shard_id(self, input: Option<String>) -> Self
pub fn set_shard_id(self, input: Option<String>) -> Self
The identifier of the shard. The iterator will be returned for this shard ID.
sourcepub fn get_shard_id(&self) -> &Option<String>
pub fn get_shard_id(&self) -> &Option<String>
The identifier of the shard. The iterator will be returned for this shard ID.
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 stream records from the shard:
-
AT_SEQUENCE_NUMBER
- Start reading exactly from the position denoted by a specific sequence number. -
AFTER_SEQUENCE_NUMBER
- Start reading right after the position denoted by a specific sequence number. -
TRIM_HORIZON
- Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. -
LATEST
- Start reading just after the most recent stream 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 stream records from the shard:
-
AT_SEQUENCE_NUMBER
- Start reading exactly from the position denoted by a specific sequence number. -
AFTER_SEQUENCE_NUMBER
- Start reading right after the position denoted by a specific sequence number. -
TRIM_HORIZON
- Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. -
LATEST
- Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.
sourcepub fn get_shard_iterator_type(&self) -> &Option<ShardIteratorType>
pub fn get_shard_iterator_type(&self) -> &Option<ShardIteratorType>
Determines how the shard iterator is used to start reading stream records from the shard:
-
AT_SEQUENCE_NUMBER
- Start reading exactly from the position denoted by a specific sequence number. -
AFTER_SEQUENCE_NUMBER
- Start reading right after the position denoted by a specific sequence number. -
TRIM_HORIZON
- Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. -
LATEST
- Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.
sourcepub fn sequence_number(self, input: impl Into<String>) -> Self
pub fn sequence_number(self, input: impl Into<String>) -> Self
The sequence number of a stream record in the shard from which to start reading.
sourcepub fn set_sequence_number(self, input: Option<String>) -> Self
pub fn set_sequence_number(self, input: Option<String>) -> Self
The sequence number of a stream record in the shard from which to start reading.
sourcepub fn get_sequence_number(&self) -> &Option<String>
pub fn get_sequence_number(&self) -> &Option<String>
The sequence number of a stream record in the shard from which to start reading.
Trait Implementations§
source§impl Clone for GetShardIteratorFluentBuilder
impl Clone for GetShardIteratorFluentBuilder
source§fn clone(&self) -> GetShardIteratorFluentBuilder
fn clone(&self) -> GetShardIteratorFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more