Spec-Zone.ru › AWS CLI v2

[ aws . qldb ]

list-journal-s3-exports-for-ledger

Описание

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

Это действие возвращает максимум MaxResults элементов и постранично, поэтому вы можете получить все элементы, вызвав ListJournalS3ExportsForLedger несколько раз.

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

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

Синтаксис

  list-journal-s3-exports-for-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]

Параметры

--name (строка)

Имя журнала.

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

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

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

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

--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 CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

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

Чтобы перечислить задания экспорта журнала для журнала

Следующий пример list-journal-s3-exports-for-ledger перечисляет задания экспорта журнала для указанного журнала.

aws qldb list-journal-s3-exports-for-ledger \
    --name myExampleLedger

Вывод:

{
    "JournalS3Exports": [
        {
            "LedgerName": "myExampleLedger",
            "ExclusiveEndTime": 1568847599.0,
            "ExportCreationTime": 1568847801.418,
            "S3ExportConfiguration": {
                "Bucket": "amzn-s3-demo-bucket",
                "Prefix": "ledgerexport1/",
                "EncryptionConfiguration": {
                    "ObjectEncryptionType": "SSE_S3"
                }
            },
            "ExportId": "ADR2ONPKN5LINYGb4dp7yZ",
            "RoleArn": "arn:aws:iam::123456789012:role/qldb-s3-export",
            "InclusiveStartTime": 1568764800.0,
            "Status": "IN_PROGRESS"
        }
    ]
}

Дополнительную информацию см. в разделе «Экспорт журнала в Amazon QLDB» в Руководстве разработчика Amazon QLDB.

Вывод

JournalS3Exports -> (список)

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

(структура)

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

LedgerName -> (строка)

Имя журнала.

ExportId -> (строка)

UUID (представленный в кодировке Base62) задания экспорта журнала.

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

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

Status -> (строка)

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

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

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

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

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

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

Расположение ведра Amazon Simple Storage Service (Amazon S3), в котором задание экспорта журнала записывает содержимое журнала.

Bucket -> (строка)

Имя ведра Amazon S3, в котором задание экспорта журнала записывает содержимое журнала.

Имя ведра должно соответствовать соглашениям об именовании ведер Amazon S3. Дополнительную информацию см. в разделе Ограничения и рекомендации по именованию ведер в Руководстве разработчика Amazon S3.

Prefix -> (строка)

Префикс для ведра Amazon S3, в котором задание экспорта журнала записывает содержимое журнала.

Префикс должен соответствовать правилам и ограничениям именования ключей Amazon S3. Дополнительную информацию см. в разделе Ключ объекта и метаданные в Руководстве разработчика Amazon S3. Вот несколько примеров допустимых Prefix значений:

  • JournalExports-ForMyLedger/Testing/
  • JournalExports
  • My:Tests/

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

Настройки шифрования, используемые заданием экспорта журнала для записи данных в ведро Amazon S3.

ObjectEncryptionType -> (строка)

Тип шифрования объекта Amazon S3.

Дополнительную информацию о параметрах шифрования на стороне сервера в Amazon S3 см. в разделе Защита данных с помощью шифрования на стороне сервера в Руководстве разработчика Amazon S3.

KmsKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) симметричного ключа шифрования в службе управления ключами (KMS). Amazon S3 не поддерживает асимметричные ключи KMS.

Вы должны предоставить KmsKeyArn, если вы укажете SSE_KMS как ObjectEncryptionType.

KmsKeyArn не требуется, если вы укажете SSE_S3 как ObjectEncryptionType.

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, предоставляющей QLDB права для задания экспорта журнала на выполнение следующих действий:

  • Запись объектов в ваше ведро Amazon Simple Storage Service (Amazon S3).
  • (Необязательно) Использование вашего управляемого клиентом ключа в службе управления ключами (KMS) для шифрования данных, экспортируемых на стороне сервера.

OutputFormat -> (строка)

Формат вывода экспортированных данных журнала.

NextToken -> (строка)

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

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

Spec-Zone.ru

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