get-shard-iterator

Описание

Получает итератор раздела Amazon Kinesis. Итератор раздела истекает через 5 минут после возвращения запрошивающему.

Итератор раздела определяет позицию раздела, с которой начать последовательное чтение записей данных. Позиция указывается с помощью порядкового номера записи данных в разделе. Порядковый номер — это идентификатор, связанный с каждой записью, внесенной в поток, и он назначается при помещении записи в поток. Каждый поток имеет один или несколько разделов.

Необходимо указать тип итератора раздела. Например, можно установить параметр ShardIteratorType для чтения точно с позиции, обозначенной определенным порядковым номером, используя тип итератора AT_SEQUENCE_NUMBER. В качестве альтернативы, параметр может читать сразу после порядкового номера, используя тип итератора AFTER_SEQUENCE_NUMBER, используя порядковые номера, возвращённые предыдущими вызовами PutRecord , PutRecords , GetRecords или DescribeStream . В запросе можно указать тип итератора раздела AT_TIMESTAMP, чтобы читать записи с произвольной точки во времени, TRIM_HORIZON, чтобы ShardIterator указывал на последнюю неотрезанную запись в разделе в системе (самую старую запись данных в разделе) или LATEST, чтобы всегда читать самые последние данные в разделе.

При многократном чтении из потока используйте запрос GetShardIterator, чтобы получить первый итератор раздела для использования в первом запросе GetRecords и для последующих чтений используйте итератор раздела, возвращённый запросом GetRecords в NextShardIterator. Новый итератор раздела возвращается каждым запросом GetRecords в NextShardIterator, который используется в параметре ShardIterator следующего запроса GetRecords.

Если запрос GetShardIterator выполняется слишком часто, вы получите ProvisionedThroughputExceededException. Дополнительную информацию об ограничениях пропускной способности см. в разделах GetRecords и Ограничения потоков в Руководстве разработчика Amazon Kinesis Data Streams.

Если раздел закрыт, GetShardIterator возвращает действительный итератор для последнего порядкового номера раздела. Закрытие раздела может произойти в результате использования SplitShard или MergeShards.

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

Синтаксис

  get-shard-iterator
[--stream-name <value>]
--shard-id <value>
--shard-iterator-type <value>
[--starting-sequence-number <value>]
[--timestamp <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 (строка)

--shard-id (строка)

--shard-iterator-type (строка)

--starting-sequence-number (строка)

--timestamp (метка времени)

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

Примеры

Получение итератора раздела

Следующий get-shard-iterator пример использует тип итератора AT_SEQUENCE_NUMBER и генерирует итератор раздела для начала чтения записей данных точно с позиции, обозначенной указанным порядковым номером.

aws kinesis get-shard-iterator \
    --stream-name samplestream \
    --shard-id shardId-000000000001 \
    --shard-iterator-type LATEST

Вывод:

{
    "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs"
}

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

Вывод

ShardIterator -> (строка)