Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

batch-get-schema-analysis-rule

Описание

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

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

Синтаксис

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

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

--schema-analysis-rule-requests (список)

Информация, необходимая для получения правила анализа схемы.

(структура)

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

name -> (строка)

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

type -> (строка)

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

Сокращенный синтаксис:

name=string,type=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "type": "AGGREGATION"|"LIST"|"CUSTOM"|"ID_MAPPING_TABLE"
  }
  ...
]

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

Вывод

analysisRules -> (список)

Полученный список правил анализа.

(структура)

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

collaborationId -> (строка)

Уникальный идентификатор связанной коллаборации.

type -> (строка)

Тип правила анализа.

name -> (строка)

Название правила анализа.

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

Время создания правила анализа.

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

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

policy -> (структура помеченного объединения)

Политика, описывающая ограничения на использование связанных данных.

Примечание

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

v1 -> (структура помеченного объединения)

Управление параметрами запросов, которые могут выполняться над настроенной таблицей.

Примечание

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

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

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

joinColumns -> (список)

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

(строка)

allowedJoinOperators -> (список)

Логические операторы (если таковые имеются), которые должны использоваться в условии сопоставления INNER JOIN. По умолчанию — AND.

(строка)

listColumns -> (список)

Столбцы, которые могут быть перечислены в выводе.

(строка)

additionalAnalyses -> (строка)

Указатель о возможности применения дополнительных анализов (таких как Clean Rooms ML) к результатам прямого запроса.

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

Тип правила анализа, который позволяет только агрегационные запросы к настроенной таблице.

aggregateColumns -> (список)

Столбцы, которые исполнители запросов разрешено использовать в агрегационных запросах.

(структура)

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

columnNames -> (список)

Имена столбцов в настроенной таблице агрегированных столбцов.

(строка)

function -> (строка)

Функция агрегирования, которая может быть применена к агрегированному столбцу в запросе.

joinColumns -> (список)

Столбцы в настроенной таблице, которые могут использоваться в операциях JOIN и/или как агрегированные столбцы. Они никогда не могут быть выведены непосредственно.

(строка)

joinRequired -> (строка)

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

allowedJoinOperators -> (список)

Логические операторы (если таковые имеются), которые должны использоваться в условии сопоставления INNER JOIN. По умолчанию — AND.

(строка)

dimensionColumns -> (список)

Столбцы, которые исполнители запросов разрешено выбирать, группировать или фильтровать.

(строка)

scalarFunctions -> (список)

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

(строка)

outputConstraints -> (список)

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

(структура)

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

columnName -> (строка)

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

minimum -> (целое число)

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

type -> (строка)

Тип агрегирования, разрешенный ограничением. В настоящее время единственное допустимое значение — COUNT_DISTINCT.

additionalAnalyses -> (строка)

Указатель о возможности применения дополнительных анализов (таких как Clean Rooms ML) к результатам прямого запроса.

Параметр additionalAnalyses в настоящее время поддерживается для правила анализа списка (AnalysisRuleList) и правила анализа пользовательского типа (AnalysisRuleCustom).

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

Тип правила анализа, который позволяет пользовательские SQL-запросы к настроенной таблице.

allowedAnalyses -> (список)

ARN шаблонов анализа, разрешенных правилом анализа пользовательского типа.

(строка)

allowedAnalysisProviders -> (список)

Идентификаторы учётных записей Amazon Web Services, которым разрешено выполнять запросы по правилу анализа пользовательского типа. Требуется, когда allowedAnalyses равно ANY_QUERY.

(строка)

additionalAnalyses -> (строка)

Указатель о возможности применения дополнительных анализов (таких как Clean Rooms ML) к результатам прямого запроса.

disallowedOutputColumns -> (список)

Список столбцов, которые не разрешено отображать в выводе запроса.

(строка)

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

Конфигурация дифференциальной конфиденциальности.

columns -> (список)

Имя столбца (например, user_id), содержащего уникальный идентификатор ваших пользователей, чью конфиденциальность вы хотите защитить. Если вы хотите включить дифференциальную конфиденциальность для двух или более таблиц в рамках коллаборации, вы должны настроить один и тот же столбец в качестве идентификатора пользователя во всех правилах анализа.

(структура)

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

name -> (строка)

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

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

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

joinColumns -> (список)

Столбцы, которые исполнители запросов разрешено использовать в операциях INNER JOIN.

(строка)

queryConstraints -> (список)

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

(структура помеченного объединения)

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

Примечание

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

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

Массив имён столбцов, определяющий, какие столбцы требуются в операциях JOIN.

columns -> (список)

Столбцы, которые должны перекрываться.

(строка)

dimensionColumns -> (список)

Столбцы, которые исполнители запросов разрешено выбирать, группировать или фильтровать.

(строка)

collaborationPolicy -> (структура помеченного объединения)

Управление параметрами запросов, которые могут выполняться над связанной настроенной таблицей.

