Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

batch-get-schema

Описание

Получает несколько схем по их идентификаторам.

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

Синтаксис

  batch-get-schema
--collaboration-identifier <value>
--names <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 (строка)

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

--names (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

Вывод

schemas -> (список)

Полученный список схем.

(структура)

Схема — это отношение в рамках сотрудничества.

columns -> (список)

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

(структура)

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

name -> (строка)

Имя столбца.

type -> (строка)

Тип столбца.

partitionKeys -> (список)

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

(структура)

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

name -> (строка)

Имя столбца.

type -> (строка)

Тип столбца.

analysisRuleTypes -> (список)

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

(строка)

analysisMethod -> (строка)

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

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

DIRECT_JOB позволяет запускать задачи PySpark непосредственно в этой таблице.

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

selectedAnalysisMethods -> (список)

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

(строка)

creatorAccountId -> (строка)

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

name -> (строка)

Имя схемы. Схема отношения ссылается на это имя при запросе с помощью защищенного запроса.

collaborationId -> (строка)

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

collaborationArn -> (строка)

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

description -> (строка)

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

createTime -> (временная метка)

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

updateTime -> (временная метка)

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

type -> (строка)

Тип схемы.

schemaStatusDetails -> (список)

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

(структура)

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

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

status -> (строка)

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

reasons -> (список)

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

(структура)

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

code -> (строка)

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

message -> (строка)

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

analysisRuleType -> (строка)

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

configurations -> (список)

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

(строка)

analysisType -> (строка)

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

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

schemaTypeProperties -> (меченый объединенный структура)

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

Примечание

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

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

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

idMappingTableInputSource -> (список)

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

(структура)

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

idNamespaceAssociationId -> (строка)

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

type -> (строка)

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

errors -> (список)

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

(структура)

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

name -> (строка)

Имя ошибки.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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