Как начать работать с Yandex Cloud Notification Service с помощью AWS CLI

Чтобы начать работу с AWS CLI:

1. Подготовьте облако к работе.
2. Получите статический ключ доступа.
3. Настройте AWS CLI.
4. Создайте канал уведомлений.
5. Получите список каналов.
6. Создайте эндпоинт.
7. Отправьте уведомление.

Подготовьте облако к работеПодготовьте облако к работе

Зарегистрируйтесь в Yandex Cloud и создайте платежный аккаунт:

1. Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь.
2. На странице Yandex Cloud Billing убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его и привяжите к нему облако.

Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака.

Подробнее об облаках и каталогах.

Получите статический ключ доступаПолучите статический ключ доступа

Для аутентификации в Cloud Notification Service используется статический ключ доступа. Этот ключ выпускается на сервисный аккаунт, и все действия выполняются от имени этого сервисного аккаунта.

Чтобы получить статический ключ доступа:

1. Создайте сервисный аккаунт.

2. Назначьте сервисному аккаунту роль editor на каталог.

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

   Сохраните идентификатор и секретный ключ.

Настройте AWS CLIНастройте AWS CLI

AWS CLI — это интерфейс командной строки для работы с сервисами AWS. HTTP API Cloud Notification Service совместим с Amazon SNS API. Общий порядок вызова команд смотрите в официальной документации Amazon.

Чтобы настроить AWS CLI:

1. Установите AWS CLI.

2. Введите команду для настройки AWS CLI:

   aws configure
   

3. Введите значения для параметров:

   • AWS Access Key ID — идентификатор статического ключа.

   • AWS Secret Access Key — секретный ключ.

   • Default region name — регион ru-central1.

     Примечание

     Для работы с Cloud Notification Service всегда указывайте регион — ru-central1. Другие значения региона могут привести к ошибке авторизации.

4. Значения остальных параметров оставьте без изменений.

5. Задайте эндпоинт Cloud Notification Service:

   aws configure set endpoint_url https://notifications.yandexcloud.net/
   

   Значение эндпоинта в настройках можно проверить командой:

   aws configure get endpoint_url
   

   Команды configure set и configure get работают с настройками в конфигурационном файле ~/.aws/config. Также можно задать параметры в переменных окружения.

   Важно

   Поскольку эндпоинт можно задать разными способами, каждый из способов имеет свой приоритет. Переменная окружения имеет больший приоритет, чем значение в файле конфигурации.

   Чтобы исключить конфликты параметров, проверьте переменную окружения с помощью команды echo $AWS_ENDPOINT_URL и параметр в конфигурации — aws configure get endpoint_url.

   Также проверьте отсутствие конфликтов в конфигурации (файл ~/.aws/credentials) с переменными окружения AWS_DEFAULT_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY.

Подробнее о настройке AWS CLI см. в документации AWS.

Создайте канал уведомленийСоздайте канал уведомлений

Чтобы создать канал уведомлений, выполните команду:

aws sns create-platform-application \
  --name <имя_канала> \
  --platform <тип_платформы> \
  --attributes <параметр1>=<значение1>, ... <параметрN>=<значениеN>

Где:

• --name — имя канала уведомлений, задается пользователем.

  Имя должно быть уникальным для всего CNS. После создания канала изменить имя нельзя. Имя может содержать строчные и заглавные буквы латинского алфавита, цифры, подчеркивания, дефисы и точки. Длина — от 1 до 256 символов. Рекомендуется для каналов APNs указывать в имени идентификатор приложения (Bundle ID), для FCM и HMS — полное название пакета приложения (Package name), для RuStore — значение packageName.

• --platform — тип мобильной платформы:

  • APNS и APNS_SANDBOX — Apple Push Notification service (APNs). Для тестирования приложения используйте APNS_SANDBOX.
  • GCM — Firebase Cloud Messaging (FCM).
  • HMS — Huawei Mobile Services (HMS).
  • RUSTORE — RuStore Android.

