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. This API is only supported for the data streams with the provisioned capacity mode. 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.
When invoking this API, it is recommended you use the StreamARN
input parameter rather than the StreamName
input parameter.
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§
source§impl MergeShards
impl MergeShards
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<MergeShards, AwsResponseRetryClassifier>, SdkError<MergeShardsError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<MergeShards, AwsResponseRetryClassifier>, SdkError<MergeShardsError>>
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<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.
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 MergeShards
impl Clone for MergeShards
source§fn clone(&self) -> MergeShards
fn clone(&self) -> MergeShards
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more