put-events
Описание
Создает новое событие для записи для конечных точек или создает или обновляет данные конечной точки, с которыми связаны существующие события.
См. также: Документация AWS API
Синтаксис
put-events
--application-id <value>
--events-request <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 (строка)
--events-request (структура)
Указывает пакет событий для обработки.
BatchItem -> (массив)
Пакет событий для обработки. Для каждого элемента в пакете идентификатор конечной точки выступает в качестве ключа, значением которого является объект EventsBatch.
ключ -> (строка)
значение -> (структура)
Указывает пакет конечных точек и событий для обработки.
Endpoint -> (структура)
Набор свойств и атрибутов, связанных с конечной точкой.
Адрес -> (строка)
Атрибуты -> (массив)
Один или несколько пользовательских атрибутов, описывающих конечную точку путем связывания имени с массивом значений. Вы можете использовать эти атрибуты в качестве критериев фильтра при создании сегментов.
ключ -> (строка)
значение -> (список)
Тип канала -> (строка)
Демографические данные -> (структура)
Демографическая информация для конечной точки, например, часовой пояс и платформа.
Версия приложения -> (строка)
Язык -> (строка)
Производитель -> (строка)
Модель -> (строка)
Версия модели -> (строка)
Платформа -> (строка)
Версия платформы -> (строка)
Часовой пояс -> (строка)
Дата вступления в силу -> (строка)
Статус конечной точки -> (строка)
Указывает, отправлять ли сообщения или push-уведомления на конечную точку. Допустимые значения: ACTIVE (сообщения отправляются на конечную точку) и INACTIVE (сообщения не отправляются на конечную точку).
Amazon Pinpoint автоматически устанавливает это значение в ACTIVE при создании конечной точки или обновлении существующей конечной точки. Amazon Pinpoint автоматически устанавливает это значение в INACTIVE, если вы обновите другую конечную точку, у которой указан тот же адрес, определенный свойством Address.
Расположение -> (структура)
Географическая информация для конечной точки.
Город -> (строка)
Страна -> (строка)
Широта -> (дробное число)
Долгота -> (дробное число)
Почтовый индекс -> (строка)
Регион -> (строка)
Метрики -> (массив)
Один или несколько пользовательских метрик, которые ваше приложение отправляет в Amazon Pinpoint для конечной точки.
ключ -> (строка)
значение -> (дробное число)
Отказ от подписки -> (строка)
Идентификатор запроса -> (строка)
Пользователь -> (структура)
Один или несколько пользовательских атрибутов пользователя, которые ваше приложение отправляет в Amazon Pinpoint для пользователя, связанного с конечной точкой.
Атрибуты пользователя -> (массив)
Один или несколько пользовательских атрибутов, описывающих пользователя путем связывания имени с массивом значений. Например, значение атрибута с именем Interests может быть: [“Наука”, “Музыка”, “Путешествия”]. Вы можете использовать эти атрибуты в качестве критериев фильтра при создании сегментов. Имена атрибутов чувствительны к регистру.
Имя атрибута может содержать до 50 символов. Значение атрибута может содержать до 100 символов. При определении имени пользовательского атрибута избегайте использования следующих символов: решётка (#), двоеточие (:), знак вопроса (?), обратный слэш () и слэш (/). Консоль Amazon Pinpoint не может отображать имена атрибутов, содержащие эти символы. Это ограничение не относится к значениям атрибутов.
ключ -> (строка)
значение -> (список)
Идентификатор пользователя -> (строка)
Events -> (массив)
Набор свойств, связанных с событием.
ключ -> (строка)
значение -> (структура)
Указывает информацию о событии, которое отправляет данные в Amazon Pinpoint.
Пакетное имя приложения -> (строка)
Название приложения -> (строка)
Код версии приложения -> (строка)
Атрибуты -> (массив)
Один или несколько пользовательских атрибутов, связанных с событием.
ключ -> (строка)
значение -> (строка)
Версия SDK клиента -> (строка)
Тип события -> (строка)
Метрики -> (массив)
Один или несколько пользовательских метрик, связанных с событием.
ключ -> (строка)
значение -> (дробное число)
Название SDK -> (строка)
Сессия -> (структура)
Информация о сессии, в которой произошло событие.
Продолжительность -> (целое число)
Идентификатор -> (строка)
Время начала -> (строка)
Время окончания -> (строка)
Отметка времени -> (строка)
Синтаксис JSON:
{
"BatchItem": {"string": {
"Endpoint": {
"Address": "string",
"Attributes": {"string": ["string", ...]
...},
"ChannelType": "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP",
"Demographic": {
"AppVersion": "string",
"Locale": "string",
"Make": "string",
"Model": "string",
"ModelVersion": "string",
"Platform": "string",
"PlatformVersion": "string",
"Timezone": "string"
},
"EffectiveDate": "string",
"EndpointStatus": "string",
"Location": {
"City": "string",
"Country": "string",
"Latitude": double,
"Longitude": double,
"PostalCode": "string",
"Region": "string"
},
"Metrics": {"string": double
...},
"OptOut": "string",
"RequestId": "string",
"User": {
"UserAttributes": {"string": ["string", ...]
...},
"UserId": "string"
}
},
"Events": {"string": {
"AppPackageName": "string",
"AppTitle": "string",
"AppVersionCode": "string",
"Attributes": {"string": "string"
...},
"ClientSdkVersion": "string",
"EventType": "string",
"Metrics": {"string": double
...},
"SdkName": "string",
"Session": {
"Duration": integer,
"Id": "string",
"StartTimestamp": "string",
"StopTimestamp": "string"
},
"Timestamp": "string"
}
...}
}
...}
}
--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 (boolean)
Включить отладку регистрации.
--endpoint-url (string)
Переопределить адрес по умолчанию команды заданным адресом.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определенный профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическую запрос параметров ввода CLI.
Вывод
EventsResponse -> (структура)
Предоставляет информацию об конечных точках и событиях, с ними связанных.
Results -> (массив)
Массив, содержащий многочастьный ответ для каждой конечной точки. Для каждого элемента в этом объекте идентификатор конечной точки является ключом, а ответ элемента является значением. Если ответ элемента отсутствует, значение может также быть одним из следующих: 202, запрос был успешно обработан; или 400, полезная нагрузка не была валидной или отсутствовали необходимые поля.
key -> (строка)
value -> (структура)
Предоставляет информацию о результатах запроса на создание или обновление конечной точки, связанной с событием.
EndpointItemResponse -> (структура)
Ответ, полученный после принятия данных конечной точки.
Message -> (строка)
StatusCode -> (целое число)
EventsItemResponse -> (массив)
Объект многочастного ответа, содержащий ключ и значение для каждого события в запросе. В каждом объекте идентификатор события является ключом, а объект EventItemResponse является значением.
key -> (строка)
value -> (структура)
Предоставляет код состояния и сообщение, полученные в результате обработки события.
Message -> (строка)
StatusCode -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.