Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-journey-run-execution-activity-metrics

Описание

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

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

Синтаксис

  get-journey-run-execution-activity-metrics
--application-id <value>
--journey-activity-id <value>
--journey-id <value>
[--next-token <value>]
[--page-size <value>]
--run-id <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 (строка)

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

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

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

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

Вывод

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

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

ActivityType -> (строка)

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

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

ApplicationId -> (строка)

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

JourneyActivityId -> (строка)

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

JourneyId -> (строка)

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

LastEvaluatedTime -> (строка)

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

Metrics -> (массив)

Объект JSON, содержащий результаты запроса. Для получения информации о структуре и содержимом результатов см. Стандартные аналитические метрики Amazon Pinpoint в Руководстве разработчика Amazon Pinpoint.

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

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

RunId -> (строка)

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

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

Spec-Zone.ru

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