экспорт-журнала-в-s3
Описание
Экспортирует содержимое журнала в заданном диапазоне дат и времени из книги записей в указанный ведро Amazon Simple Storage Service (Amazon S3). Задача экспорта журнала может записывать объекты данных в текстовом или двоичном представлении формате Amazon Ion или в текстовом формате JSON Lines.
Если книга записей с заданным Name не существует, выбрасывает ResourceNotFoundException .
Если книга записей с заданным Name находится в состоянии CREATING, выбрасывает ResourcePreconditionNotMetException .
Вы можете инициировать до двух одновременных запросов экспорта журнала для каждой книги записей. При превышении этого лимита запросы экспорта журнала выбрасывают LimitExceededException .
См. также: Документация API AWS
Синтаксис
export-journal-to-s3
--name <value>
--inclusive-start-time <value>
--exclusive-end-time <value>
--s3-export-configuration <value>
--role-arn <value>
[--output-format <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 (строка)
--inclusive-start-time (отметка времени)
Включительно начальная дата и время для диапазона содержимого журнала, подлежащего экспорту.
InclusiveStartTime должна быть в формате даты и времени ISO 8601 и в формате Всемирного координированного времени (UTC). Например: 2019-06-13T21:36:34Z .
InclusiveStartTime должна быть раньше ExclusiveEndTime .
Если вы предоставите InclusiveStartTime, которое предшествует CreationDateTime книги записей, Amazon QLDB по умолчанию установит его на CreationDateTime книги записей.
--exclusive-end-time (отметка времени)
Исключительно конечная дата и время для диапазона содержимого журнала, подлежащего экспорту.
ExclusiveEndTime должна быть в формате даты и времени ISO 8601 и в формате Всемирного координированного времени (UTC). Например: 2019-06-13T21:36:34Z .
ExclusiveEndTime должна быть меньше или равна текущей дате и времени UTC.
--s3-export-configuration (структура)
Настройки конфигурации пункта назначения ведра Amazon S3 для вашего запроса на экспорт.
Ведро -> (строка)
Имя ведра Amazon S3, в котором задача экспорта журнала записывает содержимое журнала.
Имя ведра должно соответствовать соглашениям об именовании ведер Amazon S3. Дополнительную информацию см. в разделе Ограничения и рекомендации по именованию ведер в Руководстве разработчика Amazon S3.
Префикс -> (строка)
Префикс для ведра Amazon S3, в котором задача экспорта журнала записывает содержимое журнала.
Префикс должен соответствовать правилам и ограничениям именования ключей Amazon S3. Дополнительную информацию см. в разделе Ключ объекта и метаданные в Руководстве разработчика Amazon S3.
Ниже приведены примеры допустимых значений Prefix:
JournalExports-ForMyLedger/Testing/JournalExportsMy:Tests/
EncryptionConfiguration -> (структура)
Настройки шифрования, которые используются задачей экспорта журнала для записи данных в ведро Amazon S3.
ObjectEncryptionType -> (строка)
Тип шифрования объекта Amazon S3.
Чтобы узнать больше о вариантах шифрования на стороне сервера в Amazon S3, см. Защита данных с помощью шифрования на стороне сервера в Руководстве разработчика Amazon S3.
KmsKeyArn -> (строка)
Amazon Resource Name (ARN) симметричного ключа шифрования в службе управления ключами (KMS). Amazon S3 не поддерживает асимметричные ключи KMS.
Вы должны указать KmsKeyArn, если вы указали SSE_KMS в качестве ObjectEncryptionType.
KmsKeyArn не требуется, если вы указали SSE_S3 в качестве ObjectEncryptionType.Сокращенный синтаксис:
Bucket=string,Prefix=string,EncryptionConfiguration={ObjectEncryptionType=string,KmsKeyArn=string}
Синтаксис JSON:
{
"Bucket": "string",
"Prefix": "string",
"EncryptionConfiguration": {
"ObjectEncryptionType": "SSE_KMS"|"SSE_S3"|"NO_ENCRYPTION",
"KmsKeyArn": "string"
}
}
--role-arn (строка)
Amazon Resource Name (ARN) роли IAM, предоставляющей QLDB разрешения для задачи экспорта журнала выполнять следующие действия:
- Запись объектов в ваше ведро Amazon S3.
- (Необязательно) Использование вашего управляемого клиентом ключа в службе управления ключами (KMS) для шифрования экспортированных данных на стороне сервера.
Для передачи роли QLDB при запросе экспорта журнала, у вас должны быть разрешения на выполнение действия iam:PassRole с ресурсом роли IAM. Это требуется для всех запросов экспорта журнала.
--output-format (строка)
Формат вывода экспортированных данных журнала. Задача экспорта журнала может записывать объекты данных в текстовом или двоичном представлении формате Amazon Ion или в текстовом формате JSON Lines.
По умолчанию: ION_TEXT
В формате JSON Lines каждый блок журнала в экспортируемом объекте данных — это допустимый объект JSON, ограниченный новой строкой. Вы можете использовать этот формат для прямой интеграции экспорта JSON с инструментами аналитики, такими как Amazon Athena и Glue, поскольку эти службы могут автоматически анализировать JSON, ограниченный новой строкой.
Возможные значения:
ION_BINARYION_TEXTJSON
--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.
Для экспорта блоков журнала в S3
В следующем export-journal-to-s3 примере создается задача экспорта для блоков журнала в заданном диапазоне дат и времени из книги записей с именем myExampleLedger. Задача экспорта записывает блоки в указанное ведро Amazon S3.
aws qldb export-journal-to-s3 \
--name myExampleLedger \
--inclusive-start-time 2019-09-18T00:00:00Z \
--exclusive-end-time 2019-09-18T22:59:59Z \
--role-arn arn:aws:iam::123456789012:role/my-s3-export-role \
--s3-export-configuration file://my-s3-export-config.json
Содержимое my-s3-export-config.json:
{
"Bucket": "amzn-s3-demo-bucket",
"Prefix": "ledgerexport1/",
"EncryptionConfiguration": {
"ObjectEncryptionType": "SSE_S3"
}
}
Вывод:
{
"ExportId": "ADR2ONPKN5LINYGb4dp7yZ"
}
Дополнительную информацию см. в разделе «Экспорт журнала в Amazon QLDB» в Руководстве разработчика Amazon QLDB.
Вывод
ExportId -> (строка)
Уникальный идентификатор (представленный в тексте, закодированном в Base62), который QLDB присваивает каждой задаче экспорта журнала.
Для описания вашего запроса на экспорт и проверки состояния задачи можно использовать ExportId для вызова DescribeJournalS3Export .
© Copyright 2025, Amazon Web Services. Created using Sphinx.