Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

update-endpoint

Описание

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

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

Синтаксис

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

Уникальный, регистронезависимый идентификатор конечного пункта. Идентификатор не может содержать $ , { или } .

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

Указывает тип канала и другие настройки для конечного пункта.

Address -> (строка)

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

Attributes -> (карта)

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

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

key -> (строка)

value -> (список)

(строка)

ChannelType -> (строка)

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

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

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

AppVersion -> (строка)

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

Locale -> (строка)

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

Make -> (строка)

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

Model -> (строка)

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

ModelVersion -> (строка)

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

Platform -> (строка)

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

PlatformVersion -> (строка)

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

Timezone -> (строка)

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

EffectiveDate -> (строка)

Дата и время обновления конечного пункта в формате ISO 8601.

EndpointStatus -> (строка)

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

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

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

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

City -> (строка)

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

Country -> (строка)

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

Latitude -> (вещественное число двойной точности)

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

Longitude -> (вещественное число двойной точности)

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

PostalCode -> (строка)

Почтовый индекс района, где находится конечный пункт.

Region -> (строка)

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

Metrics -> (карта)

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

key -> (строка)

value -> (вещественное число двойной точности)

OptOut -> (строка)

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

RequestId -> (строка)

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

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

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

UserAttributes -> (карта)

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

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

key -> (строка)

value -> (список)

(строка)

UserId -> (строка)

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

Упрощенный синтаксис:

Address=string,Attributes={KeyName1=string,string,KeyName2=string,string},ChannelType=string,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={KeyName1=double,KeyName2=double},OptOut=string,RequestId=string,User={UserAttributes={KeyName1=[string,string],KeyName2=[string,string]},UserId=string}

Синтаксис JSON:

{
  "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"
  }
}

--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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическую запрос параметров ввода CLI.

Вывод

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

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

Message -> (строка)

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

RequestID -> (строка)

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

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

Spec-Zone.ru

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