Struct aws_sdk_dynamodbstreams::input::GetShardIteratorInput

#[non_exhaustive]
pub struct GetShardIteratorInput { /* private fields */ }

Represents the input of a GetShardIterator operation.

Implementations

impl GetShardIteratorInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GetShardIterator, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<GetShardIterator>

Examples found in repository

src/client.rs (line 375)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::GetShardIterator,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::GetShardIteratorError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::GetShardIteratorOutput,
            aws_smithy_http::result::SdkError<crate::error::GetShardIteratorError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GetShardIteratorInput.

impl GetShardIteratorInput

pub fn stream_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the stream.

pub fn shard_id(&self) -> Option<&str>

The identifier of the shard. The iterator will be returned for this shard ID.

pub fn 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.

pub fn sequence_number(&self) -> Option<&str>

The sequence number of a stream record in the shard from which to start reading.

Trait Implementations

impl Clone for GetShardIteratorInput

fn clone(&self) -> GetShardIteratorInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetShardIteratorInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<GetShardIteratorInput> for GetShardIteratorInput

fn eq(&self, other: &GetShardIteratorInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetShardIteratorInput