Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-journey-execution-activity-metrics

Описание

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

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

Синтаксис

  get-journey-execution-activity-metrics
--application-id <value>
--journey-activity-id <value>
--journey-id <value>
[--next-token <value>]
[--page-size <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.

--journey-activity-id (строка)

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

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

Уникальный идентификатор пути.

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

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

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

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

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

Вывод

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

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

ActivityType -> (строка)

Тип задачи, к которой применяется метрика. Возможные значения:

  • CONDITIONAL_SPLIT — Для задачи разветвления да/нет, которая направляет участников по одному из двух путей в пути.
  • HOLDOUT — Для задачи holdout, которая останавливает путь для определённого процента участников.
  • MESSAGE — Для задачи отправки электронных писем, которая отправляет электронное письмо участникам.
  • MULTI_CONDITIONAL_SPLIT — Для задачи многовариантного разветвления, которая направляет участников по одному из пяти путей в пути.
  • RANDOM_SPLIT — Для задачи случайного разветвления, которая направляет определённый процент участников по одному из пяти путей в пути.
  • WAIT — Для задачи ожидания, которая ждёт определённое время или до определённой даты и времени перед перемещением участников к следующей задаче в пути.

ApplicationId -> (строка)

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

JourneyActivityId -> (строка)

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

JourneyId -> (строка)

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

LastEvaluatedTime -> (строка)

Дата и время (в формате ISO 8601), когда Amazon Pinpoint в последний раз оценил состояние выполнения задачи и обновил данные для метрики.

Metrics -> (карта)

JSON-объект, содержащий результаты запроса. Результаты зависят от типа задачи (ActivityType). Информацию о структуре и содержимом результатов см. в руководстве разработчика Amazon Pinpoint.

ключ -> (строка)

значение -> (строка)

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

Spec-Zone.ru

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