Spec-Zone.ru › AWS CLI v2

[ aws . glue ]

get-catalogs

Описание

Получает все каталоги, определённые в каталоге в Glue Data Catalog. Для случая каталога, связанного с Redshift, эта операция возвращает список каталогов, сопоставленных с базами данных Redshift в каталоге пространства имён Redshift.

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

Синтаксис

  get-catalogs
[--parent-catalog-id <value>]
[--next-token <value>]
[--max-results <value>]
[--recursive | --no-recursive]
[--include-root | --no-include-root]
[--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]

Параметры

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

Идентификатор родительского каталога, в котором находится каталог. Если не указан, используется номер учётной записи Amazon Web Services по умолчанию.

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

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

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

Максимальное количество каталогов, возвращаемых в одном ответе.

--recursive | --no-recursive (булево)

Указывает, следует ли перечислить все каталоги по всей иерархии каталогов, начиная с ParentCatalogId . По умолчанию установлено значение false . Когда true , все объекты каталога в иерархии ParentCatalogID перечисляются в ответе.

--include-root | --no-include-root (булево)

Указывает, следует ли перечислить каталог по умолчанию в учётной записи и регионе в ответе. По умолчанию установлено значение false . Когда true и ParentCatalogId = NULL | Amazon Web Services Account ID , все каталоги и каталог по умолчанию перечисляются в ответе.

Когда ParentCatalogId не равно null, а этот атрибут передан как false или true , выбрасывается исключение InvalidInputException.

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

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

  • включено
  • выключено
  • автоматически

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

Вывод

CatalogList -> (список)

Массив объектов Catalog. Список объектов Catalog из указанного родительского каталога.

(структура)

Объект каталога представляет собой логическую группировку баз данных в Glue Data Catalog или федеративном источнике. Теперь можно создавать каталог, связанный с Redshift, или каталог, содержащий ссылки на ресурсы на базы данных Redshift в другой учётной записи или регионе.

CatalogId -> (строка)

Идентификатор каталога. Для предоставления доступа к каталогу по умолчанию этот параметр не следует указывать.

Name -> (строка)

Имя каталога. Не может совпадать с идентификатором учётной записи.

ResourceArn -> (строка)

Amazon Resource Name (ARN), назначенный ресурсу каталога.

Description -> (строка)

Строка описания, длина которой не превышает 2048 байт, соответствующая шаблону строки URI с несколькими строками. Описание каталога.

Parameters -> (карта)

Массив пар ключ-значение, определяющих параметры и свойства каталога.

key -> (строка)

value -> (строка)

CreateTime -> (метка времени)

Время создания каталога.

UpdateTime -> (метка времени)

Время последнего обновления каталога.

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

Объект TargetRedshiftCatalog, описывающий целевой каталог для связывания ресурсов базы данных.

CatalogArn -> (строка)

Amazon Resource Name (ARN) ресурса каталога.

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

Объект FederatedCatalog, который указывает на сущность вне Glue Data Catalog.

Identifier -> (строка)

Уникальный идентификатор федеративного каталога.

ConnectionName -> (строка)

Имя соединения с внешним источником данных, например, каталогом, связанным с Redshift.

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

Объект CatalogProperties, который определяет свойства доступа к хранилищу данных и другие пользовательские свойства.

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

Объект DataLakeAccessProperties со входными свойствами для настройки доступа к хранилищу данных для вашего ресурса каталога в Glue Data Catalog.

DataLakeAccess -> (булево)

Включает или отключает доступ к хранилищу данных для приложений Apache Spark, которые обращаются к базам данных Amazon Redshift в Data Catalog.

DataTransferRole -> (строка)

Роль, которая будет принята Glue для передачи данных в/из резервного хранилища во время запроса.

KmsKey -> (строка)

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

ManagedWorkgroupName -> (строка)

Имя управляемого вычислительного узла Redshift Serverless, созданного для вашего ресурса каталога.

ManagedWorkgroupStatus -> (строка)

Статус управляемого вычислительного узла Redshift Serverless.

RedshiftDatabaseName -> (строка)

Имя ресурса базы данных Redshift по умолчанию в управляемом вычислительном узле.

StatusMessage -> (строка)

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

CatalogType -> (строка)

Указывает тип федеративного каталога для нативного ресурса каталога. В настоящее время поддерживается тип aws:redshift .

CustomProperties -> (карта)

Дополнительные свойства ключ-значение для каталога, такие как оптимизации статистики столбцов.

key -> (строка)

value -> (строка)

CreateTableDefaultPermissions -> (список)

Массив объектов PrincipalPermissions. Создаёт набор прав по умолчанию для таблицы(ий) для принципалов. Используется Amazon Web Services Lake Formation. Не используется в обычном процессе работы Glue.

(структура)

Права, предоставленные принципалу.

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

Принципал, которому предоставлены права.

DataLakePrincipalIdentifier -> (строка)

Идентификатор принципала Lake Formation.

Permissions -> (список)

Права, предоставленные принципалу.

(строка)

CreateDatabaseDefaultPermissions -> (список)

Массив объектов PrincipalPermissions. Создаёт набор прав по умолчанию для базы данных(ей) для принципалов. Используется Amazon Web Services Lake Formation. Не используется в обычном процессе работы Glue.

(структура)

Права, предоставленные принципалу.

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

Принципал, которому предоставлены права.

DataLakePrincipalIdentifier -> (строка)

Идентификатор принципала Lake Formation.

Permissions -> (список)

Права, предоставленные принципалу.

(строка)

AllowFullTableExternalDataAccess -> (строка)

Разрешает сторонним движкам доступ к данным в расположениях Amazon S3, зарегистрированных в Lake Formation.

NextToken -> (строка)

Маркер продолжения для постраничной навигации по возвращаемому списку маркеров, возвращаемый, если текущий фрагмент списка не является последним.

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

Spec-Zone.ru

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