Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Data Streams
  • Access management
  • Pricing policy
    • Overview
    • All methods
      • CreateStream
      • DecreaseStreamRetentionPeriod
      • DeleteStream
      • DescribeStream
      • IncreaseStreamRetentionPeriod
      • GetRecords
      • GetShardIterator
      • ListStreams
      • PutRecord
      • PutRecords
      • UpdateShardCount
    • Common errors
    • Examples
  • FAQ

In this article:

  • Request
  • Request parameters
  • Response
  • Response parameters
  • Errors
  1. Amazon Kinesis Data Streams compatible HTTP API
  2. Methods
  3. UpdateShardCount

UpdateShardCount

Written by
Yandex Cloud
Updated at February 10, 2023
  • Request
    • Request parameters
  • Response
    • Response parameters
  • Errors

Updates the number of shards in the specified stream. Only an increase in the shard count is allowed.

If successful, the method changes the stream status to UPDATING and returns HTTP code 200 and data in JSON format. Once updated, the stream status changes to ACTIVE. The scaling time depends on the stream size and may take several minutes. While the stream is in the UPDATING status, data reads and writes do not stop.

RequestRequest

The request contains data in JSON format.

{
  "ScalingType": "string",
  "StreamName": "string",
  "TargetShardCount": number
}

Request parametersRequest parameters

Parameter Description
ScalingType The type of scaling. UNIFORM_SCALING creates shards of the same size.

Type: String
Possible values: UNIFORM_SCALING
Required: Yes
StreamName The name of the stream.

Type: String
Size: 1-128 characters.
Possible values: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$
Required: Yes
TargetShardCount The target number of shards.

Type: Integer
Minimum value: 1
Required: Yes

ResponseResponse

If successful, HTTP code 200 and data in JSON format are returned.

{
  "CurrentShardCount": number,
  "StreamName": "string",
  "TargetShardCount": number
}

Response parametersResponse parameters

Parameter Description
CurrentShardCount The current number of shards.

Type: Integer
Minimum value: 1
Required: Yes
StreamName The name of the stream.

Type: String
Size: 1-128 characters.
Possible values: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$
Required: Yes
TargetShardCount The target number of shards.

Type: Integer
Minimum value: 1
Required: Yes

ErrorsErrors

Parameter Description HTTP code
InvalidArgumentException The argument is invalid. For more information, see the error message. 400
LimitExceededException The request limit is exceeded. 400
ResourceInUseException The resource is being used by another operation. 400
ResourceNotFoundException The requested resource was not found. 400

Errors that are common to all methods may occur.

Was the article helpful?

Previous
PutRecords
Next
Common errors
© 2025 Direct Cursus Technology L.L.C.