Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

создать-регистрацию-push-уведомлений

Описание

Создает регистрацию для маркера устройства и контакта чата для получения push-уведомлений в реальном времени. Дополнительную информацию о push-уведомлениях см. в разделе Настройка push-уведомлений в Amazon Connect для мобильного чата в руководстве администратора Amazon Connect.

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

Синтаксис

  create-push-notification-registration
--instance-id <value>
[--client-token <value>]
--pinpoint-app-arn <value>
--device-token <value>
--device-type <value>
--contact-configuration <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]

Параметры

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

Идентификатор экземпляра Amazon Connect. Вы можете найти идентификатор экземпляра в имени ресурса Amazon (ARN) экземпляра.

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указано, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API.

--pinpoint-app-arn (строка)

Имя ресурса Amazon (ARN) приложения Pinpoint.

--device-token (строка)

Маркер push-уведомления, выпущенный шлюзами Apple или Google.

--device-type (строка)

Тип устройства для отправки сообщения.

Возможные значения:

  • GCM
  • APNS
  • APNS_SANDBOX

--contact-configuration (структура)

Настройка контакта для регистрации push-уведомлений.

ContactId -> (строка)

Идентификатор контакта в экземпляре Amazon Connect.

ParticipantRole -> (строка)

Роль участника в чате.

Примечание

В настоящее время поддерживается только CUSTOMER. Любые другие значения, кроме CUSTOMER, приведут к исключению (ошибка 4xx).

IncludeRawMessage -> (булево)

Включать ли исходное сообщение Connect в полезной нагрузке push-уведомления. По умолчанию - False.

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

ContactId=string,ParticipantRole=string,IncludeRawMessage=boolean

Синтаксис JSON:

{
  "ContactId": "string",
  "ParticipantRole": "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
  "IncludeRawMessage": true|false
}

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

Вывод

RegistrationId -> (строка)

Идентификатор регистрации.

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

Spec-Zone.ru

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