amazonka-kinesis-1.6.1: Amazon Kinesis SDK.

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

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 .

Synopsis

# Creating a Request

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.

See: updateShardCount smart constructor.

Instances

# Request Lenses

The name of the stream.

The new number of shards.

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

# Destructuring the Response

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.

See: updateShardCountResponse smart constructor.

Instances