Network.AWS.Kinesis.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 DescribeStream 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 DescribeStream 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.

Creating a Request

mergeShards

Arguments

:: Text

msStreamName

-> Text

msShardToMerge

-> Text

msAdjacentShardToMerge

-> MergeShards

Creates a value of MergeShards with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• msStreamName - The name of the stream for the merge.
• msShardToMerge - The shard ID of the shard to combine with the adjacent shard for the merge.
• msAdjacentShardToMerge - The shard ID of the adjacent shard for the merge.

data MergeShards

Represents the input for MergeShards .

See: mergeShards smart constructor.

Instances

Eq MergeShards

Methods

(==) :: MergeShards -> MergeShards -> Bool

(/=) :: MergeShards -> MergeShards -> Bool

Data MergeShards

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MergeShards -> c MergeShards

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MergeShards

toConstr :: MergeShards -> Constr

dataTypeOf :: MergeShards -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MergeShards)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MergeShards)

gmapT :: (forall b. Data b => b -> b) -> MergeShards -> MergeShards

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MergeShards -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MergeShards -> r

gmapQ :: (forall d. Data d => d -> u) -> MergeShards -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MergeShards -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MergeShards -> m MergeShards

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MergeShards -> m MergeShards

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MergeShards -> m MergeShards

Read MergeShards

Methods

readsPrec :: Int -> ReadS MergeShards

readList :: ReadS [MergeShards]

readPrec :: ReadPrec MergeShards

readListPrec :: ReadPrec [MergeShards]

Show MergeShards

Methods

showsPrec :: Int -> MergeShards -> ShowS

show :: MergeShards -> String

showList :: [MergeShards] -> ShowS

Generic MergeShards

Associated Types

type Rep MergeShards :: * -> *

Methods

from :: MergeShards -> Rep MergeShards x

to :: Rep MergeShards x -> MergeShards

Hashable MergeShards

Methods

hashWithSalt :: Int -> MergeShards -> Int

hash :: MergeShards -> Int

ToJSON MergeShards

Methods

toJSON :: MergeShards -> Value

toEncoding :: MergeShards -> Encoding

toJSONList :: [MergeShards] -> Value

toEncodingList :: [MergeShards] -> Encoding

NFData MergeShards

Methods

rnf :: MergeShards -> ()

AWSRequest MergeShards

Associated Types

type Rs MergeShards :: *

Methods

request :: MergeShards -> Request MergeShards

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * MergeShards -> ClientResponse -> m (Response MergeShards)

ToHeaders MergeShards

Methods

toHeaders :: MergeShards -> [Header]

ToPath MergeShards

Methods

toPath :: MergeShards -> ByteString

ToQuery MergeShards

Methods

toQuery :: MergeShards -> QueryString

type Rep MergeShards

type Rep MergeShards = D1 * (MetaData "MergeShards" "Network.AWS.Kinesis.MergeShards" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "MergeShards'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_msStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_msShardToMerge") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_msAdjacentShardToMerge") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs MergeShards

type Rs MergeShards = MergeShardsResponse

Request Lenses

msStreamName :: Lens' MergeShards Text

The name of the stream for the merge.

msShardToMerge :: Lens' MergeShards Text

The shard ID of the shard to combine with the adjacent shard for the merge.

msAdjacentShardToMerge :: Lens' MergeShards Text

The shard ID of the adjacent shard for the merge.

Destructuring the Response

mergeShardsResponse :: MergeShardsResponse

Creates a value of MergeShardsResponse with the minimum fields required to make a request.

data MergeShardsResponse

See: mergeShardsResponse smart constructor.

Instances

Eq MergeShardsResponse

Methods

(==) :: MergeShardsResponse -> MergeShardsResponse -> Bool

(/=) :: MergeShardsResponse -> MergeShardsResponse -> Bool

Data MergeShardsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MergeShardsResponse -> c MergeShardsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MergeShardsResponse

toConstr :: MergeShardsResponse -> Constr

dataTypeOf :: MergeShardsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MergeShardsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MergeShardsResponse)

gmapT :: (forall b. Data b => b -> b) -> MergeShardsResponse -> MergeShardsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MergeShardsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MergeShardsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> MergeShardsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MergeShardsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MergeShardsResponse -> m MergeShardsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MergeShardsResponse -> m MergeShardsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MergeShardsResponse -> m MergeShardsResponse

Read MergeShardsResponse

Methods

readsPrec :: Int -> ReadS MergeShardsResponse

readList :: ReadS [MergeShardsResponse]

readPrec :: ReadPrec MergeShardsResponse

readListPrec :: ReadPrec [MergeShardsResponse]

Show MergeShardsResponse

Methods

showsPrec :: Int -> MergeShardsResponse -> ShowS

show :: MergeShardsResponse -> String

showList :: [MergeShardsResponse] -> ShowS

Generic MergeShardsResponse

Associated Types

type Rep MergeShardsResponse :: * -> *

Methods

from :: MergeShardsResponse -> Rep MergeShardsResponse x

to :: Rep MergeShardsResponse x -> MergeShardsResponse

NFData MergeShardsResponse

Methods

rnf :: MergeShardsResponse -> ()

type Rep MergeShardsResponse

type Rep MergeShardsResponse = D1 * (MetaData "MergeShardsResponse" "Network.AWS.Kinesis.MergeShards" "amazonka-kinesis-1.6.0-FM91TbfEPFA6fwZObkhzFa" False) (C1 * (MetaCons "MergeShardsResponse'" PrefixI False) (U1 *))