Spec-Zone.ru › AWS CLI v2

[ aws . dynamodb ]

describe-export

Описание

Описывает существующий экспорт таблицы.

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

Синтаксис

  describe-export
--export-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]

Параметры

--export-arn (строка)

Amazon Resource Name (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
  • текст
  • таблица
  • 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.

Вывод

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

Представляет свойства экспорта.

ExportArn -> (строка)

Amazon Resource Name (ARN) экспорта таблицы.

ExportStatus -> (строка)

Экспорт может быть в одном из следующих состояний: IN_PROGRESS, COMPLETED или FAILED.

StartTime -> (временная метка)

Время начала задачи экспорта.

EndTime -> (временная метка)

Время завершения задачи экспорта.

ExportManifest -> (строка)

Имя файла манифеста для задачи экспорта.

TableArn -> (строка)

Amazon Resource Name (ARN) таблицы, которая была экспортирована.

TableId -> (строка)

Уникальный идентификатор таблицы, которая была экспортирована.

ExportTime -> (временная метка)

Точка во времени, от которой экспортировались данные таблицы.

ClientToken -> (строка)

Маркер клиента, который был предоставлен для задачи экспорта. Маркер клиента делает вызовы к ExportTableToPointInTimeInput идемпотентными, что означает, что несколько идентичных вызовов имеют тот же эффект, что и один единственный вызов.

S3Bucket -> (строка)

Имя Amazon S3-бакета, содержащего экспорт.

S3BucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей бакетом, содержащим экспорт.

S3Prefix -> (строка)

Префикс Amazon S3-бакета, используемый в качестве имени и пути к файлам экспортированного снимка.

S3SseAlgorithm -> (строка)

Тип шифрования, используемый для бакета, в котором хранятся данные экспорта. Допустимые значения для S3SseAlgorithm:

  • AES256 - шифрование на стороне сервера с управляемыми Amazon S3 ключами
  • KMS - шифрование на стороне сервера с управляемыми KMS ключами

S3SseKmsKeyId -> (строка)

Идентификатор KMS-ключа, используемого для шифрования S3-бакета, в котором хранятся данные экспорта (при необходимости).

FailureCode -> (строка)

Код состояния для результата неудачного экспорта.

FailureMessage -> (строка)

Описание причины ошибки экспорта.

ExportFormat -> (строка)

Формат экспортированных данных. Допустимые значения для ExportFormat: DYNAMODB_JSON или ION.

BilledSizeBytes -> (длинное целое число)

Объём экспорта таблицы, подлежащий оплате.

ItemCount -> (длинное целое число)

Количество экспортированных элементов.

ExportType -> (строка)

Тип выполненного экспорта. Допустимые значения: FULL_EXPORT или INCREMENTAL_EXPORT.

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

Необязательный объект, содержащий параметры, специфичные для инкрементального экспорта.

ExportFromTime -> (временная метка)

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

ExportToTime -> (временная метка)

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

ExportViewType -> (строка)

Тип представления, выбранный для экспорта. Допустимые значения: NEW_AND_OLD_IMAGES и NEW_IMAGES. Значение по умолчанию: NEW_AND_OLD_IMAGES.

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

Spec-Zone.ru

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