update-shard-count

Описание

Обновляет количество фрагментов указанного потока до указанного количества фрагментов. Этот API поддерживается только для потоков данных с режимом выделенных ресурсов.

Обновление количества фрагментов — асинхронная операция. После получения запроса Kinesis Data Streams возвращает немедленно и устанавливает состояние потока в UPDATING. После завершения обновления Kinesis Data Streams устанавливает состояние потока обратно в ACTIVE. В зависимости от размера потока, операция масштабирования может занять несколько минут. Вы можете продолжать читать и записывать данные в свой поток, пока его состояние равно UPDATING.

Для обновления количества фрагментов Kinesis Data Streams выполняет разделение или объединение отдельных фрагментов. Это может привести к созданию кратковременных фрагментов помимо конечных фрагментов. Эти кратковременные фрагменты учитываются в общем лимите фрагментов для вашей учетной записи в регионе.

При использовании этой операции рекомендуется указывать целевое количество фрагментов, кратное 25% (25%, 50%, 75%, 100%). Вы можете указать любое целевое значение в пределах своего лимита фрагментов. Однако, если вы укажете целевое значение, которое не кратно 25%, операция масштабирования может занять больше времени.

Данная операция имеет следующие стандартные ограничения. По умолчанию вы не можете:

• Масштабировать более чем в десять раз в течение 24 часов для каждого потока.
• Увеличить количество фрагментов более чем в два раза по сравнению с текущим количеством фрагментов для потока.
• Уменьшить количество фрагментов менее чем вдвое по сравнению с текущим количеством фрагментов для потока.
• Увеличить количество фрагментов до более чем 10000 фрагментов в потоке.
• Уменьшить количество фрагментов в потоке, содержащем более 10000 фрагментов, если результат меньше 10000 фрагментов.
• Увеличить количество фрагментов сверх лимита для вашей учетной записи.
• Выполнить более 10 TPS. TPS более 10 приведет к срабатыванию LimitExceededException.

Подробные сведения о стандартных ограничениях для учетной записи Amazon Web Services см. в разделе «Пределы потоков» в Руководстве разработчика Amazon Kinesis Data Streams. Чтобы запросить увеличение лимита обращений, лимита фрагментов для данного API или общего лимита фрагментов, воспользуйтесь формой лимитов.

См. также: Документация API AWS

Синопсис

  update-shard-count
[--stream-name <value>]
--target-shard-count <value>
--scaling-type <value>
[--stream-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--stream-name (строка)

--target-shard-count (целое число)

--scaling-type (строка)

--stream-arn (строка)

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения будут переопределять значения, предоставленные JSON. Передача произвольных двоичных значений с помощью предоставленного значения JSON невозможна, так как строка будет взята дословно. Это нельзя указать вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

• json
• текст
• таблица
• yaml
• yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать конкретный профиль из файла учетных данных.

--region (строка)

Использовать определенный регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

• включено
• выключено
• авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь ограничения по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь ограничения по времени. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 предполагает, что двоичные блоки предоставляются в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку fileb://, всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file://, содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пагинатор командной строки для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры командной строки.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросить параметры командной строки.

Примеры

Для обновления количества фрагментов в потоке данных

Следующий update-shard-count пример обновляет количество фрагментов указанного потока данных до 6. В этом примере используется равномерное масштабирование, которое создает фрагменты одинакового размера.

aws kinesis update-shard-count \
    --stream-name samplestream \
    --scaling-type UNIFORM_SCALING \
    --target-shard-count 6

Вывод:

{
    "StreamName": "samplestream",
    "CurrentShardCount": 3,
    "TargetShardCount": 6
}

Дополнительную информацию см. в разделе Реорганизация фрагментов потока в Руководстве разработчика Amazon Kinesis Data Streams.

Вывод

StreamName -> (строка)

CurrentShardCount -> (целое число)

TargetShardCount -> (целое число)

StreamARN -> (строка)