Struct aws_sdk_kinesis::client::fluent_builders::MergeShards
source · [−]pub struct MergeShards { /* private fields */ }
Expand description
Fluent builder constructing a request to MergeShards
.
Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
MergeShards
is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.
If the stream is in the ACTIVE
state, you can call MergeShards
. If a stream is in the CREATING
, UPDATING
, or DELETING
state, MergeShards
returns a ResourceInUseException
. If the specified stream does not exist, MergeShards
returns a ResourceNotFoundException
.
You can use DescribeStreamSummary
to check the state of the stream, which is returned in StreamStatus
.
MergeShards
is an asynchronous operation. Upon receiving a MergeShards
request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus
to UPDATING
. After the operation is completed, Kinesis Data Streams sets the StreamStatus
to ACTIVE
. Read and write operations continue to work while the stream is in the UPDATING
state.
You use DescribeStreamSummary
and the ListShards
APIs to determine the shard IDs that are specified in the MergeShards
request.
If you try to operate on too many streams in parallel using CreateStream
, DeleteStream
, MergeShards
, or SplitShard
, you receive a LimitExceededException
.
MergeShards
has a limit of five transactions per second per account.
Implementations
sourceimpl MergeShards
impl MergeShards
sourcepub async fn send(self) -> Result<MergeShardsOutput, SdkError<MergeShardsError>>
pub async fn send(self) -> Result<MergeShardsOutput, SdkError<MergeShardsError>>
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 stream for the merge.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the stream for the merge.
sourcepub fn shard_to_merge(self, input: impl Into<String>) -> Self
pub fn shard_to_merge(self, input: impl Into<String>) -> Self
The shard ID of the shard to combine with the adjacent shard for the merge.
sourcepub fn set_shard_to_merge(self, input: Option<String>) -> Self
pub fn set_shard_to_merge(self, input: Option<String>) -> Self
The shard ID of the shard to combine with the adjacent shard for the merge.
sourcepub fn adjacent_shard_to_merge(self, input: impl Into<String>) -> Self
pub fn adjacent_shard_to_merge(self, input: impl Into<String>) -> Self
The shard ID of the adjacent shard for the merge.
sourcepub fn set_adjacent_shard_to_merge(self, input: Option<String>) -> Self
pub fn set_adjacent_shard_to_merge(self, input: Option<String>) -> Self
The shard ID of the adjacent shard for the merge.
Trait Implementations
sourceimpl Clone for MergeShards
impl Clone for MergeShards
sourcefn clone(&self) -> MergeShards
fn clone(&self) -> MergeShards
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for MergeShards
impl Send for MergeShards
impl Sync for MergeShards
impl Unpin for MergeShards
impl !UnwindSafe for MergeShards
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more