SNS

import { SNS } from "https://aws-api.deno.dev/v0.3/services/sns.ts?docs=full";

class SNS {

constructor(apiFactory: client.ApiFactory);

async addPermission(params: AddPermissionInput, opts?: client.RequestOptions): Promise<void>;

async checkIfPhoneNumberIsOptedOut(params: CheckIfPhoneNumberIsOptedOutInput, opts?: client.RequestOptions): Promise<CheckIfPhoneNumberIsOptedOutResponse>;

async confirmSubscription(params: ConfirmSubscriptionInput, opts?: client.RequestOptions): Promise<ConfirmSubscriptionResponse>;

async createPlatformApplication(params: CreatePlatformApplicationInput, opts?: client.RequestOptions): Promise<CreatePlatformApplicationResponse>;

async createPlatformEndpoint(params: CreatePlatformEndpointInput, opts?: client.RequestOptions): Promise<CreateEndpointResponse>;

async createSMSSandboxPhoneNumber(params: CreateSMSSandboxPhoneNumberInput, opts?: client.RequestOptions): Promise<void>;

async createTopic(params: CreateTopicInput, opts?: client.RequestOptions): Promise<CreateTopicResponse>;

async deleteEndpoint(params: DeleteEndpointInput, opts?: client.RequestOptions): Promise<void>;

async deletePlatformApplication(params: DeletePlatformApplicationInput, opts?: client.RequestOptions): Promise<void>;

async deleteSMSSandboxPhoneNumber(params: DeleteSMSSandboxPhoneNumberInput, opts?: client.RequestOptions): Promise<void>;

async deleteTopic(params: DeleteTopicInput, opts?: client.RequestOptions): Promise<void>;

async getEndpointAttributes(params: GetEndpointAttributesInput, opts?: client.RequestOptions): Promise<GetEndpointAttributesResponse>;

async getPlatformApplicationAttributes(params: GetPlatformApplicationAttributesInput, opts?: client.RequestOptions): Promise<GetPlatformApplicationAttributesResponse>;

async getSMSAttributes(params?: GetSMSAttributesInput, opts?: client.RequestOptions): Promise<GetSMSAttributesResponse>;

async getSMSSandboxAccountStatus(opts?: client.RequestOptions): Promise<GetSMSSandboxAccountStatusResult>;

async getSubscriptionAttributes(params: GetSubscriptionAttributesInput, opts?: client.RequestOptions): Promise<GetSubscriptionAttributesResponse>;

async getTopicAttributes(params: GetTopicAttributesInput, opts?: client.RequestOptions): Promise<GetTopicAttributesResponse>;

async listEndpointsByPlatformApplication(params: ListEndpointsByPlatformApplicationInput, opts?: client.RequestOptions): Promise<ListEndpointsByPlatformApplicationResponse>;

async listOriginationNumbers(params?: ListOriginationNumbersRequest, opts?: client.RequestOptions): Promise<ListOriginationNumbersResult>;

async listPhoneNumbersOptedOut(params?: ListPhoneNumbersOptedOutInput, opts?: client.RequestOptions): Promise<ListPhoneNumbersOptedOutResponse>;

async listPlatformApplications(params?: ListPlatformApplicationsInput, opts?: client.RequestOptions): Promise<ListPlatformApplicationsResponse>;

async listSMSSandboxPhoneNumbers(params?: ListSMSSandboxPhoneNumbersInput, opts?: client.RequestOptions): Promise<ListSMSSandboxPhoneNumbersResult>;

async listSubscriptions(params?: ListSubscriptionsInput, opts?: client.RequestOptions): Promise<ListSubscriptionsResponse>;

async listSubscriptionsByTopic(params: ListSubscriptionsByTopicInput, opts?: client.RequestOptions): Promise<ListSubscriptionsByTopicResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTopics(params?: ListTopicsInput, opts?: client.RequestOptions): Promise<ListTopicsResponse>;

async optInPhoneNumber(params: OptInPhoneNumberInput, opts?: client.RequestOptions): Promise<void>;

async publish(params: PublishInput, opts?: client.RequestOptions): Promise<PublishResponse>;

async publishBatch(params: PublishBatchInput, opts?: client.RequestOptions): Promise<PublishBatchResponse>;

async removePermission(params: RemovePermissionInput, opts?: client.RequestOptions): Promise<void>;

async setEndpointAttributes(params: SetEndpointAttributesInput, opts?: client.RequestOptions): Promise<void>;

async setPlatformApplicationAttributes(params: SetPlatformApplicationAttributesInput, opts?: client.RequestOptions): Promise<void>;

async setSMSAttributes(params: SetSMSAttributesInput, opts?: client.RequestOptions): Promise<void>;

async setSubscriptionAttributes(params: SetSubscriptionAttributesInput, opts?: client.RequestOptions): Promise<void>;

async setTopicAttributes(params: SetTopicAttributesInput, opts?: client.RequestOptions): Promise<void>;

async subscribe(params: SubscribeInput, opts?: client.RequestOptions): Promise<SubscribeResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async unsubscribe(params: UnsubscribeInput, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async verifySMSSandboxPhoneNumber(params: VerifySMSSandboxPhoneNumberInput, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new SNS(apiFactory: client.ApiFactory)

[src]

§Methods

addPermission(params: AddPermissionInput, opts?: client.RequestOptions): Promise<void>

[src]

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

checkIfPhoneNumberIsOptedOut(params: CheckIfPhoneNumberIsOptedOutInput, opts?: client.RequestOptions): Promise<CheckIfPhoneNumberIsOptedOutResponse>

[src]

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services 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.

confirmSubscription(params: ConfirmSubscriptionInput, opts?: client.RequestOptions): Promise<ConfirmSubscriptionResponse>

[src]

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

createPlatformApplication(params: CreatePlatformApplicationInput, opts?: client.RequestOptions): Promise<CreatePlatformApplicationResponse>

[src]

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 using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing 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.

createPlatformEndpoint(params: CreatePlatformEndpointInput, opts?: client.RequestOptions): Promise<CreateEndpointResponse>

[src]

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.

createSMSSandboxPhoneNumber(params: CreateSMSSandboxPhoneNumberInput, opts?: client.RequestOptions): Promise<void>

[src]

Adds a destination phone number to an Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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.

createTopic(params: CreateTopicInput, opts?: client.RequestOptions): Promise<CreateTopicResponse>

[src]

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.

deleteEndpoint(params: DeleteEndpointInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

deletePlatformApplication(params: DeletePlatformApplicationInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteSMSSandboxPhoneNumber(params: DeleteSMSSandboxPhoneNumberInput, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteTopic(params: DeleteTopicInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

getEndpointAttributes(params: GetEndpointAttributesInput, opts?: client.RequestOptions): Promise<GetEndpointAttributesResponse>

[src]

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.

getPlatformApplicationAttributes(params: GetPlatformApplicationAttributesInput, opts?: client.RequestOptions): Promise<GetPlatformApplicationAttributesResponse>

[src]

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.

getSMSAttributes(params?: GetSMSAttributesInput, opts?: client.RequestOptions): Promise<GetSMSAttributesResponse>

[src]

Returns the settings for sending SMS messages from your Amazon Web Services account.

These settings are set with the SetSMSAttributes action.

getSMSSandboxAccountStatus(opts?: client.RequestOptions): Promise<GetSMSSandboxAccountStatusResult>

[src]

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

getSubscriptionAttributes(params: GetSubscriptionAttributesInput, opts?: client.RequestOptions): Promise<GetSubscriptionAttributesResponse>

[src]

Returns all of the properties of a subscription.

getTopicAttributes(params: GetTopicAttributesInput, opts?: client.RequestOptions): Promise<GetTopicAttributesResponse>

[src]

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

listEndpointsByPlatformApplication(params: ListEndpointsByPlatformApplicationInput, opts?: client.RequestOptions): Promise<ListEndpointsByPlatformApplicationResponse>

[src]

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

listOriginationNumbers(params?: ListOriginationNumbersRequest, opts?: client.RequestOptions): Promise<ListOriginationNumbersResult>

[src]

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

listPhoneNumbersOptedOut(params?: ListPhoneNumbersOptedOutInput, opts?: client.RequestOptions): Promise<ListPhoneNumbersOptedOutResponse>

[src]

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.

listPlatformApplications(params?: ListPlatformApplicationsInput, opts?: client.RequestOptions): Promise<ListPlatformApplicationsResponse>

[src]

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

listSMSSandboxPhoneNumbers(params?: ListSMSSandboxPhoneNumbersInput, opts?: client.RequestOptions): Promise<ListSMSSandboxPhoneNumbersResult>

[src]

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

listSubscriptions(params?: ListSubscriptionsInput, opts?: client.RequestOptions): Promise<ListSubscriptionsResponse>

[src]

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

listSubscriptionsByTopic(params: ListSubscriptionsByTopicInput, opts?: client.RequestOptions): Promise<ListSubscriptionsByTopicResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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.

listTopics(params?: ListTopicsInput, opts?: client.RequestOptions): Promise<ListTopicsResponse>

[src]

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

optInPhoneNumber(params: OptInPhoneNumberInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

publish(params: PublishInput, opts?: client.RequestOptions): Promise<PublishResponse>

[src]

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 is saved and Amazon SNS immediately deliverers it to subscribers.

To use the Publish action for publishing 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.

! IMPORTANT: ! You can publish messages only to topics and endpoints in the same Amazon Web Services Region.

publishBatch(params: PublishBatchInput, opts?: client.RequestOptions): Promise<PublishBatchResponse>

[src]

Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&AttributeName.1=first

&AttributeName.2=second

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

When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

removePermission(params: RemovePermissionInput, opts?: client.RequestOptions): Promise<void>

[src]

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

setEndpointAttributes(params: SetEndpointAttributesInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

setPlatformApplicationAttributes(params: SetPlatformApplicationAttributesInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

setSMSAttributes(params: SetSMSAttributesInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

setSubscriptionAttributes(params: SetSubscriptionAttributesInput, opts?: client.RequestOptions): Promise<void>

[src]

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

setTopicAttributes(params: SetTopicAttributesInput, opts?: client.RequestOptions): Promise<void>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.

unsubscribe(params: UnsubscribeInput, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

verifySMSSandboxPhoneNumber(params: VerifySMSSandboxPhoneNumberInput, opts?: client.RequestOptions): Promise<void>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]