Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

получение-данных-kpi-приложения-за-диапазон-дат

Описание

Получает (запрашивает) предварительно агрегированные данные для стандартного показателя, применимого к приложению.

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

Синтаксис

  get-application-date-range-kpi
--application-id <value>
[--end-time <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 (строка)

Уникальный идентификатор приложения. Этот идентификатор отображается как Идентификатор проекта на консоли Amazon Pinpoint.

--end-time (метка времени)

Последняя дата и время для получения данных в рамках инклюзивного диапазона дат, который фильтрует результаты запроса. Это значение должно быть в расширенном формате ISO 8601 и использовать Coordinated Universal Time (UTC), например: 2019-07-26T20:00:00Z для 20:00 UTC 26 июля 2019 года.

--kpi-name (строка)

Имя показателя, также называемого ключевым показателем эффективности (KPI), для которого необходимо получить данные. Это значение описывает связанный показатель и состоит из двух или более терминов, состоящих из строчных букв латинского алфавита и цифр, разделенных дефисом. Примеры: email-open-rate и successful-delivery-rate. Список допустимых значений см. в Руководстве разработчика Amazon Pinpoint.

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

Строка, определяющая, какую страницу результатов вернуть в случае многостраничного ответа. Этот параметр не поддерживается для показателей приложений, кампаний и маршрутов.

--page-size (строка)

Максимальное количество элементов на каждой странице многостраничного ответа. Этот параметр не поддерживается для показателей приложений, кампаний и маршрутов.

--start-time (метка времени)

Первая дата и время для получения данных в рамках инклюзивного диапазона дат, который фильтрует результаты запроса. Это значение должно быть в расширенном формате ISO 8601 и использовать Coordinated Universal Time (UTC), например: 2019-07-19T20:00:00Z для 20:00 UTC 19 июля 2019 года. Это значение также должно быть меньше 90 дней с текущего дня.

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

Вывод

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

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

ApplicationId -> (строка)

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

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

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

KpiName -> (строка)

Имя показателя, также называемого ключевым показателем эффективности (KPI), для которого были получены данные. Это значение описывает связанный показатель и состоит из двух или более терминов, состоящих из строчных букв латинского алфавита и цифр, разделенных дефисом. Список возможных значений см. в Руководстве разработчика Amazon Pinpoint.

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

Массив объектов, содержащих результаты запроса. Каждый объект содержит значение показателя и метаданные об этом значении.

Rows -> (список)

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

(структура)

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

GroupedBys -> (список)

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

(структура)

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

Key -> (строка)

Дружественное имя показателя, значение которого указано свойством Value.

Type -> (строка)

Тип данных значения, указанного свойством Value.

Value -> (строка)

В объекте Values — значение показателя, для которого запрос получил данные. В объекте GroupedBys — значение поля, используемого для группировки данных в наборе результатов, содержащем несколько результатов (объекты Values).

Values -> (список)

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

(структура)

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

Key -> (строка)

Дружественное имя показателя, значение которого указано свойством Value.

Type -> (строка)

Тип данных значения, указанного свойством Value.

Value -> (строка)

В объекте Values — значение показателя, для которого запрос получил данные. В объекте GroupedBys — значение поля, используемого для группировки данных в наборе результатов, содержащем несколько результатов (объекты Values).

NextToken -> (строка)

Строка для использования в последующем запросе для получения следующей страницы результатов в многостраничном ответе. Это значение равно null для ресурса Application Metrics, так как ресурс возвращает все результаты на одной странице.

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

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

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

Spec-Zone.ru

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