Getting started with Yandex Cloud Notification Service using AWS CLI

To enable Cloud Notification Service, request access to the service from your account manager or technical support.

Cloud Notification Service (CNS) is a service for multichannel notifications of users. The service's HTTP API is compatible with the Amazon SNS API.

At the preview stage, you can send personalized push notifications to iOS and Android devices as well as text messages (SMS).

Moving forward, we will add notifications to messengers and browsers.

With Cloud Notification Service, you can send notifications to apps registered in the following services:

• Apple Push Notification service (APNs).
• Firebase Cloud Messaging (FCM).
• Huawei Mobile Services (HMS).

To get started with the AWS CLI:

1. Prepare your cloud.
2. Get a static access key.
3. Set up the AWS CLI.
4. Create a notification channel.
5. Get a list of channels.
6. Create an endpoint.
7. Send a notification.

Prepare your cloudPrepare your cloud

Sign up for Yandex Cloud and create a billing account:

1. Go to the management console and log in to Yandex Cloud or create an account if you do not have one yet.
2. On the Yandex Cloud Billing page, make sure you have a billing account linked and it has the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account, create one.

If you have an active billing account, you can go to the cloud page to create or select a folder for your infrastructure to operate in.

Learn more about clouds and folders.

Get a static access keyGet a static access key

For authentication in Cloud Notification Service, use a static access key. The key is issued for the service account, and all actions are performed on behalf of that service account.

To get a static access key:

1. Create a service account.

2. Assign the service account the editor role for the folder.

3. Create a static access key for the service account.

   Save the ID and private key.

Set up the AWS CLISet up the AWS CLI

The AWS CLI is a command line interface designed for AWS services. The Cloud Notification Service HTTP API is compatible with the Amazon SNS API. To learn how to run commands, see the official Amazon documentation.

To configure the AWS CLI:

1. Install the AWS CLI.

2. Enter the command to configure the AWS CLI:

   aws configure
   

3. Enter the values for these parameters:

   • AWS Access Key ID: Static key ID

   • AWS Secret Access Key: Secret key

   • Default region name: ru-central1

     Note

     To work with Cloud Notification Service, always specify ru-central1 as the region. A different region value may lead to an authorization error.

4. Leave the other parameter values unchanged.

5. Set the Cloud Notification Service endpoint:

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

For more information about setting up the AWS CLI, see the AWS documentation.

Create a notification channelCreate a notification channel

To create a notification channel, run this command:

aws sns create-platform-application \
  --name <channel_name> \
  --platform GCM \
  --attributes PlatformCredential=<FCM_API_key>

Where:

• --name: Notification channel name, user-defined. The name must be unique within the cloud. It may contain lowercase and uppercase Latin letters, numbers, underscores, hyphens, and periods. It may be from 1 to 256 characters long. For APNs channels, we recommend specifying the bundle ID in the name, and for FCM and HMS, the full package name.
• --platform: Mobile platform type:
  • APNS and APNS_SANDBOX: Apple Push Notification service (APNs). Use APNS_SANDBOX to test the application.
  • GCM: Firebase Cloud Messaging (FCM).
  • HMS: Huawei Mobile Services (HMS).
• --attributes: Mobile platform authentication parameters in key=value format. The values depend on platform:

  • APNs:

    • Token-based authentication:
      • PlatformPrincipal: Path to the signature key file from Apple.
      • PlatformCredential: Key ID.
      • ApplePlatformTeamID: Team ID.
      • ApplePlatformBundleID: Bundle ID.
    • Certificate-based authentication:

      • PlatformPrincipal: SSL certificate in .pem format.

      • PlatformCredential: Certificate private key in .pem format.

        To save the certificate and the private key in individual .pem files, use the openssl Linux utility:

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

    Token-based authentication is preferred as it is more modern.

  • FCM: PlatformCredential is the Google Cloud service account key in JSON format for authentication with the HTTP v1 API or API key (server key) for authentication with the legacy API.

    We recommend escaping the file contents using the jq @json <<< cat private_key.json command, as the AWS CLI accepts this parameter in string format.

    The HTTP v1 API is preferred as FCM will no longer support the legacy API starting from June 2024.

  • HMS:

    • PlatformPrincipal: Key ID
    • PlatformCredential: API key

As a result, you will get a notification channel ID (ARN). Save it for future use.

For more information about the aws sns create-platform-application command, see the AWS documentation.

Get a list of notification channelsGet a list of notification channels

aws sns list-platform-applications

You will get the list of notification channels located in the same folder as the service account.

For more information about the aws sns list-platform-applications command, see the AWS documentation.

Create an endpointCreate an endpoint

To create a mobile endpoint, run the following command:

aws sns create-platform-endpoint \
  --platform-application-arn <notification_channel_ARN> \
  --token <push_token>

Where:

• --platform-application-arn: Notification channel ID (ARN).
• --token: Unique push token for the application on the user’s device.

As a result, you will get a mobile endpoint ID (ARN). Save it for future use.

For more information about the aws sns create-platform-endpoint command, see the AWS documentation.

Send a notificationSend a notification

Explicit notifications (Bright Push)Explicit notifications (Bright Push)

aws sns publish \
  --target-arn "<endpoint_ARN>" \
  --message-structure json \
  --message '{"default": "<notification_text>", "APNS": "{ \"aps\": { \"alert\": \"<notification_text>\"} }" }'

aws sns publish \
  --target-arn "<endpoint_ARN>" \
  --message-structure json \
  --message '{"default": "<notification_text>", "GCM": "{ \"notification\": { \"body\": \"<notification_text>\"} }" }'

Where:

• --target-arn: Mobile endpoint ID (ARN)
• --message-structure: Message format
• --message: Message

Silent notifications (Silent Push)Silent notifications (Silent Push)

aws sns publish \
  --target-arn <endpoint_ARN> \
  --message-structure json \
  --message '{"data": { "key": "value" } }'

Where:

• --target-arn: Mobile endpoint ID (ARN)
• --message-structure: Message format
• --message: Message

For more information about the aws sns publish command, see the AWS documentation.

See alsoSee also

• Getting started
• AWS SDK for Python (boto3)
• Concepts