ExAws.SNS.Core

Amazon Simple Notification 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 http://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.

Source

Summary

add_permission!(client, input)

Same as add_permission/2 but raise on error

add_permission(client, input)

AddPermission

confirm_subscription!(client, input)

Same as confirm_subscription/2 but raise on error

confirm_subscription(client, input)

ConfirmSubscription

create_platform_application!(client, input)

Same as create_platform_application/2 but raise on error

create_platform_application(client, input)

CreatePlatformApplication

create_platform_endpoint!(client, input)

Same as create_platform_endpoint/2 but raise on error

create_platform_endpoint(client, input)

CreatePlatformEndpoint

create_topic!(client, input)

Same as create_topic/2 but raise on error

create_topic(client, input)

CreateTopic

delete_endpoint!(client, input)

Same as delete_endpoint/2 but raise on error

delete_endpoint(client, input)

DeleteEndpoint

delete_platform_application!(client, input)

Same as delete_platform_application/2 but raise on error

delete_platform_application(client, input)

DeletePlatformApplication

delete_topic!(client, input)

Same as delete_topic/2 but raise on error

delete_topic(client, input)

DeleteTopic

get_endpoint_attributes!(client, input)

Same as get_endpoint_attributes/2 but raise on error

get_endpoint_attributes(client, input)

GetEndpointAttributes

get_platform_application_attributes!(client, input)

Same as get_platform_application_attributes/2 but raise on error

get_platform_application_attributes(client, input)

GetPlatformApplicationAttributes

get_subscription_attributes!(client, input)

Same as get_subscription_attributes/2 but raise on error

get_subscription_attributes(client, input)

GetSubscriptionAttributes

get_topic_attributes!(client, input)

Same as get_topic_attributes/2 but raise on error

get_topic_attributes(client, input)

GetTopicAttributes

list_endpoints_by_platform_application!(client, input)

Same as list_endpoints_by_platform_application/2 but raise on error

list_endpoints_by_platform_application(client, input)

ListEndpointsByPlatformApplication

list_platform_applications!(client, input)

Same as list_platform_applications/2 but raise on error

list_platform_applications(client, input)

ListPlatformApplications

list_subscriptions!(client, input)

Same as list_subscriptions/2 but raise on error

list_subscriptions(client, input)

ListSubscriptions

list_subscriptions_by_topic!(client, input)

Same as list_subscriptions_by_topic/2 but raise on error

list_subscriptions_by_topic(client, input)

ListSubscriptionsByTopic

list_topics!(client, input)

Same as list_topics/2 but raise on error

list_topics(client, input)

ListTopics

publish!(client, input)

Same as publish/2 but raise on error

publish(client, input)

Publish

remove_permission!(client, input)

Same as remove_permission/2 but raise on error

remove_permission(client, input)

RemovePermission

set_endpoint_attributes!(client, input)

Same as set_endpoint_attributes/2 but raise on error

set_endpoint_attributes(client, input)

SetEndpointAttributes

set_platform_application_attributes!(client, input)

Same as set_platform_application_attributes/2 but raise on error

set_platform_application_attributes(client, input)

SetPlatformApplicationAttributes

set_subscription_attributes!(client, input)

Same as set_subscription_attributes/2 but raise on error

set_subscription_attributes(client, input)

SetSubscriptionAttributes

set_topic_attributes!(client, input)

Same as set_topic_attributes/2 but raise on error

set_topic_attributes(client, input)

SetTopicAttributes

subscribe!(client, input)

Same as subscribe/2 but raise on error

subscribe(client, input)

Subscribe

unsubscribe!(client, input)

Same as unsubscribe/2 but raise on error

unsubscribe(client, input)

Unsubscribe

Types

subscribe_response :: [{:subscription_arn, subscription_arn}]

invalid_parameter_exception :: [{:message, binary}]

endpoint_disabled_exception :: [{:message, binary}]

topic :: [{:topic_arn, topic_arn}]

action :: binary

platform_application :: [attributes: map_string_to_string, platform_application_arn: binary]

publish_input :: [message: message, message_attributes: message_attribute_map, message_structure: message_structure, subject: subject, target_arn: binary, topic_arn: topic_arn]

create_topic_response :: [{:topic_arn, topic_arn}]

list_subscriptions_response :: [next_token: next_token, subscriptions: subscriptions_list]

list_platform_applications_response :: [next_token: binary, platform_applications: list_of_platform_applications]

invalid_parameter_value_exception :: [{:message, binary}]

topic_limit_exceeded_exception :: [{:message, binary}]

list_platform_applications_input :: [{:next_token, binary}]

set_topic_attributes_input :: [attribute_name: attribute_name, attribute_value: attribute_value, topic_arn: topic_arn]

token :: binary

set_platform_application_attributes_input :: [attributes: map_string_to_string, platform_application_arn: binary]

set_subscription_attributes_input :: [attribute_name: attribute_name, attribute_value: attribute_value, subscription_arn: subscription_arn]

remove_permission_input :: [label: label, topic_arn: topic_arn]

