Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

удалить-каталог-данных

Описание

Удаляет каталог данных.

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

Синтаксис

  delete-data-catalog
--name <value>
[--delete-catalog-only | --no-delete-catalog-only]
[--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 (строка)

Имя каталога данных для удаления.

--delete-catalog-only | --no-delete-catalog-only (логическое значение)

Удаляет каталог данных Athena. Вы можете использовать только с каталогами FEDERATED. Обычно это выполняется перед регистрацией коннектора в Glue Data Catalog. После удаления вам потребуется управлять Glue Connection и функцией Lambda.

--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 команды на указанный.

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

Примеры

Примечание

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

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

Для удаления каталога данных

Следующий delete-data-catalog пример удаляет UnusedDataCatalog каталог данных.

aws athena delete-data-catalog \
    --name UnusedDataCatalog

Эта команда не выводит ничего.

Для получения дополнительной информации см. Удаление каталога: delete-data-catalog в Руководстве пользователя Amazon Athena.

Вывод

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

Содержит информацию о каталоге данных в учетной записи Amazon Web Services.

Примечание

В консоли Athena каталоги данных отображаются как «источники данных» на странице Источники данных в столбце Имя источника данных.

Name -> (строка)

Имя каталога данных. Имя каталога должно быть уникальным для учетной записи Amazon Web Services и может содержать максимум 127 символов латинского алфавита, цифр, подчеркивания, знака @ или тире. Остаток ограничения в 256 символах зарезервирован для использования Athena.

Description -> (строка)

Необязательное описание каталога данных.

Type -> (строка)

Тип создаваемого каталога данных: LAMBDA для федеративного каталога, GLUE для Glue Data Catalog и HIVE для внешнего метахранилища Apache Hive. FEDERATED — это федеративный каталог, для которого Athena создает подключение и функцию Lambda на основе параметров, которые вы передаете.

Parameters -> (массив)

Указывает функцию 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 принимает параметр catalog 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\"}"

key -> (строка)

value -> (строка)

Status -> (строка)

Статус создания или удаления каталога данных.

  • Типы каталогов данных 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 : Федеративный каталог данных не удалось удалить.

ConnectionType -> (строка)

Тип подключения для каталога данных FEDERATED (например, REDSHIFT , MYSQL или SQLSERVER). Дополнительная информация о конкретных коннекторах представлена в Доступные коннекторы источников данных.

Error -> (строка)

Текст ошибки, возникшей во время создания или удаления каталога данных.

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

Spec-Zone.ru

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