Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

получить-шаблон-анализа

Описание

Извлекает шаблон анализа.

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

Синтаксис

  get-analysis-template
--membership-identifier <value>
--analysis-template-identifier <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]

Параметры

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

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

--analysis-template-identifier (строка)

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

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