How to get started with the AWS SDK for JavaScript in Yandex Cloud Notification Service

To get started with the AWS SDK for JavaScript:

1. Get your cloud ready.
2. Get a static access key.
3. Configure the AWS SDK.
4. Create a notification channel.
5. Get a list of channels.
6. Create an endpoint.
7. Send a notification.

Get your cloud readyGet your cloud ready

Sign up in Yandex Cloud and create a billing account:

1. Navigate to the management console and log in to Yandex Cloud or register a new account.
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 and link a cloud to it.

If you have an active billing account, you can navigate 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 editor role for the folder to the service account.

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

   Save the ID and secret key.

Configure the AWS SDKConfigure the AWS SDK

You can find the prerequisites and an AWS SDK for JavaScript installation guide in the relevant AWS documentation.

1. Install Node.js.

2. Initialize your project in the selected directory:

   npm init -y
   

3. Install the package with the AWS SNS client:

   npm i @aws-sdk/client-sns
   

4. Add "type": "module" to the package.json file to use the ESM syntax.

5. Create a client in the index.js file:

   import * as AWS from "@aws-sdk/client-sns";
   
   const snsClient = new AWS.SNSClient({
       endpoint: "https://notifications.yandexcloud.net/",
       region: "ru-central1",
       credentials: {
           accessKeyId: "<static_key_ID>",
           secretAccessKey: "<secret_key>",
       },
   })
   

6. Command to run the program:

   node index.js
   

Create a notification channelCreate a notification channel

const response = await client.send(
    new AWS.CreatePlatformApplicationCommand({
        Name: "<channel_name>",
        Platform: "<platform_type>",
        Attributes: { <authentication_type>: "<key>" },
    })
);
console.log(`PlatformApplication ARN: ${response.PlatformApplicationArn}`);

Where:

• Name: Notification channel name, user-defined.

  The name must be unique throughout CNS. Once the channel is created, you will not be able to change the name. The name may contain lowercase and uppercase Latin letters, numbers, underscores, hyphens, and periods. It must be from 1 to 256 characters long. For APNs channels, we recommend specifying the bundle ID in the name; for FCM and HMS, the full package name; for RuStore, packageName.

• 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).
  • RUSTORE: RuStore Android.

• Attributes: Mobile platform authentication parameters in key=value format. The values depend on the platform:

  • APNs:

    • Token-based authentication:

      • PlatformPrincipal: Path to the token 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: The more modern and secure method.

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

    Use the HTTP v1 API because the FCM legacy API is no longer supported starting July 2024.

  • HMS:

    • PlatformPrincipal: Key ID
    • PlatformCredential: API key

Get a list of notification channelsGet a list of notification channels

const response = await client.send(new AWS.ListPlatformApplicationsCommand({}));
console.log(
    response.PlatformApplications.map(
        (t) => `Application ARN: ${t.PlatformApplicationArn}`
    ).join("\n")
);

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

Create an endpointCreate an endpoint

const response = await client.send(
    new AWS.CreatePlatformEndpointCommand({
        PlatformApplicationArn: "<notification_channel_ARN>",
        Token: "<push_token>",
    })
);
console.log(`Endpoint ARN: ${response.EndpointArn}`);

Where:

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

Send a notificationSend a notification

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

const message = {
    default: "<notification_text>",
    APNS: JSON.stringify({
        aps: {
            alert: "<notification_text>",
        },
    }),
};

const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<endpoint_ARN>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

const message = {
    default: "<notification_text>",
    GCM: JSON.stringify({
        notification: {
            body: "<notification_text>",
        },
    }),
};
const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<endpoint_ARN>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

Where:

• message: Message
• TargetArn: Mobile endpoint ID (ARN)
• MessageStructure: Message format

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

const message = {
    default: "<notification_text>",
    APNS: JSON.stringify({
        key: "value",
    }),
};
const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<endpoint_ARN>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

const message = {
    default: "<notification_text>",
    GCM: JSON.stringify({
        data: {
            key: "value",
        },
    }),
};

const response = await client.send(
    new AWS.PublishCommand({
        Message: JSON.stringify(message),
        TargetArn: "<endpoint_ARN>",
        MessageStructure: "json",
    })
);
console.log(`Message id: ${response.MessageId}`);

Where:

• message: Message
• TargetArn: Mobile endpoint ID (ARN)
• MessageStructure: Message format

Text messageText message

const response = await client.send(
    new AWS.PublishCommand({
        PhoneNumber: "<phone_number>",
        Message: "<notification_text>",
        MessageAttributes: {
            "AWS.SNS.SMS.SenderID": {
                DataType: "String",
                StringValue: "<sender's_text_name>"
            }
        }
    })
);
console.log(`Message id: ${response.MessageId}`);

Where:

• PhoneNumber: Recipient's phone number
• Message: Notification text
• StringValue: Sender's text name

See alsoSee also

• Getting started
• AWS CLI
• Concepts
• AWS developer guide