endpoint :: [attributes: map_string_to_string, endpoint_arn: binary]

map_string_to_string :: [{binary, binary}]

internal_error_exception :: [{:message, binary}]

get_platform_application_attributes_input :: [{:platform_application_arn, binary}]

not_found_exception :: [{:message, binary}]

next_token :: binary

subscription_limit_exceeded_exception :: [{:message, binary}]

delete_topic_input :: [{:topic_arn, topic_arn}]

subscription :: [endpoint: endpoint_name, owner: account, protocol: protocol, subscription_arn: subscription_arn, topic_arn: topic_arn]

subscribe_input :: [endpoint: endpoint_name, protocol: protocol, topic_arn: topic_arn]

confirm_subscription_input :: [authenticate_on_unsubscribe: authenticate_on_unsubscribe, token: token, topic_arn: topic_arn]

create_endpoint_response :: [{:endpoint_arn, binary}]

delegate :: binary

message_attribute_value :: [binary_value: binary, data_type: binary, string_value: binary]

publish_response :: [{:message_id, message_id}]

message :: binary

get_endpoint_attributes_input :: [{:endpoint_arn, binary}]

set_endpoint_attributes_input :: [attributes: map_string_to_string, endpoint_arn: binary]

create_platform_application_response :: [{:platform_application_arn, binary}]

list_endpoints_by_platform_application_input :: [next_token: binary, platform_application_arn: binary]

list_topics_input :: [{:next_token, next_token}]

label :: binary

unsubscribe_input :: [{:subscription_arn, subscription_arn}]

endpoint_name :: binary

create_platform_application_input :: [attributes: map_string_to_string, name: binary, platform: binary]

subscription_arn :: binary

create_platform_endpoint_input :: [attributes: map_string_to_string, custom_user_data: binary, platform_application_arn: binary, token: binary]

attribute_value :: binary

message_structure :: binary

delete_platform_application_input :: [{:platform_application_arn, binary}]

account :: binary

list_topics_response :: [next_token: next_token, topics: topics_list]

message_id :: binary

add_permission_input :: [aws_account_id: delegates_list, action_name: actions_list, label: label, topic_arn: topic_arn]

attribute_name :: binary

delete_endpoint_input :: [{:endpoint_arn, binary}]

topic_arn :: binary

topic_name :: binary

protocol :: binary

subject :: binary

authorization_error_exception :: [{:message, binary}]

list_subscriptions_input :: [{:next_token, next_token}]

platform_application_disabled_exception :: [{:message, binary}]

Functions

add_permission(client, input)

Specs:

  • add_permission(client :: ExAws.SNS.t, input :: add_permission_input) :: ExAws.Request.Query.response_t

AddPermission

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

Source
add_permission!(client, input)

Specs:

  • add_permission!(client :: ExAws.SNS.t, input :: add_permission_input) :: ExAws.Request.Query.success_t | no_return

Same as add_permission/2 but raise on error.

Source
confirm_subscription(client, input)

Specs:

ConfirmSubscription

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

Source
confirm_subscription!(client, input)

Specs:

Same as confirm_subscription/2 but raise on error.

Source
create_platform_application(client, input)

Specs:

CreatePlatformApplication

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is “SSL certificate”. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is “client id”. The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is “private key”. For GCM, PlatformCredential is “API key”. For ADM, PlatformCredential is “client secret”. The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications.

Source
create_platform_application!(client, input)

Specs:

Same as create_platform_application/2 but raise on error.

Source
create_platform_endpoint(client, input)

Specs:

CreatePlatformEndpoint

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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.

Source
create_platform_endpoint!(client, input)

Specs:

Same as create_platform_endpoint/2 but raise on error.

Source
create_topic(client, input)

Specs:

  • create_topic(client :: ExAws.SNS.t, input :: create_topic_input) :: ExAws.Request.Query.response_t

CreateTopic

Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://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.

Source
create_topic!(client, input)

Specs:

  • create_topic!(client :: ExAws.SNS.t, input :: create_topic_input) :: ExAws.Request.Query.success_t | no_return

Same as create_topic/2 but raise on error.

Source
delete_endpoint(client, input)

Specs:

  • delete_endpoint(client :: ExAws.SNS.t, input :: delete_endpoint_input) :: ExAws.Request.Query.response_t

DeleteEndpoint

Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

Source
delete_endpoint!(client, input)

Specs:

  • delete_endpoint!(client :: ExAws.SNS.t, input :: delete_endpoint_input) :: ExAws.Request.Query.success_t | no_return

Same as delete_endpoint/2 but raise on error.

Source
delete_platform_application(client, input)

Specs:

DeletePlatformApplication

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

Source
delete_platform_application!(client, input)

Specs:

Same as delete_platform_application/2 but raise on error.

Source
delete_topic(client, input)

Specs:

  • delete_topic(client :: ExAws.SNS.t, input :: delete_topic_input) :: ExAws.Request.Query.response_t

DeleteTopic

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.

Source
delete_topic!(client, input)

