Spec-Zone.ru › AWS CLI v2

[ aws . glue ]

get-entity-records

Описание

Этот API используется для запроса предварительных данных из заданного типа подключения или из родного каталога данных Glue, основанного на Amazon S3.

Возвращает записи в виде массива JSON-блоков. Каждая запись отформатирована с использованием Jackson JsonNode в зависимости от типа поля, определённого API DescribeEntity.

Подключаемые модули Spark генерируют схемы в соответствии с той же картой типов данных, что и в API DescribeEntity. Подключаемые модули Spark преобразуют данные в соответствующие типы данных, соответствующие схеме, при возвращении строк.

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

get-entity-records использует значения типа документа. Типы документов следуют модели JSON-данных, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для ввода команды, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  get-entity-records
[--connection-name <value>]
[--catalog-id <value>]
--entity-name <value>
[--next-token <value>]
[--data-store-api-version <value>]
[--connection-options <value>]
[--filter-predicate <value>]
--limit <value>
[--order-by <value>]
[--selected-fields <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]

Опции

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

Имя подключения, содержащего учетные данные типа подключения.

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

Идентификатор каталога каталога, содержащего подключение. Может быть null. По умолчанию, идентификатором каталога является идентификатор учетной записи Amazon Web Services.

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

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

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

Токен продолжения, включается, если это вызов продолжения.

--data-store-api-version (строка)

Версия API подключаемого модуля SaaS.

--connection-options (карта)

Опции подключаемого модуля, необходимые для запроса данных.

ключ -> (строка)

значение -> (строка)

Краткая синтаксическая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

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

Предикат фильтра, который можно применить в запросе.

--limit (длинное целое)

Ограничивает количество записей, извлеченных с запросом.

--order-by (строка)

Параметр, который упорядочивает предварительные данные ответа.

--selected-fields (список)

Список полей, которые мы хотим извлечь как часть предварительных данных.

(строка)

Синтаксис:

"string" "string" ...

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

Вывод

Записи -> (список)

Список запрошенных объектов.

(документ)

NextToken -> (строка)

Токен продолжения, присутствует, если текущий сегмент не последний.

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

Spec-Zone.ru

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