1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_shard_iterator::_get_shard_iterator_output::GetShardIteratorOutputBuilder;
pub use crate::operation::get_shard_iterator::_get_shard_iterator_input::GetShardIteratorInputBuilder;
impl crate::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::get_shard_iterator::GetShardIteratorOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_shard_iterator::GetShardIteratorError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_shard_iterator();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetShardIterator`.
///
/// <p>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 <code>GetRecords</code> request to read the stream records from the shard.</p><note>
/// <p>A shard iterator expires 15 minutes after it is returned to the requester.</p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetShardIteratorFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_shard_iterator::GetShardIteratorOutput,
crate::operation::get_shard_iterator::GetShardIteratorError,
> for GetShardIteratorFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_shard_iterator::GetShardIteratorOutput,
crate::operation::get_shard_iterator::GetShardIteratorError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetShardIteratorFluentBuilder {
/// Creates a new `GetShardIteratorFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the GetShardIterator as a reference.
pub fn as_input(&self) -> &crate::operation::get_shard_iterator::builders::GetShardIteratorInputBuilder {
&self.inner
}
/// 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::operation::get_shard_iterator::GetShardIteratorOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_shard_iterator::GetShardIteratorError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::get_shard_iterator::GetShardIterator::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_shard_iterator::GetShardIterator::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::get_shard_iterator::GetShardIteratorOutput,
crate::operation::get_shard_iterator::GetShardIteratorError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The Amazon Resource Name (ARN) for the stream.</p>
pub fn stream_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.stream_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) for the stream.</p>
pub fn set_stream_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_stream_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) for the stream.</p>
pub fn get_stream_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_stream_arn()
}
/// <p>The identifier of the shard. The iterator will be returned for this shard ID.</p>
pub fn shard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.shard_id(input.into());
self
}
/// <p>The identifier of the shard. The iterator will be returned for this shard ID.</p>
pub fn set_shard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_shard_id(input);
self
}
/// <p>The identifier of the shard. The iterator will be returned for this shard ID.</p>
pub fn get_shard_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_shard_id()
}
/// <p>Determines how the shard iterator is used to start reading stream records from the shard:</p>
/// <ul>
/// <li>
/// <p><code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number.</p></li>
/// <li>
/// <p><code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number.</p></li>
/// <li>
/// <p><code>TRIM_HORIZON</code> - 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.</p></li>
/// <li>
/// <p><code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.</p></li>
/// </ul>
pub fn shard_iterator_type(mut self, input: crate::types::ShardIteratorType) -> Self {
self.inner = self.inner.shard_iterator_type(input);
self
}
/// <p>Determines how the shard iterator is used to start reading stream records from the shard:</p>
/// <ul>
/// <li>
/// <p><code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number.</p></li>
/// <li>
/// <p><code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number.</p></li>
/// <li>
/// <p><code>TRIM_HORIZON</code> - 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.</p></li>
/// <li>
/// <p><code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.</p></li>
/// </ul>
pub fn set_shard_iterator_type(mut self, input: ::std::option::Option<crate::types::ShardIteratorType>) -> Self {
self.inner = self.inner.set_shard_iterator_type(input);
self
}
/// <p>Determines how the shard iterator is used to start reading stream records from the shard:</p>
/// <ul>
/// <li>
/// <p><code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number.</p></li>
/// <li>
/// <p><code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number.</p></li>
/// <li>
/// <p><code>TRIM_HORIZON</code> - 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.</p></li>
/// <li>
/// <p><code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.</p></li>
/// </ul>
pub fn get_shard_iterator_type(&self) -> &::std::option::Option<crate::types::ShardIteratorType> {
self.inner.get_shard_iterator_type()
}
/// <p>The sequence number of a stream record in the shard from which to start reading.</p>
pub fn sequence_number(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.sequence_number(input.into());
self
}
/// <p>The sequence number of a stream record in the shard from which to start reading.</p>
pub fn set_sequence_number(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_sequence_number(input);
self
}
/// <p>The sequence number of a stream record in the shard from which to start reading.</p>
pub fn get_sequence_number(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_sequence_number()
}
}