get-journey-date-range-kpi
Описание
Извлекает (запрашивает) предварительно агрегированные данные для стандартной метрики вовлечения, применимой к этапу.
См. также: Документацию API AWS
Синтаксис
get-journey-date-range-kpi
--application-id <value>
[--end-time <value>]
--journey-id <value>
--kpi-name <value>
[--next-token <value>]
[--page-size <value>]
[--start-time <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]
Параметры
--application-id (строка)
--end-time (метка времени)
--journey-id (строка)
--kpi-name (строка)
--next-token (строка)
--page-size (строка)
--start-time (метка времени)
--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.
Вывод
JourneyDateRangeKpiResponse -> (структура)
Предоставляет результаты запроса, который извлек данные для стандартной метрики вовлечения, применимой к этапу, и предоставляет информацию об этом запросе.
ApplicationId -> (строка)
EndTime -> (метка времени)
JourneyId -> (строка)
KpiName -> (строка)
KpiResult -> (структура)
Массив объектов, содержащий результаты запроса. Каждый объект содержит значение для метрики и метаданные об этом значении.
Rows -> (список)
Массив объектов, предоставляющий результаты запроса, извлекающего данные для стандартной метрики, применимой к приложению, кампании или этапу.
(структура)
Предоставляет результаты запроса, который извлек данные для стандартной метрики, применимой к приложению, кампании или этапу.
GroupedBys -> (список)
Массив объектов, определяющий поле и значения поля, которые использовались для группировки данных в наборе результатов, содержащем несколько результатов. Это значение равно null, если данные в наборе результатов не сгруппированы.
(структура)
Предоставляет одно значение и метаданные об этом значении в рамках массива результатов запроса для стандартной метрики, применимой к приложению, кампании или этапу.
Key -> (строка)
Type -> (строка)
Value -> (строка)
Values -> (список)
Массив объектов, предоставляющий предварительно агрегированные значения для стандартной метрики, применимой к приложению, кампании или этапу.
(структура)
Предоставляет одно значение и метаданные об этом значении в рамках массива результатов запроса для стандартной метрики, применимой к приложению, кампании или этапу.
Key -> (строка)
Type -> (строка)
Value -> (строка)
NextToken -> (строка)
StartTime -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.