получить-каталог-данных
Описание
Возвращает указанный каталог данных.
См. также: Документацию API AWS
Синтаксис
get-data-catalog
--name <value>
[--work-group <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 (строка)
--work-group (строка)
--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 .
Для возврата информации о каталоге данных
Следующий пример get-data-catalog возвращает информацию о каталоге данных dynamo_db_catalog.
aws athena get-data-catalog \
--name dynamo_db_catalog
Вывод:
{
"DataCatalog": {
"Name": "dynamo_db_catalog",
"Description": "DynamoDB Catalog",
"Type": "LAMBDA",
"Parameters": {
"catalog": "dynamo_db_catalog",
"metadata-function": "arn:aws:lambda:us-west-2:111122223333:function:dynamo_db_lambda",
"record-function": "arn:aws:lambda:us-west-2:111122223333:function:dynamo_db_lambda"
}
}
}
Дополнительную информацию см. в разделе Отображение деталей каталога: get-data-catalog в Руководстве пользователя Amazon Athena.
Вывод
DataCatalog -> (структура)
Возвращенный каталог данных.
Имя -> (строка)
Описание -> (строка)
Тип -> (строка)
LAMBDA для федеративного каталога, GLUE для каталога данных Glue, и HIVE для внешнего хранилища метаданных Apache Hive. FEDERATED — это федеративный каталог, для которого Athena создает соединение и функцию Lambda за вас на основе параметров, которые вы передаете.Параметры -> (отображение)
Указывает функцию Lambda или функции, используемые для каталога данных. Это отображение, значения которого зависят от типа каталога.
- Для типа каталога
HIVEиспользуйте следующий синтаксис. Параметрmetadata-functionобязателен. ПараметрThe sdk-versionявляется необязательным и по умолчанию соответствует текущей поддерживаемой версии. ``metadata-function=*lambda_arn* , sdk-version=*version_number* `` - Для типа каталога
LAMBDAиспользуйте один из следующих наборов обязательных параметров, но не оба.- Если у вас одна функция Lambda, обрабатывающая метаданные, и другая для чтения фактических данных, используйте следующий синтаксис. Оба параметра обязательны. ``metadata-function=*lambda_arn* , record-function=*lambda_arn* ``
- Если у вас есть составная функция Lambda, обрабатывающая как метаданные, так и данные, используйте следующий синтаксис для указания вашей функции Lambda. ``function=*lambda_arn* ``
- Тип
GLUEпринимает параметр ID каталога и является обязательным. `` catalog_id `` — это ID учетной записи Amazon Web Services, к которой принадлежит каталог Glue. ``catalog-id=*catalog_id* ``- Тип каталога
GLUEтакже применим к по умолчаниюAwsDataCatalog, который уже существует в вашей учетной записи, из которых у вас может быть только один и который нельзя изменить.
- Тип каталога
- Тип каталога
FEDERATEDиспользует один из следующих параметров, но не оба. Используйтеconnection-arnдля существующего соединения Glue. Используйтеconnection-typeиconnection-propertiesдля указания параметра конфигурации для нового соединения.- ``connection-arn:<glue_connection_arn_to_reuse> ``
-
connection-type:MYSQL|REDSHIFT|...., connection-properties:"*<json_string>* "Для *<json_string>* используйте экранированный JSON-текст, как в следующем примере."{\"spill_bucket\":\"my_spill\",\"spill_prefix\":\"athena-spill\",\"host\":\"abc12345.snowflakecomputing.com\",\"port\":\"1234\",\"warehouse\":\"DEV_WH\",\"database\":\"TEST\",\"schema\":\"PUBLIC\",\"SecretArn\":\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\"}"
ключ -> (строка)
значение -> (строка)
Статус -> (строка)
Статус создания или удаления каталога данных.
- Типы каталогов данных
LAMBDA,GLUEиHIVEсоздаются синхронно. Их статус может быть либоCREATE_COMPLETE, либоCREATE_FAILED. - Тип каталога
FEDERATEDсоздается асинхронно.
Статус создания каталога данных:
-
CREATE_IN_PROGRESS: Создание федеративного каталога данных в процессе. -
CREATE_COMPLETE: Создание каталога данных завершено. -
CREATE_FAILED: Каталог данных не удалось создать. -
CREATE_FAILED_CLEANUP_IN_PROGRESS: Создание федеративного каталога данных завершилось неудачей и удаляется. -
CREATE_FAILED_CLEANUP_COMPLETE: Создание федеративного каталога данных завершилось неудачей и было удалено. -
CREATE_FAILED_CLEANUP_FAILED: Создание федеративного каталога данных завершилось неудачей, но не удалось удалить.
Статус удаления каталога данных:
-
DELETE_IN_PROGRESS: Удаление федеративного каталога данных в процессе. -
DELETE_COMPLETE: Федеративный каталог данных удален. -
DELETE_FAILED: Федеративный каталог данных не удалось удалить.
ТипСоединения -> (строка)
FEDERATED (например, REDSHIFT , MYSQL или SQLSERVER). Дополнительную информацию об отдельных коннекторах см. в Доступных коннекторах источников данных.Ошибка -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|