Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

получить-схему

Описание

Получает схему для отношения в рамках сотрудничества.

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

Синтаксис

  get-schema
--collaboration-identifier <value>
--name <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]

Параметры

--collaboration-identifier (строка)

Уникальный идентификатор сотрудничества, к которому относится схема. В настоящее время поддерживается идентификатор сотрудничества.

--name (строка)

Имя отношения, для которого требуется получить схему.

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Вывод

схема -> (структура)

Весь объект схемы.

столбцы -> (список)

Столбцы для отношения, которое представляет эта схема.

(структура)

Столбец в отношении схемы, полученный из базовой таблицы.

название -> (строка)

Название столбца.

тип -> (строка)

Тип столбца.

ключи-разделения -> (список)

Ключи разделения для набора данных, лежащих в основе этой схемы.

(структура)

Столбец в отношении схемы, полученный из базовой таблицы.

название -> (строка)

Название столбца.

тип -> (строка)

Тип столбца.

типы-правил-анализа -> (список)

Типы правил анализа, связанные со схемой. В настоящее время присутствует только одна запись.

(строка)

метод-анализа -> (строка)

Метод анализа для схемы.

DIRECT_QUERY позволяет выполнять SQL-запросы напрямую на этой таблице.

DIRECT_JOB позволяет выполнять PySpark-задачи напрямую на этой таблице.

MULTIPLE позволяет выполнять как SQL-запросы, так и PySpark-задачи напрямую на этой таблице.

выбранные-методы-анализа -> (список)

Выбранные методы анализа для схемы.

(строка)

идентификатор-создателя-аккаунта -> (строка)

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

название -> (строка)

Название схемы. Отношение схемы ссылается на это название при запросе защищённым запросом.

идентификатор-сотрудничества -> (строка)

Уникальный идентификатор сотрудничества, к которому относится схема.

arn-сотрудничества -> (строка)

Уникальный Amazon Resource Name (ARN) для сотрудничества, к которому относится схема.

описание -> (строка)

Описание схемы.

время-создания -> (метка-времени)

Время создания схемы.

время-обновления -> (метка-времени)

Самое последнее время обновления схемы.

тип -> (строка)

Тип схемы.

детали-статуса-схемы -> (список)

Детали статуса схемы. В настоящее время присутствует только одна запись.

(структура)

Информация о статусе схемы.

Статус READY означает, что на основе правила анализа схемы запросы указанного типа правила анализа правильно настроены для выполнения запросов на этой схеме.

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

Статус схемы, указывающий, готова ли она к запросу.

причины -> (список)

Причины, по которым статус схемы установлен в текущем состоянии.

(структура)

Причина, по которой статус схемы установлен в текущее значение.

код -> (строка)

Код причины статуса схемы.

сообщение -> (строка)

Объяснение кода причины статуса схемы.

тип-правила-анализа -> (строка)

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

настройки -> (список)

Подробные сведения о конфигурации правила анализа схемы для данного типа.

(строка)

тип-анализа -> (строка)

Тип анализа, который может быть выполнен на схеме.

Схема может иметь тип analysisType DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION или оба.

свойства-типа-схемы -> (меченый-объединительная-структура)

Свойства типа схемы.

Примечание

Это меченная объединительная структура. Только один из следующих ключей верхнего уровня может быть установлен: idMappingTable.

таблица-сопоставления-id -> (структура)

Таблица сопоставления ID для свойств типа схемы.

источник-входных-данных-таблицы-сопоставления-id -> (список)

Определяет, какие ассоциации пространства имён ID используются для создания таблицы сопоставления ID.

(структура)

Источник входных данных таблицы сопоставления ID.

идентификатор-ассоциации-пространства-имён-id -> (строка)

Уникальный идентификатор ассоциации пространства имён ID.

тип -> (строка)

Тип источника входных данных таблицы сопоставления ID.

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

Spec-Zone.ru

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