Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kinesis.UpdateShardCount

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the shard count of the specified stream to the specified number of shards. 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.

Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.

To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region.

When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.

This operation has the following default limits. By default, you cannot do the following:

Scale more than ten times per rolling 24-hour period per stream
Scale up to more than double your current shard count for a stream
Scale down below half your current shard count for a stream
Scale up to more than 10000 shards in a stream
Scale a stream with more than 10000 shards down unless the result is less than 10000 shards
Scale up to more than the shard limit for your account

For the default limits for an Amazon Web Services account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.

Synopsis

data UpdateShardCount = UpdateShardCount' {
- streamARN :: Maybe Text
- streamName :: Maybe Text
- targetShardCount :: Natural
- scalingType :: ScalingType
}
newUpdateShardCount :: Natural -> ScalingType -> UpdateShardCount
updateShardCount_streamARN :: Lens' UpdateShardCount (Maybe Text)
updateShardCount_streamName :: Lens' UpdateShardCount (Maybe Text)
updateShardCount_targetShardCount :: Lens' UpdateShardCount Natural
updateShardCount_scalingType :: Lens' UpdateShardCount ScalingType
data UpdateShardCountResponse = UpdateShardCountResponse' {
- currentShardCount :: Maybe Natural
- streamARN :: Maybe Text
- streamName :: Maybe Text
- targetShardCount :: Maybe Natural
- httpStatus :: Int
}
newUpdateShardCountResponse :: Int -> UpdateShardCountResponse
updateShardCountResponse_currentShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)
updateShardCountResponse_streamARN :: Lens' UpdateShardCountResponse (Maybe Text)
updateShardCountResponse_streamName :: Lens' UpdateShardCountResponse (Maybe Text)
updateShardCountResponse_targetShardCount :: Lens' UpdateShardCountResponse (Maybe Natural)
updateShardCountResponse_httpStatus :: Lens' UpdateShardCountResponse Int

Creating a Request

data UpdateShardCount Source #

See: newUpdateShardCount smart constructor.

Constructors

UpdateShardCount'

Fields

streamARN :: Maybe Text
The ARN of the stream.
streamName :: Maybe Text
The name of the stream.
targetShardCount :: Natural
The new number of shards. This value has the following default limits. By default, you cannot do the following:
- Set this value to more than double your current shard count for a stream.
- Set this value below half your current shard count for a stream.
- Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.
- Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.
scalingType :: ScalingType
The scaling type. Uniform scaling creates shards of equal size.

Instances

Instances details

ToJSON UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toJSON :: UpdateShardCount -> Value # toEncoding :: UpdateShardCount -> Encoding # toJSONList :: [UpdateShardCount] -> Value # toEncodingList :: [UpdateShardCount] -> Encoding #
ToHeaders UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toHeaders :: UpdateShardCount -> [Header] #
ToPath UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toPath :: UpdateShardCount -> ByteString #
ToQuery UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods toQuery :: UpdateShardCount -> QueryString #
AWSRequest UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Associated Types type AWSResponse UpdateShardCount # Methods request :: (Service -> Service) -> UpdateShardCount -> Request UpdateShardCount # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateShardCount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateShardCount))) #
Generic UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Associated Types type Rep UpdateShardCount :: Type -> Type # Methods from :: UpdateShardCount -> Rep UpdateShardCount x # to :: Rep UpdateShardCount x -> UpdateShardCount #
Read UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods readsPrec :: Int -> ReadS UpdateShardCount # readList :: ReadS [UpdateShardCount] # readPrec :: ReadPrec UpdateShardCount # readListPrec :: ReadPrec [UpdateShardCount] #
Show UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods showsPrec :: Int -> UpdateShardCount -> ShowS # show :: UpdateShardCount -> String # showList :: [UpdateShardCount] -> ShowS #
NFData UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods rnf :: UpdateShardCount -> () #
Eq UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods (==) :: UpdateShardCount -> UpdateShardCount -> Bool # (/=) :: UpdateShardCount -> UpdateShardCount -> Bool #
Hashable UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods hashWithSalt :: Int -> UpdateShardCount -> Int # hash :: UpdateShardCount -> Int #
type AWSResponse UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount type AWSResponse UpdateShardCount = UpdateShardCountResponse
type Rep UpdateShardCount Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount type Rep UpdateShardCount = D1 ('MetaData "UpdateShardCount" "Amazonka.Kinesis.UpdateShardCount" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "UpdateShardCount'" '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 "targetShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "scalingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalingType))))

newUpdateShardCount Source #

Arguments

:: Natural	`UpdateShardCount`
-> ScalingType	`$sel:scalingType:UpdateShardCount'`
-> UpdateShardCount

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

UpdateShardCount, updateShardCount_streamARN - The ARN of the stream.

UpdateShardCount, updateShardCount_streamName - The name of the stream.

UpdateShardCount, updateShardCount_targetShardCount - The new number of shards. This value has the following default limits. By default, you cannot do the following:

Set this value to more than double your current shard count for a stream.
Set this value below half your current shard count for a stream.
Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.
Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

$sel:scalingType:UpdateShardCount', updateShardCount_scalingType - The scaling type. Uniform scaling creates shards of equal size.

Request Lenses

updateShardCount_streamARN :: Lens' UpdateShardCount (Maybe Text) Source #

The ARN of the stream.

updateShardCount_streamName :: Lens' UpdateShardCount (Maybe Text) Source #

The name of the stream.

updateShardCount_targetShardCount :: Lens' UpdateShardCount Natural Source #

The new number of shards. This value has the following default limits. By default, you cannot do the following:

Set this value to more than double your current shard count for a stream.
Set this value below half your current shard count for a stream.
Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.
Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.

updateShardCount_scalingType :: Lens' UpdateShardCount ScalingType Source #

The scaling type. Uniform scaling creates shards of equal size.

Destructuring the Response

data UpdateShardCountResponse Source #

See: newUpdateShardCountResponse smart constructor.

Constructors

UpdateShardCountResponse'
Fields currentShardCount :: Maybe Natural The current number of shards. streamARN :: Maybe Text The ARN of the stream. streamName :: Maybe Text The name of the stream. targetShardCount :: Maybe Natural The updated number of shards. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Associated Types type Rep UpdateShardCountResponse :: Type -> Type # Methods from :: UpdateShardCountResponse -> Rep UpdateShardCountResponse x # to :: Rep UpdateShardCountResponse x -> UpdateShardCountResponse #
Read UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods readsPrec :: Int -> ReadS UpdateShardCountResponse # readList :: ReadS [UpdateShardCountResponse] # readPrec :: ReadPrec UpdateShardCountResponse # readListPrec :: ReadPrec [UpdateShardCountResponse] #
Show UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods showsPrec :: Int -> UpdateShardCountResponse -> ShowS # show :: UpdateShardCountResponse -> String # showList :: [UpdateShardCountResponse] -> ShowS #
NFData UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods rnf :: UpdateShardCountResponse -> () #
Eq UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount Methods (==) :: UpdateShardCountResponse -> UpdateShardCountResponse -> Bool # (/=) :: UpdateShardCountResponse -> UpdateShardCountResponse -> Bool #
type Rep UpdateShardCountResponse Source #
Instance details Defined in Amazonka.Kinesis.UpdateShardCount type Rep UpdateShardCountResponse = D1 ('MetaData "UpdateShardCountResponse" "Amazonka.Kinesis.UpdateShardCount" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "UpdateShardCountResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "currentShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "targetShardCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))