Spec-Zone.ru › AWS CLI v2

[ aws . qldb ]

list-journal-kinesis-streams-for-ledger

Описание

Возвращает все потоки журналов Amazon QLDB для заданного реестра.

Данный метод не возвращает истекшие потоки журналов. Для получения дополнительной информации, см. раздел «Истечение срока действия для конечных потоков» в руководстве разработчика Amazon QLDB.

Данный метод возвращает не более MaxResults элементов. Он странизирован, поэтому вы можете получить все элементы, вызывая ListJournalKinesisStreamsForLedger несколько раз.

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

Синтаксис

  list-journal-kinesis-streams-for-ledger
--ledger-name <value>
[--max-results <value>]
[--next-token <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]

Параметры

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

Имя реестра.

--max-results (целое число)

Максимальное количество результатов, возвращаемых в одном запросе. (Фактическое количество возвращенных результатов может быть меньше.)

--next-token (строка)

Токен для постраничной навигации, указывающий, что вы хотите получить следующую страницу результатов. Если в ответе от предыдущего вызова ListJournalKinesisStreamsForLedger вы получили значение для NextToken, вы должны использовать это значение в качестве входных данных здесь.

--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 (булево)

Автоматически запросить параметры входных данных командной строки.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров входных данных командной строки.

Примеры

Примечание

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

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

Для вывода потоков журнала для реестра

Следующий list-journal-kinesis-streams-for-ledger пример выводит потоки журналов для указанного реестра.

aws qldb list-journal-kinesis-streams-for-ledger \
    --ledger-name myExampleLedger

Вывод:

{
    "Streams": [
        {
            "LedgerName": "myExampleLedger",
            "CreationTime": 1591221984.677,
            "InclusiveStartTime": 1590710400.0,
            "ExclusiveEndTime": 1590796799.0,
            "RoleArn": "arn:aws:iam::123456789012:role/my-kinesis-stream-role",
            "StreamId": "7ISCkqwe4y25YyHLzYUFAf",
            "Arn": "arn:aws:qldb:us-east-1:123456789012:stream/myExampleLedger/7ISCkqwe4y25YyHLzYUFAf",
            "Status": "ACTIVE",
            "KinesisConfiguration": {
                "StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb",
                "AggregationEnabled": true
            },
            "StreamName": "myExampleLedger-stream"
        }
    ]
}

Для получения дополнительной информации см. раздел «Потоковая передача данных журнала Amazon QLDB» в руководстве разработчика Amazon QLDB.

Вывод

Потоки -> (список)

Потоки журналов QLDB, которые в настоящее время связаны с заданным реестром.

(структура)

Информация о потоке журнала Amazon QLDB, включая Amazon Resource Name (ARN), имя потока, время создания, текущий статус и параметры исходного запроса на создание потока.

LedgerName -> (строка)

Имя реестра.

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

Дата и время (в формате времени эпохи) создания потока журнала QLDB. (Формат времени эпохи — количество секунд, прошедших с 12:00:00 1 января 1970 года по UTC.)

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

Включительно начальная дата и время, с которых нужно начать потоковую передачу данных журнала.

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

Исключительно конечная дата и время, указывающие, когда поток завершается. Если этот параметр не определен, поток работает неограниченно до тех пор, пока вы его не отменяете.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей QLDB разрешения на запись записей данных в ресурс Kinesis Data Streams для потока журнала.

StreamId -> (строка)

UUID (представленный в Base62-кодированном тексте) потока журнала QLDB.

Arn -> (строка)

Amazon Resource Name (ARN) потока журнала QLDB.

Status -> (строка)

Текущее состояние потока журнала QLDB.

KinesisConfiguration -> (структура)

Настройки конфигурации назначения Amazon Kinesis Data Streams для потока журнала QLDB.

StreamArn -> (строка)

Amazon Resource Name (ARN) ресурса Kinesis Data Streams.

AggregationEnabled -> (булево)

Включает возможность публикации нескольких записей данных в одной записи Kinesis Data Streams, увеличивая количество записей, отправляемых за один API-вызов.

Значение по умолчанию: True

Предупреждение

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

ErrorCause -> (строка)

Сообщение об ошибке, описывающее причину, по которой поток имеет статус IMPAIRED или FAILED. Это не применимо к потокам, имеющим другие значения статуса.

StreamName -> (строка)

Определяемое пользователем имя потока журнала QLDB.

NextToken -> (строка)

  • Если NextToken пусто, последняя страница результатов обработана, и больше результатов для извлечения нет.
  • Если NextToken не пусто, доступны дополнительные результаты. Для извлечения следующей страницы результатов используйте значение NextToken в последующем вызове ListJournalKinesisStreamsForLedger.

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

Spec-Zone.ru

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