Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

update-endpoints-batch

Описание

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

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

Синтаксис

  update-endpoints-batch
--application-id <value>
--endpoint-batch-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 (строка)

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

--endpoint-batch-request (структура)

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

Элемент -> (список)

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

(структура)

Указывает конечную точку для создания или обновления, а также настройки и атрибуты для установки или изменения для конечной точки.

Адрес -> (строка)

Адрес назначения сообщений или push-уведомлений, которые вы отправляете на конечную точку. Адрес зависит от канала. Для канала push-уведомлений используйте токен, предоставленный службой push-уведомлений, например, токен устройства службы Apple Push Notification Service (APNs) или токен регистрации Firebase Cloud Messaging (FCM). Для канала SMS используйте номер телефона в формате E.164, например +12065550100. Для канала электронной почты используйте адрес электронной почты.

Атрибуты -> (карта)

Один или несколько пользовательских атрибутов, описывающих конечную точку, связывая имя с массивом значений. Например, значение пользовательского атрибута с именем Interests может быть: [“Наука”, “Музыка”, “Путешествия”]. Вы можете использовать эти атрибуты в качестве критериев фильтрации при создании сегментов. Имена атрибутов чувствительны к регистру.

Имя атрибута может содержать до 50 символов. Значение атрибута может содержать до 100 символов. При определении имени пользовательского атрибута избегайте использования следующих символов: диез (#), двоеточие (:), знак вопроса (?), обратная косая черта (\) и косая черта (/). Консоль Amazon Pinpoint не может отобразить имена атрибутов, содержащие эти символы. Это ограничение не относится к значениям атрибутов.

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

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

(строка)

ТипКанала -> (строка)

Канал, используемый при отправке сообщений или push-уведомлений на конечную точку.

Демографическиеданные -> (структура)

Демографическая информация для конечной точки, такая как часовой пояс и платформа.

ВерсияПриложения -> (строка)

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

Локаль -> (строка)

Локаль конечной точки в следующем формате: двухбуквенный код ISO 639-1, за которым следует знак подчеркивания (_), за которым следует двухбуквенный код ISO 3166-1.

Производитель -> (строка)

Производитель устройства конечной точки, например apple или samsung.

Модель -> (строка)

Имя или номер модели устройства конечной точки, например iPhone или SM-G900F.

ВерсияМодели -> (строка)

Версия модели устройства конечной точки.

Платформа -> (строка)

Платформа устройства конечной точки, например ios.

ВерсияПлатформы -> (строка)

Версия платформы устройства конечной точки.

ЧасовойПояс -> (строка)

Часовой пояс конечной точки, указанный как значение базы данных tz, например America/Los_Angeles.

ДатаДействия -> (строка)

Дата и время создания или обновления конечной точки в формате ISO 8601.

СтатусКонечнойТочки -> (строка)

Указывает, отправлять ли сообщения или push-уведомления на конечную точку. Допустимые значения: ACTIVE, сообщения отправляются на конечную точку; и INACTIVE, сообщения не отправляются на конечную точку.

Amazon Pinpoint автоматически устанавливает это значение в ACTIVE при создании конечной точки или обновлении существующей конечной точки. Amazon Pinpoint автоматически устанавливает это значение в INACTIVE, если вы обновите другую конечную точку с тем же адресом, указанным свойством Address.

Идентификатор -> (строка)

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

Расположение -> (структура)

Географическая информация для конечной точки.

Город -> (строка)

Название города, в котором расположена конечная точка.

Страна -> (строка)

Двухбуквенный код ISO 3166-1 alpha-2 для страны или региона, в котором расположена конечная точка. Например, US для США.

Широта -> (двойное)

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

Долгота -> (двойное)

Координата долготы местоположения конечной точки, округлённая до одного десятичного знака.

ПочтовыйИндекс -> (строка)

Почтовый или ZIP-код района, в котором расположена конечная точка.

Регион -> (строка)

Название региона, в котором расположена конечная точка. Для местоположений в США это название штата.

Метрики -> (карта)

Один или несколько пользовательских показателей, которые ваше приложение отправляет Amazon Pinpoint для конечной точки.

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

значение -> (двойное)

Отказался -> (строка)

Указывает, отказался ли пользователь, связанный с конечной точкой, от получения сообщений и push-уведомлений от вас. Возможные значения: ALL, пользователь отказался и не хочет получать сообщения или push-уведомления; и NONE, пользователь не отказался и хочет получать все сообщения и push-уведомления.

ИдентификаторЗапроса -> (строка)

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

Пользователь -> (структура)

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

АтрибутыПользователя -> (карта)

Один или несколько пользовательских атрибутов, описывающих пользователя, связывая имя с массивом значений. Например, значение атрибута с именем Interests может быть: [“Наука”, “Музыка”, “Путешествия”]. Вы можете использовать эти атрибуты в качестве критериев фильтрации при создании сегментов. Имена атрибутов чувствительны к регистру.

Имя атрибута может содержать до 50 символов. Значение атрибута может содержать до 100 символов. При определении имени пользовательского атрибута избегайте использования следующих символов: диез (#), двоеточие (:), знак вопроса (?), обратная косая черта (\) и косая черта (/). Консоль Amazon Pinpoint не может отобразить имена атрибутов, содержащие эти символы. Это ограничение не относится к значениям атрибутов.

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

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

(строка)

ИдентификаторПользователя -> (строка)

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

Синтаксис JSON:

{
  "Item": [
    {
      "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",
      "Id": "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"
      }
    }
    ...
  ]
}

--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 (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматически

--no-sign-request (булево)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки config/env.

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

``` END_OF_DOCUMENT_MARKER

Вывод

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

Предоставляет информацию об запросе или ответе API.

Message -> (строка)

Сообщение, возвращаемое API.

RequestID -> (строка)

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

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

Spec-Zone.ru

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