ExAws v0.4.13 ExAws.SNS.Api
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.
Summary
Functions
AddPermission
Same as add_permission/2
but raise on error
ConfirmSubscription
Same as confirm_subscription/2
but raise on error
CreatePlatformApplication
Same as create_platform_application/2
but raise on error
CreatePlatformEndpoint
Same as create_platform_endpoint/2
but raise on error
CreateTopic
Same as create_topic/2
but raise on error
DeleteEndpoint
Same as delete_endpoint/2
but raise on error
DeletePlatformApplication
Same as delete_platform_application/2
but raise on error
DeleteTopic
Same as delete_topic/2
but raise on error
GetEndpointAttributes
Same as get_endpoint_attributes/2
but raise on error
GetPlatformApplicationAttributes
Same as get_platform_application_attributes/2
but raise on error
GetSubscriptionAttributes
Same as get_subscription_attributes/2
but raise on error
GetTopicAttributes
Same as get_topic_attributes/2
but raise on error
ListEndpointsByPlatformApplication
Same as list_endpoints_by_platform_application/2
but raise on error
ListPlatformApplications
Same as list_platform_applications/2
but raise on error
ListSubscriptions
Same as list_subscriptions/2
but raise on error
ListSubscriptionsByTopic
Same as list_subscriptions_by_topic/2
but raise on error
ListTopics
Same as list_topics/2
but raise on error
Publish
Same as publish/2
but raise on error
RemovePermission
Same as remove_permission/2
but raise on error
SetEndpointAttributes
Same as set_endpoint_attributes/2
but raise on error
SetPlatformApplicationAttributes
Same as set_platform_application_attributes/2
but raise on error
SetSubscriptionAttributes
Same as set_subscription_attributes/2
but raise on error
SetTopicAttributes
Same as set_topic_attributes/2
but raise on error
Subscribe
Same as subscribe/2
but raise on error
Unsubscribe
Same as unsubscribe/2
but raise on error
Types
account :: binary
action :: binary
actions_list :: [action]
add_permission_input :: [aws_account_id: delegates_list, action_name: actions_list, label: label, topic_arn: topic_arn]
attribute_name_value :: binary
attribute_value :: binary
authenticate_on_unsubscribe :: binary
confirm_subscription_input :: [authenticate_on_unsubscribe: authenticate_on_unsubscribe, token: token_value, topic_arn: topic_arn]
confirm_subscription_response :: [{:subscription_arn, subscription_arn}]
create_endpoint_response :: [{:endpoint_arn, binary}]
create_platform_application_input :: [attributes: map_string_to_string, name: binary, platform: binary]
create_platform_application_response :: [{:platform_application_arn, binary}]
create_platform_endpoint_input :: [attributes: map_string_to_string, custom_user_data: binary, platform_application_arn: binary, token: binary]
create_topic_input :: [{:name, topic_name}]
create_topic_response :: [{:topic_arn, topic_arn}]
delegate :: binary
delegates_list :: [delegate]
delete_endpoint_input :: [{:endpoint_arn, binary}]
delete_platform_application_input :: [{:platform_application_arn, binary}]
delete_topic_input :: [{:topic_arn, topic_arn}]
endpoint :: [attributes: map_string_to_string, endpoint_arn: binary]
endpoint_disabled_exception :: [{:message, binary}]
endpoint_value :: binary
get_endpoint_attributes_input :: [{:endpoint_arn, binary}]
get_endpoint_attributes_response :: [{:attributes, map_string_to_string}]
get_platform_application_attributes_input :: [{:platform_application_arn, binary}]
get_platform_application_attributes_response :: [{:attributes, map_string_to_string}]
get_subscription_attributes_input :: [{:subscription_arn, subscription_arn}]
get_subscription_attributes_response :: [{:attributes, subscription_attributes_map}]
get_topic_attributes_input :: [{:topic_arn, topic_arn}]
get_topic_attributes_response :: [{:attributes, topic_attributes_map}]
internal_error_exception :: [{:message, binary}]
invalid_parameter_exception :: [{:message, binary}]
invalid_parameter_value_exception :: [{:message, binary}]
label :: binary
list_endpoints_by_platform_application_input :: [next_token: binary, platform_application_arn: binary]
list_endpoints_by_platform_application_response :: [endpoints: list_of_endpoints, next_token: binary]
list_platform_applications_input :: [{:next_token, binary}]
list_platform_applications_response :: [next_token: binary, platform_applications: list_of_platform_applications]
list_subscriptions_by_topic_input :: [next_token: next_token, topic_arn: topic_arn]
list_subscriptions_by_topic_response :: [next_token: next_token, subscriptions: subscriptions_list]
list_subscriptions_input :: [{:next_token, next_token}]
list_subscriptions_response :: [next_token: next_token, subscriptions: subscriptions_list]
list_topics_input :: [{:next_token, next_token}]
list_topics_response :: [next_token: next_token, topics: topics_list]
map_string_to_string :: [{binary, binary}]
message_attribute_map :: [{binary, message_attribute_value}]
message_attribute_value :: [binary_value: binary, data_type: binary, string_value: binary]
message_id_value :: binary
message_structure :: binary
message_value :: binary
next_token :: binary
not_found_exception :: [{:message, binary}]
platform_application :: [attributes: map_string_to_string, platform_application_arn: binary]
platform_application_disabled_exception :: [{:message, binary}]
protocol_value :: binary
publish_input :: [message: message_value, message_attributes: message_attribute_map, message_structure: message_structure, subject: subject_value, target_arn: binary, topic_arn: topic_arn]
publish_response :: [{:message_id, message_id_value}]
remove_permission_input :: [label: label, topic_arn: topic_arn]
set_endpoint_attributes_input :: [attributes: map_string_to_string, endpoint_arn: binary]
set_platform_application_attributes_input :: [attributes: map_string_to_string, platform_application_arn: binary]
set_subscription_attributes_input :: [attribute_name: attribute_name_value, attribute_value: attribute_value, subscription_arn: subscription_arn]
set_topic_attributes_input :: [attribute_name: attribute_name_value, attribute_value: attribute_value, topic_arn: topic_arn]
subject_value :: binary
subscribe_input :: [endpoint: endpoint_value, protocol: protocol_value, topic_arn: topic_arn]
subscribe_response :: [{:subscription_arn, subscription_arn}]
subscription :: [endpoint: endpoint_value, owner: account, protocol: protocol_value, subscription_arn: subscription_arn, topic_arn: topic_arn]
subscription_arn :: binary
subscription_limit_exceeded_exception :: [{:message, binary}]
token_value :: binary
topic_arn :: binary
topic_limit_exceeded_exception :: [{:message, binary}]
topic_name :: binary
topics_list :: [topic]
unsubscribe_input :: [{:subscription_arn, subscription_arn}]
Functions
Specs
add_permission(config :: ExAws.Config.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.
Specs
add_permission!(config :: ExAws.Config.t, input :: add_permission_input) ::
ExAws.Request.Query.success_t |
no_return
Same as add_permission/2
but raise on error.
Specs
confirm_subscription(config :: ExAws.Config.t, input :: confirm_subscription_input) :: ExAws.Request.Query.response_t
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
:authenticate_on_unsubscribe_value
flag is set to “true”.
Specs
confirm_subscription!(config :: ExAws.Config.t, input :: confirm_subscription_input) ::
ExAws.Request.Query.success_t |
no_return
Same as confirm_subscription/2
but raise on error.
Specs
create_platform_application(config :: ExAws.Config.t, input :: create_platform_application_input) :: ExAws.Request.Query.response_t
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 :create_platform_application
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
:create_platform_application
is then used as an attribute for the
:create_platform_endpoint
action. For more information, see Using Amazon
SNS Mobile Push
Notifications.
Specs
create_platform_application!(config :: ExAws.Config.t, input :: create_platform_application_input) ::
ExAws.Request.Query.success_t |
no_return
Same as create_platform_application/2
but raise on error.
Specs
create_platform_endpoint(config :: ExAws.Config.t, input :: create_platform_endpoint_input) :: ExAws.Request.Query.response_t
CreatePlatformEndpoint
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM and APNS. :create_platform_endpoint
requires the PlatformApplicationArn that is returned from
:create_platform_application
. The EndpointArn that is returned when using
:create_platform_endpoint
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 :create_platform_endpoint
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 :create_platform_endpoint
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.
Specs
create_platform_endpoint!(config :: ExAws.Config.t, input :: create_platform_endpoint_input) ::
ExAws.Request.Query.success_t |
no_return
Same as create_platform_endpoint/2
but raise on error.
Specs
create_topic(config :: ExAws.Config.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.
Specs
create_topic!(config :: ExAws.Config.t, input :: create_topic_input) ::
ExAws.Request.Query.success_t |
no_return
Same as create_topic/2
but raise on error.
Specs
delete_endpoint(config :: ExAws.Config.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.
Specs
delete_endpoint!(config :: ExAws.Config.t, input :: delete_endpoint_input) ::
ExAws.Request.Query.success_t |
no_return
Same as delete_endpoint/2
but raise on error.
Specs
delete_platform_application(config :: ExAws.Config.t, input :: delete_platform_application_input) :: ExAws.Request.Query.response_t
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.
Specs
delete_platform_application!(config :: ExAws.Config.t, input :: delete_platform_application_input) ::
ExAws.Request.Query.success_t |
no_return
Same as delete_platform_application/2
but raise on error.
Specs
delete_topic(config :: ExAws.Config.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.
Specs
delete_topic!(config :: ExAws.Config.t, input :: delete_topic_input) ::
ExAws.Request.Query.success_t |
no_return
Same as delete_topic/2
but raise on error.
Specs
get_endpoint_attributes(config :: ExAws.Config.t, input :: get_endpoint_attributes_input) :: ExAws.Request.Query.response_t
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.
Specs
get_endpoint_attributes!(config :: ExAws.Config.t, input :: get_endpoint_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as get_endpoint_attributes/2
but raise on error.
Specs
get_platform_application_attributes(config :: ExAws.Config.t, input :: get_platform_application_attributes_input) :: ExAws.Request.Query.response_t
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.
Specs
get_platform_application_attributes!(config :: ExAws.Config.t, input :: get_platform_application_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as get_platform_application_attributes/2
but raise on error.
Specs
get_subscription_attributes(config :: ExAws.Config.t, input :: get_subscription_attributes_input) :: ExAws.Request.Query.response_t
GetSubscriptionAttributes
Returns all of the properties of a subscription.
Specs
get_subscription_attributes!(config :: ExAws.Config.t, input :: get_subscription_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as get_subscription_attributes/2
but raise on error.
Specs
get_topic_attributes(config :: ExAws.Config.t, input :: get_topic_attributes_input) :: ExAws.Request.Query.response_t
GetTopicAttributes
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
Specs
get_topic_attributes!(config :: ExAws.Config.t, input :: get_topic_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as get_topic_attributes/2
but raise on error.
Specs
list_endpoints_by_platform_application(config :: ExAws.Config.t, input :: list_endpoints_by_platform_application_input) :: ExAws.Request.Query.response_t
ListEndpointsByPlatformApplication
Lists the endpoints and endpoint attributes for devices in a supported push
notification service, such as GCM and APNS. The results for
:list_endpoints_by_platform_application
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 :list_endpoints_by_platform_application
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.
Specs
list_endpoints_by_platform_application!(config :: ExAws.Config.t, input :: list_endpoints_by_platform_application_input) ::
ExAws.Request.Query.success_t |
no_return
Same as list_endpoints_by_platform_application/2
but raise on error.
Specs
list_platform_applications(config :: ExAws.Config.t, input :: list_platform_applications_input) :: ExAws.Request.Query.response_t
ListPlatformApplications
Lists the platform application objects for the supported push notification
services, such as APNS and GCM. The results for :list_platform_applications
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
:list_platform_applications
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.
Specs
list_platform_applications!(config :: ExAws.Config.t, input :: list_platform_applications_input) ::
ExAws.Request.Query.success_t |
no_return
Same as list_platform_applications/2
but raise on error.
Specs
list_subscriptions(config :: ExAws.Config.t, input :: list_subscriptions_input) :: ExAws.Request.Query.response_t
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 :next_token_value
is also returned. Use the :next_token_value
parameter in a new
:list_subscriptions
call to get further results.
Specs
list_subscriptions!(config :: ExAws.Config.t, input :: list_subscriptions_input) ::
ExAws.Request.Query.success_t |
no_return
Same as list_subscriptions/2
but raise on error.
Specs
list_subscriptions_by_topic(config :: ExAws.Config.t, input :: list_subscriptions_by_topic_input) :: ExAws.Request.Query.response_t
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 :next_token_value
is also returned. Use the :next_token_value
parameter in a new :list_subscriptions_by_topic
call to get further results.
Specs
list_subscriptions_by_topic!(config :: ExAws.Config.t, input :: list_subscriptions_by_topic_input) ::
ExAws.Request.Query.success_t |
no_return
Same as list_subscriptions_by_topic/2
but raise on error.
Specs
list_topics(config :: ExAws.Config.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 :next_token_value
is also
returned. Use the :next_token_value
parameter in a new :list_topics
call to get
further results.
Specs
list_topics!(config :: ExAws.Config.t, input :: list_topics_input) ::
ExAws.Request.Query.success_t |
no_return
Same as list_topics/2
but raise on error.
Specs
publish(config :: ExAws.Config.t, input :: publish_input) :: ExAws.Request.Query.response_t
Publish
Sends a message to all of a topic’s subscribed endpoints. When a
:message_id_value
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
:create_platform_endpoint
action. The second example below shows a request
and response for publishing to a mobile endpoint.
Specs
publish!(config :: ExAws.Config.t, input :: publish_input) ::
ExAws.Request.Query.success_t |
no_return
Same as publish/2
but raise on error.
Specs
remove_permission(config :: ExAws.Config.t, input :: remove_permission_input) :: ExAws.Request.Query.response_t
RemovePermission
Removes a statement from a topic’s access control policy.
Specs
remove_permission!(config :: ExAws.Config.t, input :: remove_permission_input) ::
ExAws.Request.Query.success_t |
no_return
Same as remove_permission/2
but raise on error.
Specs
set_endpoint_attributes(config :: ExAws.Config.t, input :: set_endpoint_attributes_input) :: ExAws.Request.Query.response_t
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.
Specs
set_endpoint_attributes!(config :: ExAws.Config.t, input :: set_endpoint_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as set_endpoint_attributes/2
but raise on error.
Specs
set_platform_application_attributes(config :: ExAws.Config.t, input :: set_platform_application_attributes_input) :: ExAws.Request.Query.response_t
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.
Specs
set_platform_application_attributes!(config :: ExAws.Config.t, input :: set_platform_application_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as set_platform_application_attributes/2
but raise on error.
Specs
set_subscription_attributes(config :: ExAws.Config.t, input :: set_subscription_attributes_input) :: ExAws.Request.Query.response_t
SetSubscriptionAttributes
Allows a subscription owner to set an attribute of the topic to a new value.
Specs
set_subscription_attributes!(config :: ExAws.Config.t, input :: set_subscription_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as set_subscription_attributes/2
but raise on error.
Specs
set_topic_attributes(config :: ExAws.Config.t, input :: set_topic_attributes_input) :: ExAws.Request.Query.response_t
SetTopicAttributes
Allows a topic owner to set an attribute of the topic to a new value.
Specs
set_topic_attributes!(config :: ExAws.Config.t, input :: set_topic_attributes_input) ::
ExAws.Request.Query.success_t |
no_return
Same as set_topic_attributes/2
but raise on error.
Specs
subscribe(config :: ExAws.Config.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 :confirm_subscription
action with the token from the confirmation
message. Confirmation tokens are valid for three days.
Specs
subscribe!(config :: ExAws.Config.t, input :: subscribe_input) ::
ExAws.Request.Query.success_t |
no_return
Same as subscribe/2
but raise on error.
Specs
unsubscribe(config :: ExAws.Config.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.
Specs
unsubscribe!(config :: ExAws.Config.t, input :: unsubscribe_input) ::
ExAws.Request.Query.success_t |
no_return
Same as unsubscribe/2
but raise on error.