libZSservicesZSamazonka-kinesisZSamazonka-kinesis
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Kinesis.SplitShard

Description

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.

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 DescribeStream 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 DescribeStream 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 a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.

If the specified stream does not exist, DescribeStream 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 AWS account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS 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.

Synopsis

Creating a Request

data SplitShard Source #

Represents the input for SplitShard.

See: newSplitShard smart constructor.

Constructors

SplitShard' 

Fields

  • streamName :: Text

    The name of the stream for the shard split.

  • shardToSplit :: Text

    The shard ID of the shard to split.

  • newStartingHashKey' :: Text

    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.

Instances

Instances details
Eq SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Read SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Show SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Generic SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Associated Types

type Rep SplitShard :: Type -> Type #

NFData SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Methods

rnf :: SplitShard -> () #

Hashable SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

ToJSON SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

AWSRequest SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Associated Types

type AWSResponse SplitShard #

ToHeaders SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Methods

toHeaders :: SplitShard -> [Header] #

ToPath SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

ToQuery SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

type Rep SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

type Rep SplitShard = D1 ('MetaData "SplitShard" "Amazonka.Kinesis.SplitShard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SplitShard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "shardToSplit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "newStartingHashKey'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SplitShard Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

newSplitShard Source #

Create a value of SplitShard with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamName:SplitShard', splitShard_streamName - The name of the stream for the shard split.

$sel:shardToSplit:SplitShard', splitShard_shardToSplit - The shard ID of the shard to split.

$sel:newStartingHashKey':SplitShard', splitShard_newStartingHashKey - 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.

Request Lenses

splitShard_streamName :: Lens' SplitShard Text Source #

The name of the stream for the shard split.

splitShard_shardToSplit :: Lens' SplitShard Text Source #

The shard ID of the shard to split.

splitShard_newStartingHashKey :: Lens' SplitShard Text Source #

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.

Destructuring the Response

data SplitShardResponse Source #

See: newSplitShardResponse smart constructor.

Constructors

SplitShardResponse' 

Instances

Instances details
Eq SplitShardResponse Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Read SplitShardResponse Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Show SplitShardResponse Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Generic SplitShardResponse Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Associated Types

type Rep SplitShardResponse :: Type -> Type #

NFData SplitShardResponse Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

Methods

rnf :: SplitShardResponse -> () #

type Rep SplitShardResponse Source # 
Instance details

Defined in Amazonka.Kinesis.SplitShard

type Rep SplitShardResponse = D1 ('MetaData "SplitShardResponse" "Amazonka.Kinesis.SplitShard" "libZSservicesZSamazonka-kinesisZSamazonka-kinesis" 'False) (C1 ('MetaCons "SplitShardResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSplitShardResponse :: SplitShardResponse Source #

Create a value of SplitShardResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.