Spec-Zone.ru › AWS CLI v2

[ aws . kinesis ]

удалить-поток

Описание

Удаляет поток данных Kinesis и все его сегменты и данные. Необходимо остановить все приложения, работающие с потоком, перед его удалением. Если приложение попытается обработать удалённый поток, оно получит исключение ResourceNotFoundException .

Примечание

При вызове этого API необходимо использовать либо параметр StreamARN , либо параметр StreamName , или оба. Рекомендуется использовать параметр входных данных StreamARN при вызове этого API.

Если поток находится в состоянии ACTIVE , его можно удалить. После запроса DeleteStream указанный поток находится в состоянии DELETING до тех пор, пока Kinesis Data Streams не завершит удаление.

Примечание: Kinesis Data Streams может продолжать принимать операции чтения и записи данных, такие как PutRecord , PutRecords и GetRecords , в потоке в состоянии DELETING до завершения удаления потока.

При удалении потока также удаляются все сегменты в этом потоке, а любые теги отключаются от потока.

Для проверки состояния потока можно использовать операцию DescribeStreamSummary, которая возвращается в StreamStatus .

Удаление потока имеет лимит в пять транзакций в секунду на аккаунт.

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

Синтаксис

  delete-stream
[--stream-name <value>]
[--enforce-consumer-deletion | --no-enforce-consumer-deletion]
[--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 (строка)

Имя потока для удаления.

--enforce-consumer-deletion | --no-enforce-consumer-deletion (логическое значение)

Если этот параметр не задан (null ) или если вы задаёте его значение false , и поток зарегистрировал потребителей, вызов DeleteStream завершается с ошибкой ResourceInUseException .

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

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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображаемого в двоичном блоке, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно, независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного параметра cli-binary-format.

  • base64
  • raw-in-base64-out

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

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

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

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию можно найти в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI .

Для удаления потока данных

Следующий delete-stream пример удаляет указанный поток данных.

aws kinesis delete-stream \
    --stream-name samplestream

Эта команда не производит никакого вывода.

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

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API