Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

list-data-catalogs

Описание

Выводит список каталогов данных в текущей учетной записи Amazon Web Services.

Примечание

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

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

list-data-catalogs является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DataCatalogsSummary

Синтаксис

  list-data-catalogs
[--work-group <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--work-group (строка)

Имя рабочей группы. Требуется при обращении к IAM Identity Center.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания начала постраничного вывода. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для вызова в AWS-сервисе. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода необходимо указать значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

Примеры

Примечание

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

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

Для перечисления каталогов данных, зарегистрированных в Athena

Следующий list-data-catalogs пример перечисляет каталоги данных, зарегистрированные в Athena.

aws athena list-data-catalogs

Вывод:

{
    "DataCatalogsSummary": [
        {
            "CatalogName": "AwsDataCatalog",
            "Type": "GLUE"
        },
        {
            "CatalogName": "cw_logs_catalog",
            "Type": "LAMBDA"
        },
        {
            "CatalogName": "cw_metrics_catalog",
            "Type": "LAMBDA"
        }
    ]
}

Дополнительную информацию см. в разделе «Перечисление зарегистрированных каталогов: list-data-catalogs» в Руководстве пользователя Amazon Athena.

Вывод

DataCatalogsSummary -> (список)

Список сводной информации о каталогах данных.

(структура)

Сводная информация о каталоге данных, включающая его имя и тип.

CatalogName -> (строка)

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

Type -> (строка)

Тип каталога данных.

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 -> (строка)

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

NextToken -> (строка)

Токен, сгенерированный службой Athena, указывающий, где продолжить постраничный вывод, если предыдущий запрос был усечен. Для получения следующего набора страниц передайте NextToken из объекта ответа предыдущей страницы вызова.

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

Spec-Zone.ru

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