register-stream-consumer

Описание

Регистрирует потребителя с потоком данных Kinesis. Когда вы используете эту операцию, зарегистрированный потребитель может затем вызвать SubscribeToShard для получения данных из потока с использованием улучшенного разветвления (enhanced fan-out), со скоростью до 2 МБ в секунду для каждого сегмента, к которому он подписывается. Эта скорость не зависит от общего количества потребителей, читающих из того же потока.

Вы можете добавить метки к зарегистрированному потребителю при выполнении запроса, установив параметр. Если вы передаёте параметр, помимо разрешения, вы также должны иметь разрешение для потребителя, который будет зарегистрирован. Метки вступят в силу со статусом потребителя.

Вы можете зарегистрировать до 20 потребителей на поток. Определённый потребитель может быть зарегистрирован только с одним потоком за раз.

Пример использования этой операции можно найти в разделе Улучшенное разветвление с помощью API Kinesis Data Streams.

Использование этой операции ограничено пятью транзакциями в секунду на учётную запись. Кроме того, одновременно может быть создано только 5 потребителей. Другими словами, вы не можете иметь более 5 потребителей в статусе одновременно. Регистрация 6-го потребителя, в то время как 5 находятся в статусе, приводит к ошибке.

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

Синтаксис

  register-stream-consumer
--stream-arn <value>
--consumer-name <value>
[--tags <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-arn (строка)

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

--tags (словарь)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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-auto-prompt (логическое значение)

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

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

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

Примеры

Для регистрации потребителя потока данных

Следующий пример регистрирует потребителя под именем со значением для указанного потока.

aws kinesis register-stream-consumer \
    --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \
    --consumer-name KinesisConsumerApplication

Вывод:

{
    "Consumer": {
        "ConsumerName": "KinesisConsumerApplication",
        "ConsumerARN": "arn:aws:kinesis:us-west-2: 123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852",
        "ConsumerStatus": "CREATING",
        "ConsumerCreationTimestamp": 1572383852.0
    }
}

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

Вывод

Потребитель -> (структура)