[ aws . cleanrooms ]
get-schema-analysis-rule
Описание
Извлекает правило анализа схемы.
См. также: Документация API AWS
Синтаксис
get-schema-analysis-rule
--collaboration-identifier <value>
--name <value>
--type <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 (строка)
--type (строка)
Тип правила анализа схемы, которое требуется извлечь. Правила анализа схем уникально идентифицируются по комбинации сотрудничества, имени схемы и их типу.
Возможные значения:
AGGREGATIONLISTCUSTOMID_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-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Вывод
analysisRule -> (структура)
Спецификация того, как данные из настроенной таблицы могут быть использованы.
collaborationId -> (строка)
type -> (строка)
name -> (строка)
createTime -> (метка времени)
updateTime -> (метка времени)
policy -> (структура помеченного объединения)
Политика, описывающая ограничения связанного использования данных.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:v1.v1 -> (структура помеченного объединения)
Управление запросами, которые могут быть выполнены к настроенной таблице.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:list, aggregation, custom, idMappingTable.list -> (структура)
Тип правила анализа, который позволяет выполнять только запросы списка для настроенной таблицы.
joinColumns -> (список)
Столбцы, которые могут быть использованы для объединения настроенной таблицы с таблицей участника, который может выполнять запрос, и с другими настроенными таблицами участников.
(строка)
allowedJoinOperators -> (список)
Логические операторы (если есть), которые должны использоваться в условии совпадения INNER JOIN. По умолчанию — AND.
(строка)
listColumns -> (список)
Столбцы, которые могут быть отображены в выводе.
(строка)
additionalAnalyses -> (строка)
aggregation -> (структура)
Тип правила анализа, который позволяет выполнять только агрегационные запросы для настроенной таблицы.
aggregateColumns -> (список)
Столбцы, которые запросы могут использовать в агрегационных запросах.
(структура)
Столбец в настроенной таблице, который может использоваться в агрегационной функции в запросе.
columnNames -> (список)
Имена столбцов в настроенной таблице агрегированных столбцов.
(строка)
function -> (строка)
joinColumns -> (список)
Столбцы в настроенной таблице, которые могут использоваться в операторах JOIN и/или как агрегированные столбцы. Они никогда не могут быть выведены напрямую.
(строка)
joinRequired -> (строка)
allowedJoinOperators -> (список)
Логические операторы (если есть), которые должны использоваться в условии совпадения INNER JOIN. По умолчанию — AND.
(строка)
dimensionColumns -> (список)
Столбцы, которые запросы могут выбирать, группировать или фильтровать.
(строка)
scalarFunctions -> (список)
Набор скалярных функций, которые разрешено использовать для столбцов измерений и результатов агрегации метрик.
(строка)
outputConstraints -> (список)
Столбцы, которые должны удовлетворять определенному пороговому значению (после применения к ним агрегационной функции) для возврата каждой строки вывода.
(структура)
Ограничение на вывод запроса, удаляющее строки вывода, которые не соответствуют минимальному количеству уникальных значений указанного столбца.
columnName -> (строка)
minimum -> (целое число)
type -> (строка)
additionalAnalyses -> (строка)
Указатель, позволяющий применять дополнительные анализы (например, Clean Rooms ML) к результатам прямого запроса.
Параметр additionalAnalyses в настоящее время поддерживается для правила анализа списка (AnalysisRuleList) и правила анализа пользовательского типа (AnalysisRuleCustom).
custom -> (структура)
Тип правила анализа, позволяющий выполнять пользовательские SQL-запросы к настроенной таблице.
allowedAnalyses -> (список)
ARN шаблонов анализов, разрешенных правилом анализа пользовательского типа.
(строка)
allowedAnalysisProviders -> (список)
Идентификаторы учетных записей Amazon Web Services, которым разрешено выполнять запросы по правилу анализа пользовательского типа. Необходимо при allowedAnalyses равном ANY_QUERY.
(строка)
additionalAnalyses -> (строка)
disallowedOutputColumns -> (список)
Список столбцов, которые не разрешено отображать в выводе запроса.
(строка)
differentialPrivacy -> (структура)
Настройка дифференциальной конфиденциальности.
columns -> (список)
Имя столбца (например, user_id), содержащего уникальный идентификатор пользователей, чья конфиденциальность должна быть защищена. Если вы хотите включить дифференциальную конфиденциальность для двух или более таблиц в сотрудничестве, вам необходимо настроить тот же столбец как столбец идентификатора пользователя в обоих правилах анализа.
(структура)
Указывает имя столбца, содержащего уникальный идентификатор ваших пользователей, чью конфиденциальность вы хотите защитить.
name -> (строка)
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 -> (строка)
additionalAnalyses -> (строка)
allowedResultReceivers -> (список)
Разрешённые получатели результатов.
(строка)
allowedAdditionalAnalyses -> (список)
Дополнительные анализы, разрешённые агрегацией объединённой политики.
(строка)
custom -> (структура)
Пользовательская политика
allowedAnalyses -> (список)
Разрешённые анализы.
(строка)
allowedAnalysisProviders -> (список)
Разрешённые поставщики анализов.
(строка)
additionalAnalyses -> (строка)
disallowedOutputColumns -> (список)
Запрещённые столбцы вывода
(строка)
differentialPrivacy -> (структура)
Указывает уникальный идентификатор ваших пользователей.
columns -> (список)
Название столбца (например, user_id), содержащего уникальный идентификатор ваших пользователей, чью конфиденциальность вы хотите защитить. Если вы хотите включить дифференциальную конфиденциальность для двух или более таблиц в сотрудничестве, вы должны настроить один и тот же столбец в качестве идентификатора пользователя в обоих правилах анализа.
(структура)
Указывает имя столбца, содержащего уникальный идентификатор ваших пользователей, чью конфиденциальность вы хотите защитить.
name -> (строка)
allowedResultReceivers -> (список)
Разрешённые получатели результатов.
(строка)
allowedAdditionalAnalyses -> (список)
Дополнительные анализы, разрешённые объединённой политикой.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.