You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.SNS

Inherits:
AWS.Service show all
Identifier:
sns
API Version:
2010-03-31
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

Sending a Request Using SNS

var sns = new AWS.SNS();
sns.addPermission(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SNS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var sns = new AWS.SNS({apiVersion: '2010-03-31'});

You can also set the API version globally in AWS.config.apiVersions using the sns service identifier:

AWS.config.apiVersions = {
  sns: '2010-03-31',
  // other service API versions
};

var sns = new AWS.SNS();

Version:

  • 2010-03-31

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SNS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SNS object

var sns = new AWS.SNS({apiVersion: '2010-03-31'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.SNS.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.SNS.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.SNS.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addPermission(params = {}, callback) ⇒ AWS.Request

Adds a statement to a topic's access control policy, granting access for the specified accounts to the specified actions.

Service Reference:

Examples:

Calling the addPermission operation

var params = {
  AWSAccountId: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ActionName: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Label: 'STRING_VALUE', /* required */
  TopicArn: 'STRING_VALUE' /* required */
};
sns.addPermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic whose access control policy you wish to modify.

    • Label — (String)

      A unique identifier for the new policy statement.

    • AWSAccountId — (Array<String>)

      The account IDs of the users (principals) who will be given access to the specified actions. The users must have account, but do not need to be signed up for this service.

    • ActionName — (Array<String>)

      The action you want to allow for the specified principal(s).

      Valid values: Any Amazon SNS action name, for example Publish.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

checkIfPhoneNumberIsOptedOut(params = {}, callback) ⇒ AWS.Request

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

Service Reference:

Examples:

Calling the checkIfPhoneNumberIsOptedOut operation

var params = {
  phoneNumber: 'STRING_VALUE' /* required */
};
sns.checkIfPhoneNumberIsOptedOut(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • phoneNumber — (String)

      The phone number for which you want to check the opt out status.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • isOptedOut — (Boolean)

        Indicates whether the phone number is opted out:

        • true – The phone number is opted out, meaning you cannot publish SMS messages to it.

        • false – The phone number is opted in, meaning you can publish SMS messages to it.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

confirmSubscription(params = {}, callback) ⇒ AWS.Request

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

Service Reference:

Examples:

Calling the confirmSubscription operation

var params = {
  Token: 'STRING_VALUE', /* required */
  TopicArn: 'STRING_VALUE', /* required */
  AuthenticateOnUnsubscribe: 'STRING_VALUE'
};
sns.confirmSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic for which you wish to confirm a subscription.

    • Token — (String)

      Short-lived token sent to an endpoint during the Subscribe action.

    • AuthenticateOnUnsubscribe — (String)

      Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SubscriptionArn — (String)

        The ARN of the created subscription.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPlatformApplication(params = {}, callback) ⇒ AWS.Request

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

  • For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

  • For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

  • For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

  • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.

  • For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

  • For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

Service Reference:

Examples:

Calling the createPlatformApplication operation

var params = {
  Attributes: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  Name: 'STRING_VALUE', /* required */
  Platform: 'STRING_VALUE' /* required */
};
sns.createPlatformApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

    • Platform — (String)

      The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

    • Attributes — (map<String>)

      For a list of attributes, see SetPlatformApplicationAttributes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlatformApplicationArn — (String)

        PlatformApplicationArn is returned.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPlatformEndpoint(params = {}, callback) ⇒ AWS.Request

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

Service Reference:

Examples:

Calling the createPlatformEndpoint operation

var params = {
  PlatformApplicationArn: 'STRING_VALUE', /* required */
  Token: 'STRING_VALUE', /* required */
  Attributes: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  CustomUserData: 'STRING_VALUE'
};
sns.createPlatformEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformApplicationArn — (String)

      PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

    • Token — (String)

      Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

    • CustomUserData — (String)

      Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

    • Attributes — (map<String>)

      For a list of attributes, see SetEndpointAttributes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointArn — (String)

        EndpointArn returned from CreateEndpoint action.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSMSSandboxPhoneNumber(params = {}, callback) ⇒ AWS.Request

Adds a destination phone number to an account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

Service Reference:

Examples:

Calling the createSMSSandboxPhoneNumber operation

var params = {
  PhoneNumber: 'STRING_VALUE', /* required */
  LanguageCode: en-US | en-GB | es-419 | es-ES | de-DE | fr-CA | fr-FR | it-IT | ja-JP | pt-BR | kr-KR | zh-CN | zh-TW
};
sns.createSMSSandboxPhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PhoneNumber — (String)

      The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

    • LanguageCode — (String)

      The language to use for sending the OTP. The default value is en-US.

      Possible values include:
      • "en-US"
      • "en-GB"
      • "es-419"
      • "es-ES"
      • "de-DE"
      • "fr-CA"
      • "fr-FR"
      • "it-IT"
      • "ja-JP"
      • "pt-BR"
      • "kr-KR"
      • "zh-CN"
      • "zh-TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTopic(params = {}, callback) ⇒ AWS.Request

Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

Service Reference:

Examples:

Calling the createTopic operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Attributes: {
    '<attributeName>': 'STRING_VALUE',
    /* '<attributeName>': ... */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sns.createTopic(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      The name of the topic you want to create.

      Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

      For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.

    • Attributes — (map<String>)

      A map of attributes with their corresponding values.

      The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

      • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

      • DisplayName – The display name to use for a topic with SMS subscriptions.

      • FifoTopic – Set to true to create a FIFO topic.

      • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

      The following attribute applies only to server-side encryption:

      • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

      The following attributes apply only to FIFO topics:

      • FifoTopic – When this is set to true, a FIFO topic is created.

      • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

        • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

        • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

    • Tags — (Array<map>)

      The list of tags to add to a new topic.

      Note: To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions.
      • Key — required — (String)

        The required key portion of the tag.

      • Value — required — (String)

        The optional value portion of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TopicArn — (String)

        The Amazon Resource Name (ARN) assigned to the created topic.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEndpoint(params = {}, callback) ⇒ AWS.Request

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

Service Reference:

Examples:

Calling the deleteEndpoint operation

var params = {
  EndpointArn: 'STRING_VALUE' /* required */
};
sns.deleteEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EndpointArn — (String)

      EndpointArn of endpoint to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePlatformApplication(params = {}, callback) ⇒ AWS.Request

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

Service Reference:

Examples:

Calling the deletePlatformApplication operation

var params = {
  PlatformApplicationArn: 'STRING_VALUE' /* required */
};
sns.deletePlatformApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformApplicationArn — (String)

      PlatformApplicationArn of platform application object to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSMSSandboxPhoneNumber(params = {}, callback) ⇒ AWS.Request

Deletes an account's verified or pending phone number from the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

Service Reference:

Examples:

Calling the deleteSMSSandboxPhoneNumber operation

var params = {
  PhoneNumber: 'STRING_VALUE' /* required */
};
sns.deleteSMSSandboxPhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PhoneNumber — (String)

      The destination phone number to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTopic(params = {}, callback) ⇒ AWS.Request

Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

Service Reference:

Examples:

Calling the deleteTopic operation

var params = {
  TopicArn: 'STRING_VALUE' /* required */
};
sns.deleteTopic(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getEndpointAttributes(params = {}, callback) ⇒ AWS.Request

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Service Reference:

Examples:

Calling the getEndpointAttributes operation

var params = {
  EndpointArn: 'STRING_VALUE' /* required */
};
sns.getEndpointAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EndpointArn — (String)

      EndpointArn for GetEndpointAttributes input.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<String>)

        Attributes include the following:

        • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

        • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

        • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

          Note: The device token for the iOS platform is returned in lowercase.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getPlatformApplicationAttributes(params = {}, callback) ⇒ AWS.Request

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

Service Reference:

Examples:

Calling the getPlatformApplicationAttributes operation

var params = {
  PlatformApplicationArn: 'STRING_VALUE' /* required */
};
sns.getPlatformApplicationAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformApplicationArn — (String)

      PlatformApplicationArn for GetPlatformApplicationAttributesInput.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<String>)

        Attributes include the following:

        • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.

        • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.

        • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.

        • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSMSAttributes(params = {}, callback) ⇒ AWS.Request

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

Service Reference:

Examples:

Calling the getSMSAttributes operation

var params = {
  attributes: [
    'STRING_VALUE',
    /* more items */
  ]
};
sns.getSMSAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • attributes — (Array<String>)

      A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.

      For all attribute names, see SetSMSAttributes.

      If you don't use this parameter, Amazon SNS returns all SMS attributes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • attributes — (map<String>)

        The SMS attribute names and their values.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSMSSandboxAccountStatus(params = {}, callback) ⇒ AWS.Request

Retrieves the SMS sandbox status for the calling account in the target Region.

When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

Service Reference:

Examples:

Calling the getSMSSandboxAccountStatus operation

var params = {
};
sns.getSMSSandboxAccountStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IsInSandbox — (Boolean)

        Indicates whether the calling account is in the SMS sandbox.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSubscriptionAttributes(params = {}, callback) ⇒ AWS.Request

Returns all of the properties of a subscription.

Service Reference:

Examples:

Calling the getSubscriptionAttributes operation

var params = {
  SubscriptionArn: 'STRING_VALUE' /* required */
};
sns.getSubscriptionAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionArn — (String)

      The ARN of the subscription whose properties you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<String>)

        A map of the subscription's attributes. Attributes in this map include the following:

        • ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

        • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

        • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

        • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

        • Owner – The account ID of the subscription's owner.

        • PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

        • RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

        • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

        • SubscriptionArn – The subscription's ARN.

        • TopicArn – The topic ARN that the subscription is associated with.

        The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

        • SubscriptionRoleArn – The ARN of the IAM role that has the following:

          • Permission to write to the Kinesis Data Firehose delivery stream

          • Amazon SNS listed as a trusted entity

          Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getTopicAttributes(params = {}, callback) ⇒ AWS.Request

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

Service Reference:

Examples:

Calling the getTopicAttributes operation

var params = {
  TopicArn: 'STRING_VALUE' /* required */
};
sns.getTopicAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic whose properties you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Attributes — (map<String>)

        A map of the topic's attributes. Attributes in this map include the following:

        • DeliveryPolicy – The JSON serialization of the topic's delivery policy.

        • DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.

        • Owner – The account ID of the topic's owner.

        • Policy – The JSON serialization of the topic's access control policy.

        • SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.

        • SubscriptionsDeleted – The number of deleted subscriptions for the topic.

        • SubscriptionsPending – The number of subscriptions pending confirmation for the topic.

        • TopicArn – The topic's ARN.

        • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.

        The following attribute applies only to server-side-encryption:

        • KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

        The following attributes apply only to FIFO topics:

        • FifoTopic – When this is set to true, a FIFO topic is created.

        • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

          • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

          • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

            (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listEndpointsByPlatformApplication(params = {}, callback) ⇒ AWS.Request

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 30 transactions per second (TPS).

Service Reference:

Examples:

Calling the listEndpointsByPlatformApplication operation

var params = {
  PlatformApplicationArn: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
sns.listEndpointsByPlatformApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformApplicationArn — (String)

      PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

    • NextToken — (String)

      NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Endpoints — (Array<map>)

        Endpoints returned for ListEndpointsByPlatformApplication action.

        • EndpointArn — (String)

          EndpointArn for mobile app and device.

        • Attributes — (map<String>)

          Attributes for endpoint.

      • NextToken — (String)

        NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listOriginationNumbers(params = {}, callback) ⇒ AWS.Request

Lists the calling account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.

Service Reference:

Examples:

Calling the listOriginationNumbers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
sns.listOriginationNumbers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Token that the previous ListOriginationNumbers request returns.

    • MaxResults — (Integer)

      The maximum number of origination numbers to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available.

      • PhoneNumbers — (Array<map>)

        A list of the calling account's verified and pending origination numbers.

        • CreatedAt — (Date)

          The date and time when the phone number was created.

        • PhoneNumber — (String)

          The phone number.

        • Status — (String)

          The status of the phone number.

        • Iso2CountryCode — (String)

          The two-character code for the country or region, in ISO 3166-1 alpha-2 format.

        • RouteType — (String)

          The list of supported routes.

          Possible values include:
          • "Transactional"
          • "Promotional"
          • "Premium"
        • NumberCapabilities — (Array<String>)

          The capabilities of each phone number.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPhoneNumbersOptedOut(params = {}, callback) ⇒ AWS.Request

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

Service Reference:

Examples:

Calling the listPhoneNumbersOptedOut operation

var params = {
  nextToken: 'STRING_VALUE'
};
sns.listPhoneNumbersOptedOut(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • nextToken — (String)

      A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • phoneNumbers — (Array<String>)

        A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

      • nextToken — (String)

        A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPlatformApplications(params = {}, callback) ⇒ AWS.Request

Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 15 transactions per second (TPS).

Service Reference:

Examples:

Calling the listPlatformApplications operation

var params = {
  NextToken: 'STRING_VALUE'
};
sns.listPlatformApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlatformApplications — (Array<map>)

        Platform applications returned when calling ListPlatformApplications action.

        • PlatformApplicationArn — (String)

          PlatformApplicationArn for platform application object.

        • Attributes — (map<String>)

          Attributes for platform application object.

      • NextToken — (String)

        NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSMSSandboxPhoneNumbers(params = {}, callback) ⇒ AWS.Request

Lists the calling account's current verified and pending destination phone numbers in the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

Service Reference:

Examples:

Calling the listSMSSandboxPhoneNumbers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
sns.listSMSSandboxPhoneNumbers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Token that the previous ListSMSSandboxPhoneNumbersInput request returns.

    • MaxResults — (Integer)

      The maximum number of phone numbers to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PhoneNumbers — (Array<map>)

        A list of the calling account's pending and verified phone numbers.

        • PhoneNumber — (String)

          The destination phone number.

        • Status — (String)

          The destination phone number's verification status.

          Possible values include:
          • "Pending"
          • "Verified"
      • NextToken — (String)

        A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSubscriptions(params = {}, callback) ⇒ AWS.Request

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

This action is throttled at 30 transactions per second (TPS).

Service Reference:

Examples:

Calling the listSubscriptions operation

var params = {
  NextToken: 'STRING_VALUE'
};
sns.listSubscriptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Token returned by the previous ListSubscriptions request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Subscriptions — (Array<map>)

        A list of subscriptions.

        • SubscriptionArn — (String)

          The subscription's ARN.

        • Owner — (String)

          The subscription's owner.

        • Protocol — (String)

          The subscription's protocol.

        • Endpoint — (String)

          The subscription's endpoint (format depends on the protocol).

        • TopicArn — (String)

          The ARN of the subscription's topic.

      • NextToken — (String)

        Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listSubscriptionsByTopic(params = {}, callback) ⇒ AWS.Request

Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.

This action is throttled at 30 transactions per second (TPS).

Service Reference:

Examples:

Calling the listSubscriptionsByTopic operation

var params = {
  TopicArn: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
sns.listSubscriptionsByTopic(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic for which you wish to find subscriptions.

    • NextToken — (String)

      Token returned by the previous ListSubscriptionsByTopic request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Subscriptions — (Array<map>)

        A list of subscriptions.

        • SubscriptionArn — (String)

          The subscription's ARN.

        • Owner — (String)

          The subscription's owner.

        • Protocol — (String)

          The subscription's protocol.

        • Endpoint — (String)

          The subscription's endpoint (format depends on the protocol).

        • TopicArn — (String)

          The ARN of the subscription's topic.

      • NextToken — (String)

        Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
sns.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The ARN of the topic for which to list tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tags associated with the specified topic.

        • Key — required — (String)

          The required key portion of the tag.

        • Value — required — (String)

          The optional value portion of the tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTopics(params = {}, callback) ⇒ AWS.Request

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

This action is throttled at 30 transactions per second (TPS).

Service Reference:

Examples:

Calling the listTopics operation

var params = {
  NextToken: 'STRING_VALUE'
};
sns.listTopics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Token returned by the previous ListTopics request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Topics — (Array<map>)

        A list of topic ARNs.

        • TopicArn — (String)

          The topic's ARN.

      • NextToken — (String)

        Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

optInPhoneNumber(params = {}, callback) ⇒ AWS.Request

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

Service Reference:

Examples:

Calling the optInPhoneNumber operation

var params = {
  phoneNumber: 'STRING_VALUE' /* required */
};
sns.optInPhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • phoneNumber — (String)

      The phone number to opt in. Use E.164 format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

publish(params = {}, callback) ⇒ AWS.Request

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

You can publish messages only to topics and endpoints in the same Region.

Service Reference:

Examples:

Calling the publish operation

var params = {
  Message: 'STRING_VALUE', /* required */
  MessageAttributes: {
    '<String>': {
      DataType: 'STRING_VALUE', /* required */
      BinaryValue: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      StringValue: 'STRING_VALUE'
    },
    /* '<String>': ... */
  },
  MessageDeduplicationId: 'STRING_VALUE',
  MessageGroupId: 'STRING_VALUE',
  MessageStructure: 'STRING_VALUE',
  PhoneNumber: 'STRING_VALUE',
  Subject: 'STRING_VALUE',
  TargetArn: 'STRING_VALUE',
  TopicArn: 'STRING_VALUE'
};
sns.publish(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The topic you want to publish to.

      If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

    • TargetArn — (String)

      If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

    • PhoneNumber — (String)

      The phone number to which you want to deliver an SMS message. Use E.164 format.

      If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

    • Message — (String)

      The message you want to send.

      If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

      Constraints:

      • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

      • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

        If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.

        The total size limit for a single SMS Publish action is 1,600 characters.

      JSON-specific constraints:

      • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

      • The values will be parsed (unescaped) before they are used in outgoing messages.

      • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

      • Values have a minimum length of 0 (the empty string, "", is allowed).

      • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

      • Non-string values will cause the key to be ignored.

      • Keys that do not correspond to supported transport protocols are ignored.

      • Duplicate keys are not allowed.

      • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

    • Subject — (String)

      Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

      Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

    • MessageStructure — (String)

      Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

      • be a syntactically valid JSON object; and

      • contain at least a top-level JSON key of "default" with a value that is a string.

      You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").

      Valid value: json

    • MessageAttributes — (map<map>)

      Message attributes for Publish action.

      • DataType — required — (String)

        Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

      • StringValue — (String)

        Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

      • BinaryValue — (Buffer, Typed Array, Blob, String)

        Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

    • MessageDeduplicationId — (String)

      This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[]^_{|}~).

      Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.

      If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.

    • MessageGroupId — (String)

      This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[]^_{|}~).

      The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageId — (String)

        Unique identifier assigned to the published message.

        Length Constraint: Maximum 100 characters

      • SequenceNumber — (String)

        This response element applies only to FIFO (first-in-first-out) topics.

        The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for each MessageGroupId.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removePermission(params = {}, callback) ⇒ AWS.Request

Removes a statement from a topic's access control policy.

Service Reference:

Examples:

Calling the removePermission operation

var params = {
  Label: 'STRING_VALUE', /* required */
  TopicArn: 'STRING_VALUE' /* required */
};
sns.removePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic whose access control policy you wish to modify.

    • Label — (String)

      The unique label of the statement you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setEndpointAttributes(params = {}, callback) ⇒ AWS.Request

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Service Reference:

Examples:

Calling the setEndpointAttributes operation

var params = {
  Attributes: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  EndpointArn: 'STRING_VALUE' /* required */
};
sns.setEndpointAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EndpointArn — (String)

      EndpointArn used for SetEndpointAttributes action.

    • Attributes — (map<String>)

      A map of the endpoint attributes. Attributes in this map include the following:

      • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

      • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

      • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setPlatformApplicationAttributes(params = {}, callback) ⇒ AWS.Request

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

Service Reference:

Examples:

Calling the setPlatformApplicationAttributes operation

var params = {
  Attributes: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  PlatformApplicationArn: 'STRING_VALUE' /* required */
};
sns.setPlatformApplicationAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformApplicationArn — (String)

      PlatformApplicationArn for SetPlatformApplicationAttributes action.

    • Attributes — (map<String>)

      A map of the platform application attributes. Attributes in this map include the following:

      • PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.

      • PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.

      • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.

      • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.

      • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.

      • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

      • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

      • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

      • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setSMSAttributes(params = {}, callback) ⇒ AWS.Request

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Publishing to a mobile phone in the Amazon SNS Developer Guide.

Note: To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

Service Reference:

Examples:

Calling the setSMSAttributes operation

var params = {
  attributes: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
sns.setSMSAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • attributes — (map<String>)

      The default settings for sending SMS messages from your account. You can set values for the following attribute names:

      MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

      Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

      By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

      DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

      DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

      DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

      DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

      • Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.

      • Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

      UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:

      • Time that the message was published (in UTC)

      • Message ID

      • Destination phone number

      • Message type

      • Delivery status

      • Message price (in USD)

      • Part number (a message is split into multiple parts if it is too long for a single message)

      • Total number of parts

      To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions.

      For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setSubscriptionAttributes(params = {}, callback) ⇒ AWS.Request

Allows a subscription owner to set an attribute of the subscription to a new value.

Service Reference:

Examples:

Calling the setSubscriptionAttributes operation

var params = {
  AttributeName: 'STRING_VALUE', /* required */
  SubscriptionArn: 'STRING_VALUE', /* required */
  AttributeValue: 'STRING_VALUE'
};
sns.setSubscriptionAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionArn — (String)

      The ARN of the subscription to modify.

    • AttributeName — (String)

      A map of attributes with their corresponding values.

      The following lists the names, descriptions, and values of the special request parameters that this action uses:

      • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

      • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

      • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

      • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

      The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

      • SubscriptionRoleArn – The ARN of the IAM role that has the following:

        • Permission to write to the Kinesis Data Firehose delivery stream

        • Amazon SNS listed as a trusted entity

        Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

    • AttributeValue — (String)

      The new value for the attribute in JSON format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setTopicAttributes(params = {}, callback) ⇒ AWS.Request

Allows a topic owner to set an attribute of the topic to a new value.

Service Reference:

Examples:

Calling the setTopicAttributes operation

var params = {
  AttributeName: 'STRING_VALUE', /* required */
  TopicArn: 'STRING_VALUE', /* required */
  AttributeValue: 'STRING_VALUE'
};
sns.setTopicAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic to modify.

    • AttributeName — (String)

      A map of attributes with their corresponding values.

      The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

      • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

      • DisplayName – The display name to use for a topic with SMS subscriptions.

      • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

      The following attribute applies only to server-side-encryption:

      • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

      The following attribute applies only to FIFO topics:

      • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.

        • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.

        • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

          (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

    • AttributeValue — (String)

      The new value for the attribute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

subscribe(params = {}, callback) ⇒ AWS.Request

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.

You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.

This action is throttled at 100 transactions per second (TPS).

Service Reference:

Examples:

Calling the subscribe operation

var params = {
  Protocol: 'STRING_VALUE', /* required */
  TopicArn: 'STRING_VALUE', /* required */
  Attributes: {
    '<attributeName>': 'STRING_VALUE',
    /* '<attributeName>': ... */
  },
  Endpoint: 'STRING_VALUE',
  ReturnSubscriptionArn: true || false
};
sns.subscribe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TopicArn — (String)

      The ARN of the topic you want to subscribe to.

    • Protocol — (String)

      The protocol that you want to use. Supported protocols include:

      • http – delivery of JSON-encoded message via HTTP POST

      • https – delivery of JSON-encoded message via HTTPS POST

      • email – delivery of message via SMTP

      • email-json – delivery of JSON-encoded message via SMTP

      • sms – delivery of message via SMS

      • sqs – delivery of JSON-encoded message to an Amazon SQS queue

      • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device

      • lambda – delivery of JSON-encoded message to an Lambda function

      • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.

    • Endpoint — (String)

      The endpoint that you want to receive notifications. Endpoints vary by protocol:

      • For the http protocol, the (public) endpoint is a URL beginning with http://.

      • For the https protocol, the (public) endpoint is a URL beginning with https://.

      • For the email protocol, the endpoint is an email address.

      • For the email-json protocol, the endpoint is an email address.

      • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.

      • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.

      • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

      • For the lambda protocol, the endpoint is the ARN of an Lambda function.

      • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.

    • Attributes — (map<String>)

      A map of attributes with their corresponding values.

      The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:

      • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

      • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

      • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

      • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

      The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

      • SubscriptionRoleArn – The ARN of the IAM role that has the following:

        • Permission to write to the Kinesis Data Firehose delivery stream

        • Amazon SNS listed as a trusted entity

        Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

    • ReturnSubscriptionArn — (Boolean)

      Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

      If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

      The default value is false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SubscriptionArn — (String)

        The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

When you use topic tags, keep the following guidelines in mind:

  • Adding more than 50 tags to a topic isn't recommended.

  • Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.

  • Tags are case-sensitive.

  • A new tag with a key identical to that of an existing tag overwrites the existing tag.

  • Tagging actions are limited to 10 TPS per account, per Region. If your application requires a higher throughput, file a technical support request.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
sns.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The ARN of the topic to which to add tags.

    • Tags — (Array<map>)

      The tags to be added to the specified topic. A tag consists of a required key and an optional value.

      • Key — required — (String)

        The required key portion of the tag.

      • Value — required — (String)

        The optional value portion of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

unsubscribe(params = {}, callback) ⇒ AWS.Request

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an Amazon Web Services signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

This action is throttled at 100 transactions per second (TPS).

Service Reference:

Examples:

Calling the unsubscribe operation

var params = {
  SubscriptionArn: 'STRING_VALUE' /* required */
};
sns.unsubscribe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionArn — (String)

      The ARN of the subscription to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
sns.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The ARN of the topic from which to remove tags.

    • TagKeys — (Array<String>)

      The list of tag keys to remove from the specified topic.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

verifySMSSandboxPhoneNumber(params = {}, callback) ⇒ AWS.Request

Verifies a destination phone number with a one-time password (OTP) for the calling account.

When you start using Amazon SNS to send SMS messages, your account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

Service Reference:

Examples:

Calling the verifySMSSandboxPhoneNumber operation

var params = {
  OneTimePassword: 'STRING_VALUE', /* required */
  PhoneNumber: 'STRING_VALUE' /* required */
};
sns.verifySMSSandboxPhoneNumber(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PhoneNumber — (String)

      The destination phone number to verify.

    • OneTimePassword — (String)

      The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.