Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

create-configured-table-analysis-rule

Описание

Создаёт новую политику анализа для настроенной таблицы. В настоящее время для данной настроенной таблицы может быть создана только одна политика анализа.

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

Синтаксис

  create-configured-table-analysis-rule
--configured-table-identifier <value>
--analysis-rule-type <value>
--analysis-rule-policy <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]

Параметры

--configured-table-identifier (строка)

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

--analysis-rule-type (строка)

Тип политики анализа.

Возможные значения:

  • AGGREGATION
  • LIST
  • CUSTOM

--analysis-rule-policy (меченый объединённый тип данных)

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

Примечание

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

v1 -> (меченый объединённый тип данных)

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

Примечание

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

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

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

joinColumns -> (список)

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

(строка)

allowedJoinOperators -> (список)

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

(строка)

listColumns -> (список)

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

(строка)

additionalAnalyses -> (строка)

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

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

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

aggregateColumns -> (список)

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

(структура)

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

columnNames -> (список)

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

(строка)

function -> (строка)

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

joinColumns -> (список)

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

(строка)

joinRequired -> (строка)

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

allowedJoinOperators -> (список)

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

(строка)

dimensionColumns -> (список)

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

(строка)

scalarFunctions -> (список)

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

(строка)

outputConstraints -> (список)

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

(структура)

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

columnName -> (строка)

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

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

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

type -> (строка)

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

additionalAnalyses -> (строка)

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

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

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

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

allowedAnalyses -> (список)

ARN шаблонов анализа, разрешённых правилом custom анализа.

(строка)

allowedAnalysisProviders -> (список)

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

(строка)

additionalAnalyses -> (строка)

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

disallowedOutputColumns -> (список)

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

(строка)

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

Настройка диffеренциальной конфиденциальности.

columns -> (список)

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

(структура)

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

name -> (строка)

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

Синтаксис JSON:

{
  "v1": {
    "list": {
      "joinColumns": ["string", ...],
      "allowedJoinOperators": ["OR"|"AND", ...],
      "listColumns": ["string", ...],
      "additionalAnalyses": "ALLOWED"|"REQUIRED"|"NOT_ALLOWED"
    },
    "aggregation": {
      "aggregateColumns": [
        {
          "columnNames": ["string", ...],
          "function": "SUM"|"SUM_DISTINCT"|"COUNT"|"COUNT_DISTINCT"|"AVG"
        }
        ...
      ],
      "joinColumns": ["string", ...],
      "joinRequired": "QUERY_RUNNER",
      "allowedJoinOperators": ["OR"|"AND", ...],
      "dimensionColumns": ["string", ...],
      "scalarFunctions": ["ABS"|"CAST"|"CEILING"|"COALESCE"|"CONVERT"|"CURRENT_DATE"|"DATEADD"|"EXTRACT"|"FLOOR"|"GETDATE"|"LN"|"LOG"|"LOWER"|"ROUND"|"RTRIM"|"SQRT"|"SUBSTRING"|"TO_CHAR"|"TO_DATE"|"TO_NUMBER"|"TO_TIMESTAMP"|"TRIM"|"TRUNC"|"UPPER", ...],
      "outputConstraints": [
        {
          "columnName": "string",
          "minimum": integer,
          "type": "COUNT_DISTINCT"
        }
        ...
      ],
      "additionalAnalyses": "ALLOWED"|"REQUIRED"|"NOT_ALLOWED"
    },
    "custom": {
      "allowedAnalyses": ["string", ...],
      "allowedAnalysisProviders": ["string", ...],
      "additionalAnalyses": "ALLOWED"|"REQUIRED"|"NOT_ALLOWED",
      "disallowedOutputColumns": ["string", ...],
      "differentialPrivacy": {
        "columns": [
          {
            "name": "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
  • текст
  • таблица
  • 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.

Вывод

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

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

configuredTableId -> (строка)

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

configuredTableArn -> (строка)

Уникальный ARN настроенной таблицы.

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

Политика, управляющая правилами запросов SQL.

Примечание

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

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

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

Примечание

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

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

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

joinColumns -> (список)

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

(строка)

allowedJoinOperators -> (список)

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

(строка)

listColumns -> (список)

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

(строка)

additionalAnalyses -> (строка)

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

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

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

aggregateColumns -> (список)

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

(структура)

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

columnNames -> (список)

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

(строка)

function -> (строка)

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

joinColumns -> (список)

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

(строка)

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

type -> (строка)

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

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

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

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

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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