Amazonka.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. 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.

Creating a Request

data MergeShards

Represents the input for MergeShards.

See: newMergeShards smart constructor.

Constructors

MergeShards'

Fields

• streamARN :: Maybe Text

  The ARN of the stream.

• streamName :: Maybe Text

  The name of the stream for the merge.

• shardToMerge :: Text

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

• adjacentShardToMerge :: Text

  The shard ID of the adjacent shard for the merge.

Instances

ToJSON MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

toJSON :: MergeShards -> Value

toEncoding :: MergeShards -> Encoding

toJSONList :: [MergeShards] -> Value

toEncodingList :: [MergeShards] -> Encoding

ToHeaders MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

toHeaders :: MergeShards -> [Header]

ToPath MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

toPath :: MergeShards -> ByteString

ToQuery MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

toQuery :: MergeShards -> QueryString

AWSRequest MergeShards

Defined in Amazonka.Kinesis.MergeShards

Associated Types

type AWSResponse MergeShards

Methods

request :: (Service -> Service) -> MergeShards -> Request MergeShards

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy MergeShards -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse MergeShards)))

Generic MergeShards

Defined in Amazonka.Kinesis.MergeShards

Associated Types

type Rep MergeShards :: Type -> Type

Methods

from :: MergeShards -> Rep MergeShards x

to :: Rep MergeShards x -> MergeShards

Read MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

readsPrec :: Int -> ReadS MergeShards

readList :: ReadS [MergeShards]

readPrec :: ReadPrec MergeShards

readListPrec :: ReadPrec [MergeShards]

Show MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

showsPrec :: Int -> MergeShards -> ShowS

show :: MergeShards -> String

showList :: [MergeShards] -> ShowS

NFData MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

rnf :: MergeShards -> ()

Eq MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

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

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

Hashable MergeShards

Defined in Amazonka.Kinesis.MergeShards

Methods

hashWithSalt :: Int -> MergeShards -> Int

hash :: MergeShards -> Int

type AWSResponse MergeShards

Defined in Amazonka.Kinesis.MergeShards

type AWSResponse MergeShards = MergeShardsResponse

type Rep MergeShards

Defined in Amazonka.Kinesis.MergeShards

type Rep MergeShards = D1 ('MetaData "MergeShards" "Amazonka.Kinesis.MergeShards" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "MergeShards'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "shardToMerge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "adjacentShardToMerge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMergeShards

Arguments

:: Text

$sel:shardToMerge:MergeShards'

-> Text

$sel:adjacentShardToMerge:MergeShards'

-> MergeShards

Create a value of MergeShards 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:

MergeShards, mergeShards_streamARN - The ARN of the stream.

MergeShards, mergeShards_streamName - The name of the stream for the merge.

$sel:shardToMerge:MergeShards', mergeShards_shardToMerge - The shard ID of the shard to combine with the adjacent shard for the merge.

$sel:adjacentShardToMerge:MergeShards', mergeShards_adjacentShardToMerge - The shard ID of the adjacent shard for the merge.

Request Lenses

mergeShards_streamARN :: Lens' MergeShards (Maybe Text)

The ARN of the stream.

mergeShards_streamName :: Lens' MergeShards (Maybe Text)

The name of the stream for the merge.

mergeShards_shardToMerge :: Lens' MergeShards Text

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

mergeShards_adjacentShardToMerge :: Lens' MergeShards Text

The shard ID of the adjacent shard for the merge.

Destructuring the Response

data MergeShardsResponse

See: newMergeShardsResponse smart constructor.

Constructors

MergeShardsResponse'

Instances

Generic MergeShardsResponse

Defined in Amazonka.Kinesis.MergeShards

Associated Types

type Rep MergeShardsResponse :: Type -> Type

Methods

from :: MergeShardsResponse -> Rep MergeShardsResponse x

to :: Rep MergeShardsResponse x -> MergeShardsResponse

Read MergeShardsResponse

Defined in Amazonka.Kinesis.MergeShards

Methods

readsPrec :: Int -> ReadS MergeShardsResponse

readList :: ReadS [MergeShardsResponse]

readPrec :: ReadPrec MergeShardsResponse

readListPrec :: ReadPrec [MergeShardsResponse]

Show MergeShardsResponse

Defined in Amazonka.Kinesis.MergeShards

Methods

showsPrec :: Int -> MergeShardsResponse -> ShowS

show :: MergeShardsResponse -> String

showList :: [MergeShardsResponse] -> ShowS

NFData MergeShardsResponse

Defined in Amazonka.Kinesis.MergeShards

Methods

rnf :: MergeShardsResponse -> ()

Eq MergeShardsResponse

Defined in Amazonka.Kinesis.MergeShards

Methods

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

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

type Rep MergeShardsResponse

Defined in Amazonka.Kinesis.MergeShards

type Rep MergeShardsResponse = D1 ('MetaData "MergeShardsResponse" "Amazonka.Kinesis.MergeShards" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "MergeShardsResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newMergeShardsResponse :: MergeShardsResponse

Create a value of MergeShardsResponse with all optional fields omitted.

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