Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

get-protected-query

Описание

Возвращает метаданные обработки запроса.

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

Синтаксис

  get-protected-query
--membership-identifier <value>
--protected-query-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 (строка)

Идентификатор членства в экземпляре защищенного запроса.

--protected-query-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.

Вывод

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

Метаданные обработки запроса.

id -> (строка)

Идентификатор экземпляра защищенного запроса.

membershipId -> (строка)

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

membershipArn -> (строка)

ARN членства.

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

Время создания защищенного запроса.

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

Параметры SQL защищенного запроса.

queryString -> (строка)

Строка запроса для отправки.

analysisTemplateArn -> (строка)

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

parameters -> (отображение)

Параметры SQL защищенного запроса.

key -> (строка)

value -> (строка)

status -> (строка)

Статус запроса.

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

Содержит все необходимые сведения для записи результатов запроса.

outputConfiguration -> (структура помеченных объединений)

Настройка результатов защищенного запроса.

Примечание

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

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

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

resultFormat -> (строка)

Предполагаемый формат файла результата.

bucket -> (строка)

Ведро S3 для выгрузки результатов защищенного запроса.

keyPrefix -> (строка)

Префикс S3 для выгрузки результатов защищенного запроса.

singleFileOutput -> (булево)

Указывает, следует ли выводить файлы как один файл (TRUE ) или как несколько файлов (FALSE ). Этот параметр поддерживается только для анализов с аналитическим движком Spark.

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

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

accountId -> (строка)

Уникальный идентификатор учетной записи.

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

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

locations -> (список)

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

Предупреждение

Нельзя указать более одного расположения S3.

Нельзя указать учетную запись исполнителя запроса в качестве расположения участника.

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

(структура помеченных объединений)

Указывает, где будут распространяться результаты защищенного запроса. Необходимо настроить либо назначение S3, либо назначение участника сотрудничества.

Примечание

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

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

Содержит конфигурацию для записи результатов запроса в S3.

resultFormat -> (строка)

Предполагаемый формат файла результата.

bucket -> (строка)

Ведро S3 для выгрузки результатов защищенного запроса.

keyPrefix -> (строка)

Префикс S3 для выгрузки результатов защищенного запроса.

singleFileOutput -> (булево)

Указывает, следует ли выводить файлы как один файл (TRUE ) или как несколько файлов (FALSE ). Этот параметр поддерживается только для анализов с аналитическим движком Spark.

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

Содержит сведения о конфигурации вывода участника защищенного запроса.

accountId -> (строка)

Уникальный идентификатор учетной записи.

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

Статистика выполнения защищенного запроса.

totalDurationInMillis -> (длинное целое число)

Продолжительность защищенного запроса с момента создания до завершения в миллисекундах.

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

Использованные ресурсы с учетом оплаты.

units -> (вещественное число)

Количество часов, начисленных за использование единиц обработки Clean Rooms (CRPU).

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

Результат защищенного запроса.

output -> (структура помеченных объединений)

Вывод защищенного запроса.

Примечание

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

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

Если присутствует, вывод для защищенного запроса с S3 типом вывода.

location -> (строка)

Расположение результата в S3.

memberList -> (список)

Список учетных записей Amazon Web Services участников, которые получили результаты запроса.

(структура)

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

accountId -> (строка)

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

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

Содержит сведения о выводе для защищенных запросов, которые используют distribute тип вывода. Этот тип вывода позволяет отправлять результаты запроса в несколько расположений — либо в S3, либо участникам сотрудничества.

Примечание

Тип вывода distribute можно использовать только с аналитическим движком Spark.

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

Содержит сведения о выводе для защищенных запросов с типом вывода S3.

location -> (строка)

Расположение результата в S3.

memberList -> (список)

Содержит результаты вывода для каждого указанного в конфигурации вывода distribute расположения участника. Каждая запись предоставляет сведения о распределении результата конкретному участнику сотрудничества.

(структура)

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

accountId -> (строка)

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

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

Ошибка, выброшенная защищенным запросом.

message -> (строка)

Описание причины сбоя запроса.

code -> (строка)

Код ошибки.

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

Параметры чувствительности результатов защищенного запроса с дифференциальной конфиденциальностью.

sensitivityParameters -> (список)

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

(структура)

Предоставляет параметры чувствительности.

aggregationType -> (строка)

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

aggregationExpression -> (строка)

Выражение агрегирования, которое было запущено.

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

Максимальное количество строк, внесенных пользователем в запросе SQL.

minColumnValue -> (вещественное число)

Нижняя граница выражения агрегирования.

maxColumnValue -> (вещественное число)

Верхняя граница выражения агрегирования.

computeConfiguration -> (структура помеченных объединений)

Конфигурация вычислений для защищенного запроса.

Примечание

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

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

Конфигурация исполнителя для среды вычислений.

type -> (строка)

Тип конфигурации исполнителя вычислений.

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

Количество исполнителей.

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

Spec-Zone.ru

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