Skip to contents

Updates the shard count of the specified stream to the specified number of shards

Source: R/kinesis_operations.R
kinesis_update_shard_count.Rd

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.

See https://www.paws-r-sdk.com/docs/kinesis_update_shard_count/ for full documentation.

Usage

kinesis_update_shard_count(
  StreamName = NULL,
  TargetShardCount,
  ScalingType,
  StreamARN = NULL,
  StreamId = NULL
)

Arguments

StreamName

The name of the stream.

TargetShardCount

[required] 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

[required] The scaling type. Uniform scaling creates shards of equal size.

StreamARN

The ARN of the stream.

StreamId

Not Implemented. Reserved for future use.