Примечание

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

v1 -> (структура помеченного объединения)

Политика для правила анализа на основе связанной настроенной таблицы.

Примечание

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

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

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

allowedResultReceivers -> (список)

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

(строка)

allowedAdditionalAnalyses -> (список)

Список ресурсов или подстановочных знаков (ARN), которым разрешено выполнять дополнительный анализ результатов запроса.

(строка)

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

Тип правила анализа, который позволяет только агрегационные запросы к настроенной таблице.

allowedResultReceivers -> (список)

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

(строка)

allowedAdditionalAnalyses -> (список)

Список ресурсов или подстановочных знаков (ARN), которым разрешено выполнять дополнительный анализ результатов запроса.

Параметр allowedAdditionalAnalyses в настоящее время поддерживается для правила анализа списка (AnalysisRuleList) и правила анализа пользовательского типа (AnalysisRuleCustom).

(строка)

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

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

allowedResultReceivers -> (список)

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

(строка)

allowedAdditionalAnalyses -> (список)

Список ресурсов или подстановочных знаков (ARN), которым разрешено выполнять дополнительный анализ результатов запроса.

(строка)

consolidatedPolicy -> (структура помеченного объединения)

Объединённые правила для анализа.

Примечание

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

v1 -> (структура помеченного объединения)

Объединённая политика версии 1.

Примечание

Это структура помеченных объединений. Только один из следующих верхних ключей может быть задан: list, aggregation, custom.

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

Список объединённых политик.

joinColumns -> (список)

Столбцы для объединения.

(строка)

allowedJoinOperators -> (список)

Разрешённые операторы объединения в списке объединённых политик.

(строка)

listColumns -> (список)

Столбцы в списке объединённых политик.

(строка)

additionalAnalyses -> (строка)

Дополнительные анализы для списка объединённых политик.

allowedResultReceivers -> (список)

Разрешённые получатели результатов.

(строка)

allowedAdditionalAnalyses -> (список)

Дополнительные анализы, разрешённые списком объединённых политик.

(строка)

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

Настройка агрегирования для объединённой политики.

aggregateColumns -> (список)

Столбцы агрегирования в агрегировании объединённой политики.

(структура)

Столбец в сконфигурированной таблице, который может быть использован в агрегатной функции в запросе.

columnNames -> (список)

Имена столбцов в сконфигурированной таблице агрегированных столбцов.

(строка)

function -> (строка)

Функция агрегирования, которая может быть применена к столбцу агрегирования в запросе.

joinColumns -> (список)

Столбцы для объединения.

(строка)

joinRequired -> (строка)

Требуется объединение

allowedJoinOperators -> (список)

Разрешённые операторы объединения.

(строка)

dimensionColumns -> (список)

Столбцы измерения агрегирования объединённой политики.

(строка)

scalarFunctions -> (список)

Скалярные функции.

(строка)

outputConstraints -> (список)

Ограничения вывода агрегирования объединённой политики.

(структура)

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

columnName -> (строка)

Столбец в ограничении агрегирования, для которого должно быть минимальное количество различных значений в строке вывода для её включения в вывод запроса.

minimum -> (целое число)

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

type -> (строка)

Тип агрегирования, разрешённого ограничением. В настоящее время единственное допустимое значение COUNT_DISTINCT.

additionalAnalyses -> (строка)

Дополнительные анализы для агрегирования объединённой политики.

allowedResultReceivers -> (список)

Разрешённые получатели результатов.

(строка)

allowedAdditionalAnalyses -> (список)

Дополнительные анализы, разрешённые агрегированием объединённой политики.

(строка)

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

Пользовательская политика

allowedAnalyses -> (список)

Разрешённые анализы.

(строка)

allowedAnalysisProviders -> (список)

Разрешённые поставщики анализов.

(строка)

additionalAnalyses -> (строка)

Дополнительные анализы для объединённой политики.

disallowedOutputColumns -> (список)

Запрещённые столбцы вывода

(строка)

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

Указывает уникальный идентификатор для ваших пользователей.

columns -> (список)

Имя столбца (например, user_id), который содержит уникальный идентификатор ваших пользователей, чью конфиденциальность вы хотите защитить. Если вы хотите включить диffеренциальную конфиденциальность для двух или более таблиц в сотрудничестве, вы должны сконфигурировать один и тот же столбец в качестве столбца идентификатора пользователя в обоих правилах анализа.

(структура)

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

name -> (строка)

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

allowedResultReceivers -> (список)

Разрешённые получатели результатов.

(строка)

allowedAdditionalAnalyses -> (список)

Дополнительные анализы, разрешённые объединённой политикой.

(строка)

errors -> (список)

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

(структура)

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

name -> (строка)

Имя ошибки для ошибки.

type -> (строка)

Тип правила анализа.

code -> (строка)

Код ошибки для ошибки.

message -> (строка)

Описание причины, по которой вызов завершился неудачно.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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