Spec-Zone.ru › AWS CLI v2

[ aws . glue ]

get-catalog

Описание

Имя каталога Catalog для получения. Оно должно быть в нижнем регистре.

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

Синтаксис

  get-catalog
--catalog-id <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]

Параметры

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

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

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

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

  • on
  • off
  • auto

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

Вывод

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

Объект Catalog. Определение указанного каталога в каталоге данных Glue.

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.

Identifier -> (строка)

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

ConnectionName -> (строка)

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

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

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

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

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

DataLakeAccess -> (логическое значение)

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

DataTransferRole -> (строка)

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

KmsKey -> (строка)

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

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.

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

Spec-Zone.ru

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