Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

put-query-definition

Описание

Создаёт или обновляет определение запроса для CloudWatch Logs Insights. Дополнительную информацию см. в разделе Анализ данных журналов с помощью CloudWatch Logs Insights.

Чтобы обновить определение запроса, укажите его queryDefinitionId в своём запросе. Значения name , queryString и logGroupNames изменятся на значения, указанные вами в операции обновления. Текущие значения из текущего определения запроса не сохраняются. Например, представьте, что вы обновляете текущее определение запроса, включающее группы журналов. Если вы не укажете параметр logGroupNames в своей операции обновления, определение запроса изменится, и он не будет содержать групп журналов.

Для выполнения этой операции необходимо разрешение logs:PutQueryDefinition.

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

Синтаксис

  put-query-definition
[--query-language <value>]
--name <value>
[--query-definition-id <value>]
[--log-group-names <value>]
--query-string <value>
[--client-token <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]

Параметры

--query-language (строка)

Укажите язык запросов для этого запроса. Доступные варианты: Logs Insights QL, OpenSearch PPL и OpenSearch SQL. Дополнительную информацию о языках запросов, поддерживаемых CloudWatch Logs, см. в разделе Поддерживаемые языки запросов.

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

  • CWLI
  • SQL
  • PPL

--name (строка)

Имя для определения запроса. При сохранении нескольких определений запросов рекомендуется давать им имена. Таким образом, вы сможете найти нужные вам определения, используя первую часть имени в качестве фильтра в параметре queryDefinitionNamePrefix операции DescribeQueryDefinitions.

--query-definition-id (строка)

Если вы обновляете определение запроса, используйте этот параметр для указания идентификатора определения запроса, которое вы хотите обновить. Вы можете использовать DescribeQueryDefinitions для получения идентификаторов сохранённых определений запросов.

Если вы создаёте определение запроса, не указывайте этот параметр. CloudWatch сгенерирует уникальный идентификатор для нового определения запроса и включит его в ответ на эту операцию.

--log-group-names (список)

Используйте этот параметр, чтобы включить определённые группы журналов в состав вашего определения запроса. Если ваш запрос использует язык запросов OpenSearch Service, укажите имена групп журналов внутри querystring, а не здесь.

Если вы обновляете существующее определение запроса для Logs Insights QL или OpenSearch Service PPL и опускаете этот параметр, обновлённое определение не будет содержать групп журналов.

(строка)

Синтаксис:

"string" "string" ...

--query-string (строка)

Строка запроса для использования в этом определении. Дополнительную информацию см. в разделе Синтаксис запросов CloudWatch Logs Insights.

--client-token (строка)

Используется в качестве маркера идемпотентности, чтобы избежать возврата исключения, если служба получает один и тот же запрос дважды из-за ошибки сети.

--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
  • таблица
  • 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.

Вывод

queryDefinitionId -> (строка)

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

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

Spec-Zone.ru

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