Spec-Zone.ru › AWS CLI v2

[ aws . sns ]

создать-точку-подключения-платформы

Описание

Создает точку подключения для устройства и мобильного приложения в одной из поддерживаемых служб push-уведомлений, таких как GCM (Firebase Cloud Messaging) и APNS. CreatePlatformEndpoint требует PlatformApplicationArn, возвращаемого из CreatePlatformApplication. Вы можете использовать возвращённую EndpointArn для отправки сообщения мобильному приложению или с помощью действия Subscribe для подписки на тему. Действие CreatePlatformEndpoint идемпотентно, поэтому, если запрашивающий уже владеет точкой подключения с тем же токеном устройства и атрибутами, ARN этой точки подключения возвращается без создания новой точки подключения. Более подробная информация приведена в разделе Использование мобильных push-уведомлений Amazon SNS .

При использовании CreatePlatformEndpoint с Baidu необходимо указать два атрибута: ChannelId и UserId. Поле token также должно содержать ChannelId. Более подробная информация приведена в разделе Создание точки подключения Amazon SNS для Baidu .

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

Синтаксис

  create-platform-endpoint
--platform-application-arn <value>
--token <value>
[--custom-user-data <value>]
[--attributes <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]

Параметры

--platform-application-arn (строка)

PlatformApplicationArn, возвращаемый из CreatePlatformApplication, используется для создания точки подключения.

--token (строка)

Уникальный идентификатор, созданный службой уведомлений для приложения на устройстве. Конкретное имя для Token будет различаться в зависимости от используемой службы уведомлений. Например, при использовании APNS в качестве службы уведомлений вам нужен токен устройства. В альтернативе, при использовании GCM (Firebase Cloud Messaging) или ADM, эквивалент токена устройства называется идентификатором регистрации.

--custom-user-data (строка)

Произвольные данные пользователя для ассоциации с точкой подключения. Amazon SNS не использует эти данные. Данные должны быть в формате UTF-8 и иметь размер менее 2 КБ.

--attributes (массив)

Список атрибутов см. в ` SetEndpointAttributes https://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html`__ .

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

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

Сокращенная запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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 для вывода.

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

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

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Более подробная информация приведена в руководстве по началу работы в Руководстве пользователя AWS CLI.

За исключением случаев, когда указано иное, все примеры имеют правила цитирования unix-подобных систем. Эти примеры потребуют адаптации к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для создания точки подключения платформенного приложения

Следующий пример create-platform-endpoint создает точку подключения для указанного платформенного приложения с использованием указанного токена.

aws sns create-platform-endpoint \
    --platform-application-arn arn:aws:sns:us-west-2:123456789012:app/GCM/MyApplication \
    --token EXAMPLE12345...

Вывод:

{
      "EndpointArn": "arn:aws:sns:us-west-2:1234567890:endpoint/GCM/MyApplication/12345678-abcd-9012-efgh-345678901234"
}

Вывод

EndpointArn -> (строка)

EndpointArn, возвращаемый действием CreateEndpoint.

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

Spec-Zone.ru

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