Struct aws_sdk_kinesis::client::fluent_builders::SplitShard
source · pub struct SplitShard { /* private fields */ }
Expand description
Fluent builder constructing a request to SplitShard
.
Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard
is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. This API is only supported for the data streams with the provisioned capacity mode.
When invoking this API, it is recommended you use the StreamARN
input parameter rather than the StreamName
input parameter.
You can also use SplitShard
when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard
to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.
You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.
You can use DescribeStreamSummary
and the ListShards
APIs to determine the shard ID and hash key values for the ShardToSplit
and NewStartingHashKey
parameters that are specified in the SplitShard
request.
SplitShard
is an asynchronous operation. Upon receiving a SplitShard
request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING
. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE
. Read and write operations continue to work while the stream is in the UPDATING
state.
You can use DescribeStreamSummary
to check the status of the stream, which is returned in StreamStatus
. If the stream is in the ACTIVE
state, you can call SplitShard
.
If the specified stream does not exist, DescribeStreamSummary
returns a ResourceNotFoundException
. If you try to create more shards than are authorized for your account, you receive a LimitExceededException
.
For the default shard limit for an Amazon Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
If you try to operate on too many streams simultaneously using CreateStream
, DeleteStream
, MergeShards
, and/or SplitShard
, you receive a LimitExceededException
.
SplitShard
has a limit of five transactions per second per account.
Implementations§
source§impl SplitShard
impl SplitShard
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<SplitShard, AwsResponseRetryClassifier>, SdkError<SplitShardError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<SplitShard, AwsResponseRetryClassifier>, SdkError<SplitShardError>>
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<SplitShardOutput, SdkError<SplitShardError>>
pub async fn send(self) -> Result<SplitShardOutput, SdkError<SplitShardError>>
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 shard split.
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 shard split.
sourcepub fn shard_to_split(self, input: impl Into<String>) -> Self
pub fn shard_to_split(self, input: impl Into<String>) -> Self
The shard ID of the shard to split.
sourcepub fn set_shard_to_split(self, input: Option<String>) -> Self
pub fn set_shard_to_split(self, input: Option<String>) -> Self
The shard ID of the shard to split.
sourcepub fn new_starting_hash_key(self, input: impl Into<String>) -> Self
pub fn new_starting_hash_key(self, input: impl Into<String>) -> Self
A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey
must be in the range of hash keys being mapped into the shard. The NewStartingHashKey
hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
sourcepub fn set_new_starting_hash_key(self, input: Option<String>) -> Self
pub fn set_new_starting_hash_key(self, input: Option<String>) -> Self
A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey
must be in the range of hash keys being mapped into the shard. The NewStartingHashKey
hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
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 SplitShard
impl Clone for SplitShard
source§fn clone(&self) -> SplitShard
fn clone(&self) -> SplitShard
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more