ExAws.
View Source
Operations on AWS Simple Notification Service (SNS).
See http://docs.aws.amazon.com/sns/latest/api/API_Operations.html for details.
Summary
Functions
Check if phone number is opted out.
Confirm Subscription.
Create plaform application.
Create platform endpoint.
Create topic.
Delete endpoint.
Delete platform application.
Delete topic.
Get endpoint attributes.
Get platform application attributes.
Get subscription attributes.
Get topic attributes.
List endpoints and endpoint attributes for devices in a supported push notification service.
List phone numbers opted out.
List platform applications.
List Subscriptions.
List Subscriptions by Topic.
List topics
Opt in phone number.
Publish message to a target/topic ARN.
Set endpoint attributes.
Set subscription attributes.
Set topic attributes.
Create Subscription.
Unsubscribe.
Verify message signature.
Types
@type endpoint_arn() :: binary()
@type list_endpoints_by_platform_application_opt() :: {:next_token, binary()}
@type list_subscriptions_by_topic_opt() :: {:next_token, binary()}
@type platform_application_arn() :: binary()
@type publish_batch_request_entry() :: %{ :id => binary(), :message => binary(), optional(:message_attributes) => [message_attribute()], optional(:message_deduplication_id) => binary(), optional(:message_group_id) => binary(), optional(:message_structure) => binary(), optional(:subject) => binary() }
@type subscribe_opt() :: {:return_subscription_arn, boolean()}
@type subscription_attribute_name() ::
:delivery_policy | :filter_policy | :raw_message_delivery
@type topic_arn() :: binary()
@type topic_attribute_name() :: :policy | :display_name | :delivery_policy
@type topic_name() :: binary()
Functions
@spec check_if_phone_number_is_opted_out(phone_number :: binary()) :: ExAws.Operation.Query.t()
Check if phone number is opted out.
@spec confirm_subscription( topic_arn :: binary(), token :: binary(), authenticate_on_unsubscribe :: boolean() ) :: ExAws.Operation.Query.t()
Confirm Subscription.
@spec create_platform_application( name :: binary(), platform :: binary(), attributes :: %{required(String.t()) => String.t()} ) :: ExAws.Operation.Query.t()
Create plaform application.
@spec create_platform_endpoint( platform_application_arn :: platform_application_arn(), token :: binary(), custom_user_data :: binary() | nil ) :: ExAws.Operation.Query.t()
Create platform endpoint.
@spec create_topic(topic_name :: topic_name(), attributes :: topic_attributes()) :: ExAws.Operation.Query.t()
Create topic.
@spec delete_endpoint(endpoint_arn :: endpoint_arn()) :: ExAws.Operation.Query.t()
Delete endpoint.
@spec delete_platform_application( platform_application_arn :: platform_application_arn() ) :: ExAws.Operation.Query.t()
Delete platform application.
@spec delete_topic(topic_arn :: topic_arn()) :: ExAws.Operation.Query.t()
Delete topic.
@spec get_endpoint_attributes(endpoint_arn :: endpoint_arn()) :: ExAws.Operation.Query.t()
Get endpoint attributes.
@spec get_platform_application_attributes( platform_application_arn :: platform_application_arn() ) :: ExAws.Operation.Query.t()
Get platform application attributes.
@spec get_subscription_attributes(subscription_arn :: binary()) :: ExAws.Operation.Query.t()
Get subscription attributes.
@spec get_topic_attributes(topic_arn :: topic_arn()) :: ExAws.Operation.Query.t()
Get topic attributes.
@spec list_endpoints_by_platform_application(topic_arn :: topic_arn(), [ list_endpoints_by_platform_application_opt() ]) :: ExAws.Operation.Query.t()
List endpoints and endpoint attributes for devices in a supported push notification service.
@spec list_phone_numbers_opted_out() :: ExAws.Operation.Query.t()
List phone numbers opted out.
@spec list_phone_numbers_opted_out(next_token :: binary()) :: ExAws.Operation.Query.t()
@spec list_platform_applications() :: ExAws.Operation.Query.t()
List platform applications.
@spec list_platform_applications(next_token :: binary()) :: ExAws.Operation.Query.t()
@spec list_subscriptions() :: ExAws.Operation.Query.t()
List Subscriptions.
@spec list_subscriptions(next_token :: binary()) :: ExAws.Operation.Query.t()
@spec list_subscriptions_by_topic(topic_arn :: topic_arn(), [ list_subscriptions_by_topic_opt() ]) :: ExAws.Operation.Query.t()
List Subscriptions by Topic.
@spec list_topics(opts :: [{:next_token, binary()}]) :: ExAws.Operation.Query.t()
List topics
@spec opt_in_phone_number(phone_number :: binary()) :: ExAws.Operation.Query.t()
Opt in phone number.
@spec publish(message :: binary(), opts :: publish_opts()) :: ExAws.Operation.Query.t()
Publish message to a target/topic ARN.
You must set either :phone_number, :target_arn or :topic_arn but only one,
via the options argument.
Do NOT assume that because your message is a JSON blob that you should set
:message_structure to :json. This has a very specific meaning, see
http://docs.aws.amazon.com/sns/latest/api/API_Publish.html for details.
@spec publish_batch( publish_batch_requests :: [publish_batch_request_entry(), ...], topic_arn :: topic_arn() ) :: ExAws.Operation.Query.t()
@spec set_endpoint_attributes( endpoint_arn :: endpoint_arn(), attributes :: endpoint_attributes() ) :: ExAws.Operation.Query.t()
Set endpoint attributes.
@spec set_subscription_attributes( attribute_name :: subscription_attribute_name(), attribute_value :: binary(), subscription_arn :: binary() ) :: ExAws.Operation.Query.t()
Set subscription attributes.
@spec set_topic_attributes( attribute_name :: topic_attribute_name(), attribute_value :: binary(), topic_arn :: topic_arn() ) :: ExAws.Operation.Query.t()
Set topic attributes.
@spec subscribe(topic_arn :: binary(), protocol :: binary(), endpoint :: binary(), [ subscribe_opt() ]) :: ExAws.Operation.Query.t()
Create Subscription.
@spec unsubscribe(subscription_arn :: binary()) :: ExAws.Operation.Query.t()
Unsubscribe.
@spec verify_message(message_params :: %{required(String.t()) => String.t()}) :: :ok | {:error, String.t()}
Verify message signature.