Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

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

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. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.

This operation has the following limits. You cannot do the following:

Scale more than twice 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 500 shards in a stream
Scale a stream with more than 500 shards down unless the result is less than 500 shards
Scale up to more than the shard limit for your account

For the default limits for an AWS 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 .

Creating a Request

updateShardCount #

Arguments

:: Text	`uscStreamName`
-> Natural	`uscTargetShardCount`
-> ScalingType	`uscScalingType`
-> UpdateShardCount

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

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

uscStreamName - The name of the stream.
uscTargetShardCount - The new number of shards.
uscScalingType - The scaling type. Uniform scaling creates shards of equal size.

data UpdateShardCount #

See: updateShardCount smart constructor.

Instances

Eq UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods (==) :: UpdateShardCount -> UpdateShardCount -> Bool # (/=) :: UpdateShardCount -> UpdateShardCount -> Bool #
Data UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateShardCount -> c UpdateShardCount # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateShardCount # toConstr :: UpdateShardCount -> Constr # dataTypeOf :: UpdateShardCount -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateShardCount) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateShardCount) # gmapT :: (forall b. Data b => b -> b) -> UpdateShardCount -> UpdateShardCount # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateShardCount -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateShardCount -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateShardCount -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateShardCount -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateShardCount -> m UpdateShardCount # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateShardCount -> m UpdateShardCount # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateShardCount -> m UpdateShardCount #
Read UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods readsPrec :: Int -> ReadS UpdateShardCount # readList :: ReadS [UpdateShardCount] # readPrec :: ReadPrec UpdateShardCount # readListPrec :: ReadPrec [UpdateShardCount] #
Show UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods showsPrec :: Int -> UpdateShardCount -> ShowS # show :: UpdateShardCount -> String # showList :: [UpdateShardCount] -> ShowS #
Generic UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Associated Types type Rep UpdateShardCount :: * -> * # Methods from :: UpdateShardCount -> Rep UpdateShardCount x # to :: Rep UpdateShardCount x -> UpdateShardCount #
Hashable UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods hashWithSalt :: Int -> UpdateShardCount -> Int # hash :: UpdateShardCount -> Int #
ToJSON UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods toJSON :: UpdateShardCount -> Value # toEncoding :: UpdateShardCount -> Encoding # toJSONList :: [UpdateShardCount] -> Value # toEncodingList :: [UpdateShardCount] -> Encoding #
AWSRequest UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Associated Types type Rs UpdateShardCount :: * # Methods request :: UpdateShardCount -> Request UpdateShardCount # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateShardCount -> ClientResponse -> m (Response UpdateShardCount) #
ToHeaders UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods toHeaders :: UpdateShardCount -> [Header] #
ToPath UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods toPath :: UpdateShardCount -> ByteString #
ToQuery UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods toQuery :: UpdateShardCount -> QueryString #
NFData UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods rnf :: UpdateShardCount -> () #
type Rep UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount type Rep UpdateShardCount = D1 (MetaData "UpdateShardCount" "Network.AWS.Kinesis.UpdateShardCount" "amazonka-kinesis-1.6.0-7CHFApk9twZE5kY7quU0Eh" False) (C1 (MetaCons "UpdateShardCount'" PrefixI True) (S1 (MetaSel (Just "_uscStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_uscTargetShardCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat) :: S1 (MetaSel (Just "_uscScalingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ScalingType))))
type Rs UpdateShardCount #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount type Rs UpdateShardCount = UpdateShardCountResponse

Request Lenses

uscStreamName :: Lens' UpdateShardCount Text #

The name of the stream.

uscTargetShardCount :: Lens' UpdateShardCount Natural #

The new number of shards.

uscScalingType :: Lens' UpdateShardCount ScalingType #

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

Destructuring the Response

updateShardCountResponse #

Arguments

:: Int	`uscrsResponseStatus`
-> UpdateShardCountResponse

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

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

uscrsTargetShardCount - The updated number of shards.
uscrsStreamName - The name of the stream.
uscrsCurrentShardCount - The current number of shards.
uscrsResponseStatus - -- | The response status code.

data UpdateShardCountResponse #

See: updateShardCountResponse smart constructor.

Instances

Eq UpdateShardCountResponse #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods (==) :: UpdateShardCountResponse -> UpdateShardCountResponse -> Bool # (/=) :: UpdateShardCountResponse -> UpdateShardCountResponse -> Bool #
Data UpdateShardCountResponse #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateShardCountResponse -> c UpdateShardCountResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateShardCountResponse # toConstr :: UpdateShardCountResponse -> Constr # dataTypeOf :: UpdateShardCountResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateShardCountResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateShardCountResponse) # gmapT :: (forall b. Data b => b -> b) -> UpdateShardCountResponse -> UpdateShardCountResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateShardCountResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateShardCountResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> UpdateShardCountResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateShardCountResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateShardCountResponse -> m UpdateShardCountResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateShardCountResponse -> m UpdateShardCountResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateShardCountResponse -> m UpdateShardCountResponse #
Read UpdateShardCountResponse #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods readsPrec :: Int -> ReadS UpdateShardCountResponse # readList :: ReadS [UpdateShardCountResponse] # readPrec :: ReadPrec UpdateShardCountResponse # readListPrec :: ReadPrec [UpdateShardCountResponse] #
Show UpdateShardCountResponse #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods showsPrec :: Int -> UpdateShardCountResponse -> ShowS # show :: UpdateShardCountResponse -> String # showList :: [UpdateShardCountResponse] -> ShowS #
Generic UpdateShardCountResponse #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Associated Types type Rep UpdateShardCountResponse :: * -> * # Methods from :: UpdateShardCountResponse -> Rep UpdateShardCountResponse x # to :: Rep UpdateShardCountResponse x -> UpdateShardCountResponse #
NFData UpdateShardCountResponse #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount Methods rnf :: UpdateShardCountResponse -> () #
type Rep UpdateShardCountResponse #
Instance details Defined in Network.AWS.Kinesis.UpdateShardCount type Rep UpdateShardCountResponse = D1 (MetaData "UpdateShardCountResponse" "Network.AWS.Kinesis.UpdateShardCount" "amazonka-kinesis-1.6.0-7CHFApk9twZE5kY7quU0Eh" False) (C1 (MetaCons "UpdateShardCountResponse'" PrefixI True) ((S1 (MetaSel (Just "_uscrsTargetShardCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: S1 (MetaSel (Just "_uscrsStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_uscrsCurrentShardCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_uscrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

uscrsTargetShardCount :: Lens' UpdateShardCountResponse (Maybe Natural) #

The updated number of shards.

uscrsStreamName :: Lens' UpdateShardCountResponse (Maybe Text) #

The name of the stream.

uscrsCurrentShardCount :: Lens' UpdateShardCountResponse (Maybe Natural) #

The current number of shards.

uscrsResponseStatus :: Lens' UpdateShardCountResponse Int #

- | The response status code.