Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

создание-шаблона-анализа

Описание

Создает новый шаблон анализа.

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

Синтаксис

  create-analysis-template
[--description <value>]
--membership-identifier <value>
--name <value>
--format <value>
--source <value>
[--tags <value>]
[--analysis-parameters <value>]
[--schema <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]

Параметры

--description (строка)

Описание шаблона анализа.

--membership-identifier (строка)

Идентификатор ресурса членства.

--name (строка)

Название шаблона анализа.

--format (строка)

Формат шаблона анализа.

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

  • SQL
  • PYSPARK_1_0

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

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

Примечание

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

text -> (строка)

Текст запроса.

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

Артефакты источника анализа.

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

Точка входа для артефактов шаблона анализа.

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

Расположение артефакта.

bucket -> (строка)

Имя ведра.

key -> (строка)

Ключ объекта.

additionalArtifacts -> (список)

Дополнительные артефакты для шаблона анализа.

(структура)

Артефакт шаблона анализа.

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

Расположение артефакта.

bucket -> (строка)

Имя ведра.

key -> (строка)

Ключ объекта.

roleArn -> (строка)

ARN роли для артефактов шаблона анализа.

Синтаксис JSON:

{
  "text": "string",
  "artifacts": {
    "entryPoint": {
      "location": {
        "bucket": "string",
        "key": "string"
      }
    },
    "additionalArtifacts": [
      {
        "location": {
          "bucket": "string",
          "key": "string"
        }
      }
      ...
    ],
    "roleArn": "string"
  }
}

--tags (карта)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--analysis-parameters (список)

Параметры шаблона анализа.

(структура)

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

name -> (строка)

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

type -> (строка)

Тип параметра.

defaultValue -> (строка)

Необязательно. Значение по умолчанию, применяемое в шаблоне анализа. Член, который может выполнить запрос, может переопределить это значение в редакторе запросов.

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

name=string,type=string,defaultValue=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "type": "SMALLINT"|"INTEGER"|"BIGINT"|"DECIMAL"|"REAL"|"DOUBLE_PRECISION"|"BOOLEAN"|"CHAR"|"VARCHAR"|"DATE"|"TIMESTAMP"|"TIMESTAMPTZ"|"TIME"|"TIMETZ"|"VARBYTE"|"BINARY"|"BYTE"|"CHARACTER"|"DOUBLE"|"FLOAT"|"INT"|"LONG"|"NUMERIC"|"SHORT"|"STRING"|"TIMESTAMP_LTZ"|"TIMESTAMP_NTZ"|"TINYINT",
    "defaultValue": "string"
  }
  ...
]

--schema (структура)

Отношение в рамках анализа.

referencedTables -> (список)

Таблицы, на которые ссылается схема анализа.

(строка)

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

referencedTables=string,string

Синтаксис JSON:

{
  "referencedTables": ["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.

Вывод

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

Шаблон анализа.

id -> (строка)

Идентификатор шаблона анализа.

arn -> (строка)

Amazon Resource Name (ARN) шаблона анализа.

collaborationId -> (строка)

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

collaborationArn -> (строка)

Уникальный ARN для связанного сотрудничества шаблона анализа.

membershipId -> (строка)

Идентификатор участника, создавшего шаблон анализа.

membershipArn -> (строка)

Amazon Resource Name (ARN) участника, создавшего шаблон анализа.

description -> (строка)

Описание шаблона анализа.

name -> (строка)

Имя шаблона анализа.

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

Время создания шаблона анализа.

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

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

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

Весь объект схемы.

referencedTables -> (список)

Таблицы, на которые ссылается схема анализа.

(строка)

format -> (строка)

Формат шаблона анализа.

source -> (структура со структурированным объединением)

Источник шаблона анализа.

Примечание

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

text -> (строка)

Текст запроса.

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

Артефакты источника анализа.

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

Точка входа для артефактов шаблона анализа.

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

Расположение артефакта.

bucket -> (строка)

Имя ведра.

key -> (строка)

Ключ объекта.

additionalArtifacts -> (список)

Дополнительные артефакты для шаблона анализа.

(структура)

Артефакт шаблона анализа.

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

Расположение артефакта.

bucket -> (строка)

Имя ведра.

key -> (строка)

Ключ объекта.

roleArn -> (строка)

ARN роли для артефактов шаблона анализа.

sourceMetadata -> (структура со структурированным объединением)

Метаданные источника для шаблона анализа.

Примечание

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

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

Артефакты метаданных источника анализа.

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

Хэш точки входа для метаданных артефакта шаблона анализа.

sha256 -> (строка)

Значение хэша SHA-256.

additionalArtifactHashes -> (список)

Дополнительные хэши артефактов для шаблона анализа.

(структура)

Хэш

sha256 -> (строка)

Значение хэша SHA-256.

analysisParameters -> (список)

Параметры шаблона анализа.

(структура)

Необязательно. Участник, который может выполнять запрос, может предоставить этот заполнитель для значения данных в шаблоне анализа.

name -> (строка)

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

type -> (строка)

Тип параметра.

defaultValue -> (строка)

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

validations -> (список)

Информация о валидации, выполненной для шаблона анализа.

(структура)

Подробности состояния валидации шаблона анализа. Clean Rooms Differential Privacy использует структуру универсального запроса для поддержки сложных SQL-запросов и проверяет, соответствует ли шаблон анализа этой структуре универсального запроса. Проверка выполняется при создании и получении шаблонов анализа. Поскольку шаблоны анализа неизменяемы по своему дизайну, мы рекомендуем создавать шаблоны анализа после того, как вы свяжете настроенные таблицы с правилом анализа для вашего сотрудничества.

Дополнительную информацию можно найти по адресу https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy .

type -> (строка)

Тип проверки, который был выполнен.

status -> (строка)

Статус проверки.

reasons -> (список)

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

(структура)

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

message -> (строка)

Сообщение проверки.

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

Spec-Zone.ru

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