Spec-Zone.ru › AWS CLI v2

[ aws . qldb ]

list-journal-s3-exports

Описание

Возвращает все задания экспорта журнала для всех журналов, связанных с текущей учётной записью Amazon Web Services и регионом.

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

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

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

Синтаксис

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

Параметры

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

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

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

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

--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
  • таблица
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для просмотра заданий экспорта журнала

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

aws qldb list-journal-s3-exports

Вывод:

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

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

Вывод

JournalS3Exports -> (список)

Задания экспорта журнала для всех журналов, связанных с текущей учётной записью Amazon Web Services и регионом.

(структура)

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

LedgerName -> (строка)

Имя журнала.

ExportId -> (строка)

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

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

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

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 Resource Name (ARN) симметричного ключа шифрования в Key Management Service (KMS). Amazon S3 не поддерживает асимметричные ключи KMS.

Необходимо предоставить KmsKeyArn, если вы указали SSE_KMS как ObjectEncryptionType.

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

RoleArn -> (строка)

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

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

OutputFormat -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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