Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

update-configured-table-analysis-rule

Описание

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

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

Синтаксис

  update-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 -> (список)

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

(строка)

joinRequired -> (строка)

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

allowedJoinOperators -> (список)

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

(строка)

dimensionColumns -> (список)

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

(строка)

scalarFunctions -> (список)

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

(строка)

outputConstraints -> (список)

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

(структура)

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

columnName -> (строка)

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

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

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

type -> (строка)

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

additionalAnalyses -> (строка)

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

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

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

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

allowedAnalyses -> (список)

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

(строка)

allowedAnalysisProviders -> (список)

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

(строка)

additionalAnalyses -> (строка)

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

disallowedOutputColumns -> (список)

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

(строка)

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

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

columns -> (список)

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

(структура)

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

name -> (строка)

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

Синтаксис 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