Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

получение-шаблона-анализа-сотрудничества

Описание

Получает шаблон анализа в рамках сотрудничества.

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

Синтаксис

  get-collaboration-analysis-template
--collaboration-identifier <value>
--analysis-template-arn <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 (строка)

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

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

Amazon Resource Name (ARN), связанный с шаблоном анализа в рамках сотрудничества.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Вывод

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

Шаблон анализа в рамках сотрудничества.

id -> (строка)

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

arn -> (строка)

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

collaborationId -> (строка)

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

collaborationArn -> (строка)

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

description -> (строка)

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

creatorAccountId -> (строка)

Идентификатор, используемый для ссылки на участников сотрудничества. В настоящее время поддерживается только идентификатор учетной записи Amazon Web Services.

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