Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

get-snapshots

Описание

Получает данные метрик поиска. Данные предоставляют моментальный снимок того, как ваши пользователи взаимодействуют с вашим приложением поиска и насколько эффективно работает это приложение.

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

Синтаксис

  get-snapshots
--index-id <value>
--interval <value>
--metric-type <value>
[--next-token <value>]
[--max-results <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]

Параметры

--index-id (строка)

Идентификатор индекса, для которого нужно получить данные метрик поиска.

--interval (строка)

Интервал или временной диапазон для получения данных метрик поиска. Интервал времени использует часовой пояс вашего индекса. Вы можете просматривать данные в следующих временных диапазонах:

  • THIS_WEEK : Текущая неделя, начиная с воскресенья и заканчивая днём перед текущей датой.
  • ONE_WEEK_AGO : Предыдущая неделя, начиная с воскресенья и заканчивая следующим субботним днём.
  • TWO_WEEKS_AGO : Неделя до предыдущей, начиная с воскресенья и заканчивая следующим субботним днём.
  • THIS_MONTH : Текущий месяц, начиная с первого числа и заканчивая днём перед текущей датой.
  • ONE_MONTH_AGO : Предыдущий месяц, начиная с первого числа и заканчивая последним днём месяца.
  • TWO_MONTHS_AGO : Месяц до предыдущего, начиная с первого числа и заканчивая последним днём месяца.

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

  • THIS_MONTH
  • THIS_WEEK
  • ONE_WEEK_AGO
  • TWO_WEEKS_AGO
  • ONE_MONTH_AGO
  • TWO_MONTHS_AGO

--metric-type (строка)

Метрика, которую вы хотите получить. Вы можете указать только одну метрику за один вызов.

Для получения дополнительной информации о метриках, которые вы можете просмотреть, см. Получение информации с помощью аналитики поиска.

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

  • QUERIES_BY_COUNT
  • QUERIES_BY_ZERO_CLICK_RATE
  • QUERIES_BY_ZERO_RESULT_RATE
  • DOCS_BY_CLICK_COUNT
  • AGG_QUERY_DOC_METRICS
  • TREND_QUERY_DOC_METRICS

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

Если предыдущий ответ был неполным (потому что есть больше данных для извлечения), Amazon Kendra возвращает маркер пагинации в ответе. Вы можете использовать этот маркер пагинации для получения следующего набора данных метрик поиска.

--max-results (целое число)

Максимальное количество возвращаемых данных для метрики.

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

Вывод

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

Маркер Unix для начала и конца временного интервала для данных метрик поиска.

StartTime -> (временная метка)

Маркер Unix для начала временного диапазона.

EndTime -> (временная метка)

Маркер Unix для конца временного диапазона.

SnapshotsDataHeader -> (список)

Заголовки столбцов для данных метрик поиска.

(строка)

SnapshotsData -> (список)

Данные метрик поиска. Возвращаемые данные зависят от типа запрошенной метрики.

(список)

(строка)

NextToken -> (строка)

Если ответ усечён, Amazon Kendra возвращает этот маркер, который можно использовать в последующем запросе для извлечения следующего набора данных метрик поиска.

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

Spec-Zone.ru

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