SNS

public struct SNS

Client object for interacting with AWS SNS service.

Amazon Simple Notification Service 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 https://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see 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.

Member variables

Initialization

  • Initialize the SNS client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

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

    Declaration

    Swift

    @discardableResult
public func addPermission(_ input: AddPermissionInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func checkIfPhoneNumberIsOptedOut(_ input: CheckIfPhoneNumberIsOptedOutInput) -> EventLoopFuture<CheckIfPhoneNumberIsOptedOutResponse>

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

    Declaration

    Swift

    public func confirmSubscription(_ input: ConfirmSubscriptionInput) -> EventLoopFuture<ConfirmSubscriptionResponse>

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

    Declaration

    Swift

    public func createPlatformApplication(_ input: CreatePlatformApplicationInput) -> EventLoopFuture<CreatePlatformApplicationResponse>

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

    Declaration

    Swift

    public func createPlatformEndpoint(_ input: CreatePlatformEndpointInput) -> EventLoopFuture<CreateEndpointResponse>

  • Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. 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.

    Declaration

    Swift

    public func createTopic(_ input: CreateTopicInput) -> EventLoopFuture<CreateTopicResponse>

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

    Declaration

    Swift

    @discardableResult
public func deleteEndpoint(_ input: DeleteEndpointInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    @discardableResult
public func deletePlatformApplication(_ input: DeletePlatformApplicationInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    @discardableResult
public func deleteTopic(_ input: DeleteTopicInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func getEndpointAttributes(_ input: GetEndpointAttributesInput) -> EventLoopFuture<GetEndpointAttributesResponse>

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

    Declaration

    Swift

    public func getPlatformApplicationAttributes(_ input: GetPlatformApplicationAttributesInput) -> EventLoopFuture<GetPlatformApplicationAttributesResponse>

  • Returns the settings for sending SMS messages from your account. These settings are set with the SetSMSAttributes action.

    Declaration

    Swift

    public func getSMSAttributes(_ input: GetSMSAttributesInput) -> EventLoopFuture<GetSMSAttributesResponse>

  • Returns all of the properties of a subscription.

    Declaration

    Swift

    public func getSubscriptionAttributes(_ input: GetSubscriptionAttributesInput) -> EventLoopFuture<GetSubscriptionAttributesResponse>

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

    Declaration

    Swift

    public func getTopicAttributes(_ input: GetTopicAttributesInput) -> EventLoopFuture<GetTopicAttributesResponse>

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

    Declaration

    Swift

    public func listEndpointsByPlatformApplication(_ input: ListEndpointsByPlatformApplicationInput) -> EventLoopFuture<ListEndpointsByPlatformApplicationResponse>

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

    Declaration

    Swift

    public func listPhoneNumbersOptedOut(_ input: ListPhoneNumbersOptedOutInput) -> EventLoopFuture<ListPhoneNumbersOptedOutResponse>

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

    Declaration

    Swift

    public func listPlatformApplications(_ input: ListPlatformApplicationsInput) -> EventLoopFuture<ListPlatformApplicationsResponse>

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

    Declaration

    Swift

    public func listSubscriptions(_ input: ListSubscriptionsInput) -> EventLoopFuture<ListSubscriptionsResponse>

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

    Declaration

    Swift

    public func listSubscriptionsByTopic(_ input: ListSubscriptionsByTopicInput) -> EventLoopFuture<ListSubscriptionsByTopicResponse>

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

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

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

    Declaration

    Swift

    public func listTopics(_ input: ListTopicsInput) -> EventLoopFuture<ListTopicsResponse>

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

    Declaration

    Swift

    public func optInPhoneNumber(_ input: OptInPhoneNumberInput) -> EventLoopFuture<OptInPhoneNumberResponse>

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

    Declaration

    Swift

    public func publish(_ input: PublishInput) -> EventLoopFuture<PublishResponse>

  • Removes a statement from a topic’s access control policy.

    Declaration

    Swift

    @discardableResult
public func removePermission(_ input: RemovePermissionInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    @discardableResult
public func setEndpointAttributes(_ input: SetEndpointAttributesInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    @discardableResult
public func setPlatformApplicationAttributes(_ input: SetPlatformApplicationAttributesInput) -> EventLoopFuture<Void>

  • 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 Sending an SMS Message in the Amazon SNS Developer Guide.

    Declaration

    Swift

    public func setSMSAttributes(_ input: SetSMSAttributesInput) -> EventLoopFuture<SetSMSAttributesResponse>

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

    Declaration

    Swift

    @discardableResult
public func setSubscriptionAttributes(_ input: SetSubscriptionAttributesInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    @discardableResult
public func setTopicAttributes(_ input: SetTopicAttributesInput) -> EventLoopFuture<Void>

  • 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 AWS account, the endpoint owner must 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).

    Declaration

    Swift

    public func subscribe(_ input: SubscribeInput) -> EventLoopFuture<SubscribeResponse>

  • 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 AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

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

    Declaration

    Swift

    @discardableResult
public func unsubscribe(_ input: UnsubscribeInput) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

Paginators

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

    Declaration

    Swift

    public func listEndpointsByPlatformApplicationPaginator(_ input: ListEndpointsByPlatformApplicationInput, onPage: @escaping (ListEndpointsByPlatformApplicationResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listPlatformApplicationsPaginator(_ input: ListPlatformApplicationsInput, onPage: @escaping (ListPlatformApplicationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listSubscriptionsPaginator(_ input: ListSubscriptionsInput, onPage: @escaping (ListSubscriptionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listSubscriptionsByTopicPaginator(_ input: ListSubscriptionsByTopicInput, onPage: @escaping (ListSubscriptionsByTopicResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

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

    Declaration

    Swift

    public func listTopicsPaginator(_ input: ListTopicsInput, onPage: @escaping (ListTopicsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes