Spec-Zone.ru › AWS CLI v2

[ aws . firehose ]

list-delivery-streams

Описание

Выводит список ваших потоков Firehose в алфавитном порядке их имён.

Количество потоков Firehose может быть слишком большим для возврата с помощью одного вызова к ListDeliveryStreams. Вы можете ограничить количество возвращаемых потоков Firehose, используя параметр Limit. Чтобы определить, есть ли ещё потоки для вывода, проверьте значение HasMoreDeliveryStreams в выводе. Если есть ещё потоки Firehose для вывода, вы можете запросить их, снова вызвав эту операцию и установив параметр ExclusiveStartDeliveryStreamName в имя последнего потока Firehose, возвращённого в последнем вызове.

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

Синтаксис

  list-delivery-streams
[--limit <value>]
[--delivery-stream-type <value>]
[--exclusive-start-delivery-stream-name <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]

Параметры

--limit (целое число)

Максимальное количество потоков Firehose для вывода. Значение по умолчанию — 10.

--delivery-stream-type (строка)

Тип потока Firehose. Может принимать одно из следующих значений:

  • DirectPut : Приложения-провайдеры получают доступ к потоку Firehose напрямую.
  • KinesisStreamAsSource : Поток Firehose использует поток данных Kinesis в качестве источника.

Этот параметр необязателен. Если этот параметр опущен, возвращаются потоки Firehose всех типов.

Возможные значения:

  • DirectPut
  • KinesisStreamAsSource
  • MSKAsSource
  • DatabaseAsSource

--exclusive-start-delivery-stream-name (строка)

Список потоков Firehose, возвращаемых данным вызовом к ListDeliveryStreams, начнётся с потока Firehose, имя которого идёт алфавитным порядком сразу после имени, указанного в ExclusiveStartDeliveryStreamName.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Чтобы вывести список доступных потоков

Следующий list-delivery-streams пример выводит список доступных потоков в вашей учётной записи AWS.

aws firehose list-delivery-streams

Вывод:

{
    "DeliveryStreamNames": [
        "my-stream"
    ],
    "HasMoreDeliveryStreams": false
}

Для получения дополнительной информации, см. Создание потока доставки Amazon Kinesis Data Firehose в руководстве разработчика Amazon Kinesis Data Firehose.

Вывод

DeliveryStreamNames -> (список)

Имена потоков Firehose.

(строка)

HasMoreDeliveryStreams -> (булево)

Указывает, есть ли ещё потоки Firehose, доступные для вывода.

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

Spec-Zone.ru

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