Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

batch-get-collaboration-analysis-template

Описание

Получает несколько шаблонов анализа в рамках сотрудничества по их именам Amazon Resource Name (ARN).

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

Синтаксис

  batch-get-collaboration-analysis-template
--collaboration-identifier <value>
--analysis-template-arns <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-arns (список)

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

(строка)

Синтаксис:

"string" "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.

Вывод

collaborationAnalysisTemplates -> (список)

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

(структура)

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

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 -> (строка)

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

errors -> (список)

Причины ошибок для шаблонов анализа сотрудничества, которые не удалось получить. Одна ошибка возвращается для каждого шаблона анализа сотрудничества, который не удалось получить.

(структура)

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

arn -> (строка)

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

code -> (строка)

Код ошибки.

message -> (строка)

Описание причины неудачи вызова.

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

Spec-Zone.ru

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