• --attributes — параметры аутентификации на мобильной платформе в формате <параметр>=<значение> через запятую. Значения зависят от типа платформы:

  • APNs:

    • Аутентификация с токеном:

      • PlatformPrincipal — путь к файлу с ключом подписи, полученный в Apple.
      • PlatformCredential — идентификатор ключа подписи (Key ID).
      • ApplePlatformTeamID — идентификатор разработчика (Team ID).
      • ApplePlatformBundleID — идентификатор приложения (Bundle ID).

    • Аутентификация с сертификатом:

      • PlatformPrincipal — SSL-сертификат в формате .pem.

      • PlatformCredential — закрытый ключ сертификата в формате .pem.

        Чтобы сохранить сертификат и закрытый ключ в отдельных файлах формата .pem, вы можете воспользоваться утилитой openssl в Linux:

        openssl pkcs12 -in Certificates.p12 -nokeys -nodes -out certificate.pem
        openssl pkcs12 -in Certificates.p12 -nocerts -nodes -out privatekey.pem
        

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

  • FCM: PlatformCredential — ключ сервисного аккаунта Google Cloud в формате JSON для аутентификации с помощью HTTP v1 API или API-ключ (server key) для аутентификации с помощью Legacy API.

    Рекомендуется экранировать содержимое файла с помощью команды jq @json <<< cat private_key.json, так как AWS CLI принимает данный параметр в строковом формате.

    Версия HTTP v1 API является предпочтительной, так как с июня 2024 года Legacy API не будет поддерживаться FCM.

  • HMS:

    • PlatformPrincipal — идентификатор ключа.
    • PlatformCredential — API-ключ.

  • RuStore:

    • PlatformPrincipal — идентификатор проекта (ProjectID).
    • PlatformCredential — сервисный токен (ServiceToken).

В результате вы получите идентификатор (ARN) канала уведомлений. Сохраните его для использования в дальнейшем.

Подробнее о команде aws sns create-platform-application см. в документации AWS.

Получите список каналов уведомленийПолучите список каналов уведомлений

aws sns list-platform-applications

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

Подробнее о команде aws sns list-platform-applications см. в документации AWS.

Создайте эндпоинтСоздайте эндпоинт

Чтобы создать мобильный эндпоинт, выполните команду:

aws sns create-platform-endpoint \
  --platform-application-arn <ARN_канала_уведомлений> \
  --token <Push-токен>

Где:

• --platform-application-arn — идентификатор (ARN) канала уведомлений.
• --token — уникальный Push-токен приложения на устройстве пользователя.

В результате вы получите идентификатор (ARN) мобильного эндпоинта. Сохраните его для дальнейшего использования.

Подробнее о команде aws sns create-platform-endpoint см. в документации AWS.

Отправьте уведомлениеОтправьте уведомление

Явные уведомления (Bright Push)Явные уведомления (Bright Push)

aws sns publish \
  --target-arn "<ARN_эндпоинта>" \
  --message-structure json \
  --message '{"default": "<текст_уведомления>", "APNS": "{ \"aps\": { \"alert\": \"<текст_уведомления>\"} }" }'

aws sns publish \
  --target-arn "<ARN_эндпоинта>" \
  --message-structure json \
  --message '{"default": "<текст_уведомления>", "GCM": "{ \"notification\": { \"body\": \"<текст_уведомления>\"} }" }'

Где:

• --target-arn — идентификатор (ARN) мобильного эндпоинта.
• --message-structure — формат сообщения.
• --message — сообщение.

Тихие уведомления (Silent Push)Тихие уведомления (Silent Push)

aws sns publish \
  --target-arn <ARN_эндпоинта> \
  --message-structure json \
  --message '{"data": { "key": "value" } }'

Где:

• --target-arn — идентификатор (ARN) мобильного эндпоинта.
• --message-structure — формат сообщения.
• --message — сообщение.

Подробнее о команде aws sns publish см. в документации AWS.

См. такжеСм. также

• Начало работы
• AWS SDK для Python (boto3)
• Концепции