Spec-Zone.ru › AWS CLI v2

[ aws . cleanrooms ]

update-protected-query

Описание

Обновляет обработку текущего запроса.

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

Синтаксис

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

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

--target-status (строка)

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

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

  • CANCELLED

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить вывод цветного текста.

  • on
  • off
  • auto

--no-sign-request (логическое)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки config/env.

--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 Resource Name (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 -> (двойное)

Количество часов использования Чистых комнатных процессорных единиц (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