Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-campaign-activities

Описание

Получает информацию обо всех активностях для кампании.

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

Синтаксис

  get-campaign-activities
--application-id <value>
--campaign-id <value>
[--page-size <value>]
[--token <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.

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

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

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

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

--token (строка)

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Вывод

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

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

Item -> (список)

Массив ответов, по одному для каждой активности, выполненной кампанией.

(структура)

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

ApplicationId -> (строка)

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

CampaignId -> (строка)

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

End -> (строка)

Фактическое время, в формате ISO 8601, когда активность была помечена как CANCELLED или COMPLETED.

Id -> (строка)

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

Result -> (строка)

Указывает, успешно ли прошла активность. Возможные значения — SUCCESS и FAIL.

ScheduledStart -> (строка)

Распланированное время начала активности, в формате ISO 8601.

Start -> (строка)

Фактическое время начала активности, в формате ISO 8601.

State -> (строка)

Текущий статус активности. Возможные значения: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED и COMPLETED.

SuccessfulEndpointCount -> (целое число)

Общее количество конечных точек, которым кампания успешно доставила сообщения.

TimezonesCompletedCount -> (целое число)

Общее количество часовых поясов, которые были завершены.

TimezonesTotalCount -> (целое число)

Общее количество уникальных часовых поясов в сегменте кампании.

TotalEndpointCount -> (целое число)

Общее количество конечных точек, которым кампания пыталась доставить сообщения.

TreatmentId -> (строка)

Уникальный идентификатор варианта кампании, к которому относится активность. Вариант — это вариация кампании, используемой для A/B-тестирования кампании.

ExecutionMetrics -> (массив)

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

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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