Spec-Zone.ru › AWS CLI v2

[ aws . lakeformation ]

get-table-objects

Описание

Возвращает набор объектов Amazon S3, составляющих указанную управляемую таблицу. Для запросов с временным перемещением можно указать идентификатор транзакции или метку времени.

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

Синтаксис

  get-table-objects
[--catalog-id <value>]
--database-name <value>
--table-name <value>
[--transaction-id <value>]
[--query-as-of-time <value>]
[--partition-predicate <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]

Параметры

--catalog-id (строка)

Каталог, содержащий управляемую таблицу. По умолчанию используется каталог вызывающего пользователя.

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

База данных, содержащая управляемую таблицу.

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

Управляемая таблица, для которой необходимо получить объекты.

--transaction-id (строка)

Идентификатор транзакции, по состоянию которой следует читать содержимое управляемой таблицы. Если транзакция была прервана, возвращается ошибка. Если не задано, используется последняя завершенная транзакция. Не может быть указано вместе с QueryAsOfTime.

--query-as-of-time (метка времени)

Время, по состоянию которого следует читать содержимое управляемой таблицы. Если не задано, используется время последнего завершения транзакции. Не может быть указано вместе с TransactionId.

--partition-predicate (строка)

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

  • Поддерживаемые операторы сравнения: =, >, <, >=, <=
  • Поддерживаемые логические операторы: AND
  • Поддерживаемые типы данных: целые числа, long, дата (гггг-мм-дд), метка времени (гггг-мм-дд чч:мм:ссXXX или гггг-мм-дд чч:мм:сс”), строка и десятичные числа.

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

Указывает, сколько значений вернуть на странице.

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

Маркер продолжения, если это не первый вызов для получения этих объектов.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить вывод цвета.

  • on
  • off
  • auto

--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.

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

Чтобы перечислить объекты управляемой таблицы

Следующий get-table-objects пример возвращает набор объектов Amazon S3, составляющих указанную управляемую таблицу.

aws lakeformation get-table-objects \
    --cli-input-json file://input.json

Содержимое input.json:

{
    "CatalogId": "012345678901",
    "DatabaseName": "tpc",
    "TableName": "dl_tpc_household_demographics_gov",
    "QueryAsOfTime": "2022-08-10T15:00:00"
}

Вывод:

{
    "Objects": [{
        "PartitionValues": [],
        "Objects": [{
            "Uri": "s3://lf-data-lake-012345678901/target/dl_tpc_household_demographics_gov/run-unnamed-1-part-block-0-r-00000-snappy-ff26b17504414fe88b302cd795eabd00.parquet",
            "ETag": "12345b1fc50a316b149b4e1f21a73800",
            "Size": 43235
        }]
    }]
}

Дополнительную информацию см. в разделе Чтение из озера данных и запись в него в рамках транзакций в Руководстве разработчика AWS Lake Formation.

Вывод

Объекты -> (список)

Список объектов, организованных по партиционным ключам.

(структура)

Структура, содержащая список значений партиций и объектов таблицы.

PartitionValues -> (список)

Список значений партиций.

(строка)

Objects -> (список)

Список объектов таблицы

(структура)

Указывает детали управляемой таблицы.

Uri -> (строка)

Расположение объекта в Amazon S3.

ETag -> (строка)

ETag объекта Amazon S3. Возвращается GetTableObjects для проверки и используется для идентификации изменений в базовых данных.

Size -> (long)

Размер объекта Amazon S3 в байтах.

NextToken -> (строка)

Маркер продолжения, указывающий на то, доступны ли дополнительные данные.

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

Spec-Zone.ru

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