Specs:

  • delete_topic!(client :: ExAws.SNS.t, input :: delete_topic_input) :: ExAws.Request.Query.success_t | no_return

Same as delete_topic/2 but raise on error.

Source
get_endpoint_attributes(client, input)

Specs:

GetEndpointAttributes

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

Source
get_endpoint_attributes!(client, input)

Specs:

Same as get_endpoint_attributes/2 but raise on error.

Source
get_platform_application_attributes(client, input)

Specs:

GetPlatformApplicationAttributes

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

Source
get_platform_application_attributes!(client, input)

Specs:

Same as get_platform_application_attributes/2 but raise on error.

Source
get_subscription_attributes(client, input)

Specs:

GetSubscriptionAttributes

Returns all of the properties of a subscription.

Source
get_subscription_attributes!(client, input)

Specs:

Same as get_subscription_attributes/2 but raise on error.

Source
get_topic_attributes(client, input)

Specs:

GetTopicAttributes

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

Source
get_topic_attributes!(client, input)

Specs:

Same as get_topic_attributes/2 but raise on error.

Source
list_endpoints_by_platform_application(client, input)

Specs:

ListEndpointsByPlatformApplication

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM 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.

Source
list_endpoints_by_platform_application!(client, input)

Specs:

Same as list_endpoints_by_platform_application/2 but raise on error.

Source
list_platform_applications(client, input)

Specs:

ListPlatformApplications

Lists the platform application objects for the supported push notification services, such as APNS and GCM. 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.

Source
list_platform_applications!(client, input)

Specs:

Same as list_platform_applications/2 but raise on error.

Source
list_subscriptions(client, input)

Specs:

ListSubscriptions

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.

Source
list_subscriptions!(client, input)

Specs:

  • list_subscriptions!(client :: ExAws.SNS.t, input :: list_subscriptions_input) :: ExAws.Request.Query.success_t | no_return

Same as list_subscriptions/2 but raise on error.

Source
list_subscriptions_by_topic(client, input)

Specs:

ListSubscriptionsByTopic

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.

Source
list_subscriptions_by_topic!(client, input)

Specs:

Same as list_subscriptions_by_topic/2 but raise on error.

Source
list_topics(client, input)

Specs:

  • list_topics(client :: ExAws.SNS.t, input :: list_topics_input) :: ExAws.Request.Query.response_t

ListTopics

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.

Source
list_topics!(client, input)

Specs:

  • list_topics!(client :: ExAws.SNS.t, input :: list_topics_input) :: ExAws.Request.Query.success_t | no_return

Same as list_topics/2 but raise on error.

Source
publish(client, input)

Specs:

  • publish(client :: ExAws.SNS.t, input :: publish_input) :: ExAws.Request.Query.response_t

Publish

Sends a message to all of a topic’s subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic’s subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.

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. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.

Source
publish!(client, input)

Specs:

  • publish!(client :: ExAws.SNS.t, input :: publish_input) :: ExAws.Request.Query.success_t | no_return

Same as publish/2 but raise on error.

Source
remove_permission(client, input)

Specs:

RemovePermission

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

Source
remove_permission!(client, input)

Specs:

  • remove_permission!(client :: ExAws.SNS.t, input :: remove_permission_input) :: ExAws.Request.Query.success_t | no_return

Same as remove_permission/2 but raise on error.

Source
set_endpoint_attributes(client, input)

Specs:

SetEndpointAttributes

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

Source
set_endpoint_attributes!(client, input)

Specs:

Same as set_endpoint_attributes/2 but raise on error.

Source
set_platform_application_attributes(client, input)

Specs:

SetPlatformApplicationAttributes

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

Source
set_platform_application_attributes!(client, input)

Specs:

Same as set_platform_application_attributes/2 but raise on error.

Source
set_subscription_attributes(client, input)

Specs:

SetSubscriptionAttributes

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

Source
set_subscription_attributes!(client, input)

Specs:

Same as set_subscription_attributes/2 but raise on error.

Source
set_topic_attributes(client, input)

Specs:

SetTopicAttributes

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

Source
set_topic_attributes!(client, input)

Specs:

Same as set_topic_attributes/2 but raise on error.

Source
subscribe(client, input)

Specs:

  • subscribe(client :: ExAws.SNS.t, input :: subscribe_input) :: ExAws.Request.Query.response_t

Subscribe

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

Source
subscribe!(client, input)

Specs:

  • subscribe!(client :: ExAws.SNS.t, input :: subscribe_input) :: ExAws.Request.Query.success_t | no_return

Same as subscribe/2 but raise on error.

Source
unsubscribe(client, input)

Specs:

  • unsubscribe(client :: ExAws.SNS.t, input :: unsubscribe_input) :: ExAws.Request.Query.response_t

Unsubscribe

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.

Source
unsubscribe!(client, input)

Specs:

  • unsubscribe!(client :: ExAws.SNS.t, input :: unsubscribe_input) :: ExAws.Request.Query.success_t | no_return

Same as unsubscribe/2 but raise on error.

Source