list-stream-consumers
Описание
Выводит список потребителей, зарегистрированных для получения данных из потока с помощью расширенного распределения, и предоставляет информацию о каждом потребителе.
Данная операция имеет ограничение в 5 транзакций в секунду на поток.
См. также: Документацию AWS API
list-stream-consumers это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, задав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Consumers
Синтаксис
list-stream-consumers
--stream-arn <value>
[--stream-creation-timestamp <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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-arn (строка)
--stream-creation-timestamp (отметка времени)
Укажите этот параметр ввода, чтобы различать потоки данных, имеющие одинаковое имя. Например, если вы создали поток данных, а затем удалили его, и позже создали другой поток данных с тем же именем, вы можете использовать этот параметр для указания того, для какого из двух потоков вы хотите получить список потребителей.
Вы не можете указать этот параметр, если вы указали параметр NextToken.
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, невозможно, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничного вывода. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.
--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-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Вывод
Потребители -> (список)
Массив JSON-объектов. Каждый объект представляет одного зарегистрированного потребителя.
(структура)
Объект, представляющий детали зарегистрированного потребителя. Этот тип объекта возвращается методом RegisterStreamConsumer.
ConsumerName -> (строка)
ConsumerARN -> (строка)
При регистрации потребителя Kinesis Data Streams генерирует для него ARN. Вам нужен этот ARN для вызова SubscribeToShard.
Если вы удаляете потребителя, а затем создаете нового с тем же именем, у него будет другой ARN. Это происходит потому, что ARNs потребителей содержат отметку времени создания. Это важно учитывать, если у вас есть политики IAM, которые ссылаются на ARNs потребителей.
ConsumerStatus -> (строка)
CREATING или DELETING.ConsumerCreationTimestamp -> (отметка времени)
NextToken -> (строка)
Если количество потребителей, зарегистрированных в потоке данных, больше значения по умолчанию параметра MaxResults, или если вы явно задали значение параметра MaxResults, меньшее количества зарегистрированных потребителей, ответ включает токен постраничности, называемый NextToken. Вы можете указать это значение NextToken в последующем вызове ListStreamConsumers для получения следующего набора зарегистрированных потребителей. Дополнительную информацию о использовании этого токена постраничности при вызове операции ListStreamConsumers см. в разделе ListStreamConsumersInput$NextToken.
Предупреждение
Токены истекают через 300 секунд. Когда вы получаете значениеNextToken в ответе на вызов ListStreamConsumers, у вас есть 300 секунд, чтобы использовать это значение. Если вы укажете истекший токен в вызове ListStreamConsumers, вы получите ExpiredNextTokenException.
© Copyright 2025, Amazon Web Services. Created using Sphinx.